Struct tetra::graphics::Canvas

pub struct Canvas { /* fields omitted */ }

A 2D texture that can be used for off-screen rendering.

This is sometimes referred to as a 'render texture' or 'render target' in other frameworks.

Canvases can be useful if you want to do some rendering upfront and then cache the result (e.g. a static background), or if you want to apply transformations/shaders to multiple things simultaneously.

Methods

impl Canvas

pub fn new(ctx: &mut Context, width: i32, height: i32) -> Canvas

Creates a new canvas.

pub fn width(&self) -> i32

Returns the width of the canvas.

pub fn height(&self) -> i32

Returns the height of the canvas.

pub fn texture(&self) -> &Texture

Returns the canvas' underlying texture.

Trait Implementations

impl Drawable for Canvas

fn draw<P>(&self, ctx: &mut Context, params: P) where
    P: Into<DrawParams>, 

Draws self to the screen (or a canvas, if one is enabled), using the specified parameters.

impl PartialEq<Canvas> for Canvas

fn eq(&self, other: &Canvas) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Canvas) -> bool

This method tests for !=.

impl Clone for Canvas

fn clone(&self) -> Canvas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Canvas

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

Formats the value using the given formatter.