Struct embedded_canvas::Canvas

pub struct Canvas<C: PixelColor> {
    pub canvas: Size,
    pub pixels: Box<[Option<C>]>,
}

Available on crate feature alloc only.

Canvas on which you can draw but it’s not drawable on the display yet.

Draw on the Canvas using origin of Point::zero().

Fields

canvas: Size

The size of the Canvas.

pixels: Box<[Option<C>]>

The pixels of the Canvas.

Implementations

impl<C: PixelColor> Canvas<C>

pub fn new(canvas: Size) -> Self

Create a new blank Canvas.

Panics

Panics when width * height > usize::MAX.

pub fn with_default_color(canvas: Size, default_color: C) -> Self

Create a Canvas filled with a default color.

Panics

Panics when width * height > usize::MAX.

pub fn center(&self) -> Point

Returns the center of Size of the Canvas.

pub fn crop(&self, area: &Rectangle) -> Option<Canvas<C>>

Create a new cropped Canvas.

This method takes into account the top left Point of the area you’d like to crop relative to the Canvas itself. If the width or height of the Rectangle is 0, this method will return None (see Rectangle::bottom_right())

pub fn place_at(&self, top_left: Point) -> CanvasAt<C>

Sets the place with top left offset where the canvas will be drawn to the display.

pub fn place_center(&self, center: Point) -> CanvasAt<C>

Sets the center of the Canvas where it will be drawn to the display.

Trait Implementations

impl<C: PixelColor> DrawTarget for Canvas<C>

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color ) -> Result<(), Self::Error>

Fill a given area with a solid color.

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

Fill the entire display with a solid color.

impl<C: PixelColor> OriginDimensions for Canvas<C>

fn size(&self) -> Size

Returns the size of the bounding box.