Struct ggez::graphics::CanvasGeneric

pub struct CanvasGeneric<Spec> where
    Spec: BackendSpec,  { /* fields omitted */ }

A generic canvas independent of graphics backend. This type should never need to be used directly; use graphics::Canvas instead.

Implementations

impl<S> CanvasGeneric<S> where
    S: BackendSpec, 

pub fn new(
    ctx: &mut Context,
    width: u16,
    height: u16,
    samples: NumSamples,
    color_format: Format
) -> GameResult<Canvas>

Create a new Canvas with the given size and number of samples.

WARNING: `Canvases with samples != NumSamples::One are currently broken, see https://github.com/ggez/ggez/issues/695

pub fn with_window_size(ctx: &mut Context) -> GameResult<Canvas>

Create a new Canvas with the current window dimensions.

pub fn raw_image(&self) -> &Image

Gets the backend Image that is being rendered to. Note that this will be flipped but otherwise the same, use the to_image function for the unflipped version.

pub fn to_image(&self, ctx: &mut Context) -> GameResult<Image>

Creates an Image with the content of its raw counterpart but transformed to behave like a normal Image.

pub fn target(&self) -> &RawRenderTargetView<S::Resources>

Gets the backend Target that is being rendered to.

pub fn to_rgba8(&self, ctx: &mut Context) -> GameResult<Vec<u8>>

Dumps the flipped Canvas’s data to a Vec of u8 RBGA8 values.

pub fn encode<P: AsRef<Path>>(
    &self,
    ctx: &mut Context,
    format: ImageFormat,
    path: P
) -> GameResult

Encode the Canvas’s content to the given file format and write it out to the given path.

See the filesystem module docs for where exactly the file will end up.

pub fn width(&self) -> u16

Return the width of the canvas.

pub fn height(&self) -> u16

Return the height of the canvas.

pub fn dimensions(&self) -> Rect

Returns the dimensions of the canvas.

pub fn filter(&self) -> FilterMode

Get the filter mode for the canvas.

pub fn set_filter(&mut self, mode: FilterMode)

Set the filter mode for the canvas.

Trait Implementations

impl<Spec: Debug> Debug for CanvasGeneric<Spec> where
    Spec: BackendSpec,
    Spec::Resources: Debug, 

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

Formats the value using the given formatter.