Struct embedded_canvas::CCanvas

pub struct CCanvas<C: PixelColor, const W: usize, const H: usize> {
    pub size: Size,
    pub pixels: [[Option<C>; H]; W],
}

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

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

The width (W) and height (H) constants of the CCanvas should less than u32::MAX as Size uses u32.

Fields

size: Size

pixels: [[Option<C>; H]; W]

Implementations

impl<C, const W: usize, const H: usize> CCanvas<C, W, H>

where C: PixelColor,

pub fn new() -> Self

Create a new blank CCanvas.

Panics

If either the width (W) or heigh (H) is larger than u32::MAX due to the internal Size used for implementing OriginDimensions.

pub fn with_default_color(default_color: C) -> Self

Create a CCanvas filled with a default color.

Panics

If either the width (W) or heigh (H) is larger than u32::MAX due to the internal Size used for implementing OriginDimensions.

pub fn get_pixel(&self, point: Point) -> Option<C>

Returns the color of the pixel at a given Point.

Returns None if the Point is outside of the CCanvas.

pub fn center(&self) -> Point

Returns the center of Size of the CCanvas.

pub fn crop<const NW: usize, const NH: usize>( &self, area: &Rectangle ) -> Option<CCanvas<C, NW, NH>>

Create a new cropped CCanvas.

This method takes into account the top left Point of the area you’d like to crop relative to the CCanvas 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) -> CCanvasAt<C, W, H>

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

pub fn place_center(&self, center: Point) -> CCanvasAt<C, W, H>

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

Trait Implementations

impl<C, const W: usize, const H: usize> Default for CCanvas<C, W, H>

where C: PixelColor,

fn default() -> Self

Returns the “default value” for a type.

impl<C: PixelColor, const W: usize, const H: usize> DrawTarget for CCanvas<C, W, H>

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, const W: usize, const H: usize> OriginDimensions for CCanvas<C, W, H>

fn size(&self) -> Size

Returns the size of the bounding box.