Struct g2d::Canvas

pub struct Canvas<'a, H: Handle> { /* private fields */ }

A view into a Texture used for reading or writing to it.

Implementations

impl<'a, H: Handle> Canvas<'a, H>

pub fn from_raw_parts(handle: &'a H, wgpu_texture: &'a Texture) -> Self

Creates an Canvas from its raw parts.

NOTE: the provided wgpu::Texture should have been created from the provided Handle.

pub fn write(&self, data: &[u8]) -> Result<(), Error>

Writes data directly to a Texture.

Fails

• Fails if the underlying data is too big or small.
• Fails if the Texture doesn’t have the COPY_DST usage.

pub async fn pixels(&self) -> Result<Pixels, Error>

Attempts to get the pixels of this Texture.

Fails

• Fails if the texture doesn’t have the COPY_SRC usage.

pub fn clear(&self, color: Color) -> Result<(), Error>

Clears this Texture, filling it with the provided color.

Fails

• Fails if this Texture does not have the RENDER_ATTACHMENT usage.

Trait Implementations

impl<'a, H: Debug + Handle> Debug for Canvas<'a, H>

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

Formats the value using the given formatter.

impl<'a, H: Handle> Texture<H> for Canvas<'a, H>

fn handle(&self) -> &H

Returns the Handle used to create this Texture.

fn wgpu_texture(&self) -> &Texture

Returns the wgpu::Texture that this Texture wraps.

fn wgpu_texture_usage(&self) -> TextureUsages

Returns the usages of this Texture allowed for the GPU. Any operations on this Texture not contained in this set will fail.

fn size(&self) -> Dimension

Returns the size of this Texture, in pixels.

fn canvas(&self) -> Canvas<'_, H>

Creates a Canvas for drawing to this Texture.