Struct tetra::graphics::CanvasBuilder

pub struct CanvasBuilder { /* private fields */ }

A builder for creating advanced canvas configurations.

By default, Tetra’s canvases are fairly simple - they just provide a Texture that you can render things to. However, they can also be configured with extra features via this builder, such as multisampling and additional buffers.

Implementations

impl CanvasBuilder

pub fn new(width: i32, height: i32) -> CanvasBuilder

Creates a new canvas builder.

You can also use Canvas::builder as a shortcut for this, if you want to avoid the extra import.

pub fn texture_format(&mut self, format: TextureFormat) -> &mut CanvasBuilder

Sets the format that should be used for the canvas’ underlying Texture.

Defaults to TextureFormat::Rgba8.

pub fn samples(&mut self, samples: u8) -> &mut CanvasBuilder

Sets the level of multisample anti-aliasing to use.

The number of samples that can be used varies between graphics cards - 2, 4 and 8 are reasonably well supported. When set to 0 (the default), no multisampling will be used.

Resolving

In order to actually display a multisampled canvas, it first has to be downsampled (or ‘resolved’). This is done automatically once you switch to a different canvas/the backbuffer. Until this step takes place, your rendering will not be reflected in the canvas’ underlying texture (and by extension, in the output of draw and get_data).

pub fn stencil_buffer(&mut self, enabled: bool) -> &mut CanvasBuilder

Sets whether the canvas should have a stencil buffer.

Setting this to true allows you to use stencils while rendering to the canvas, at the cost of some extra video RAM usage.

pub fn build(&self, ctx: &mut Context) -> Result<Canvas>

Builds the canvas.

Errors

• TetraError::PlatformError will be returned if the underlying graphics API encounters an error.

Trait Implementations

impl Clone for CanvasBuilder

fn clone(&self) -> CanvasBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanvasBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.