Struct embedded_canvas::CanvasAt

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

Canvas which is drawable at the provided Point (location) on the display.

Fields

top_left: Point

The top left offset where the CanvasAt will be drawn to the display.

canvas: Size

The size of the CanvasAt.

pixels: Box<[Option<C>]>

The pixels of the CanvasAt.

Implementations

impl<C: PixelColor> CanvasAt<C>

pub fn new(top_left: Point, canvas: Size) -> Self

Create a new blank CanvasAt.

Panics

Panics when width * height > usize::MAX.

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

Create a CanvasAt filled with a default color.

Panics

Panics when width * height > usize::MAX.

pub fn with_center(center: Point, canvas: Size) -> Self

Create a new blank CanvasAt with a set center on the display.

pub fn center(&self) -> Point

Returns the center of the bounding box.

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 CanvasAt.

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

Create a new cropped CanvasAt.

This method takes into account the top left Point of the area you’d like to crop relative to the display.

If the width or height of the Rectangle is 0, this method will return None (see Rectangle::bottom_right())

Trait Implementations

impl<C: Clone + PixelColor> Clone for CanvasAt<C>

fn clone(&self) -> CanvasAt<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + PixelColor> Debug for CanvasAt<C>

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

Formats the value using the given formatter.

impl<C: PixelColor> Dimensions for CanvasAt<C>

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl<C: PixelColor> DrawTarget for CanvasAt<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> Drawable for CanvasAt<C> where
    C: PixelColor, 

type Color = C

The pixel color type.

type Output = ()

The return type of the draw method.

fn draw<D>(&self, target: &mut D) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>, 

Draw the graphics object using the supplied DrawTarget.

impl<C: PixelColor> Transform for CanvasAt<C>

Available on crate feature transform only.

fn translate(&self, by: Point) -> Self

Move the origin of an object by a given number of (x, y) pixels, returning a new object

fn translate_mut(&mut self, by: Point) -> &mut Self

Move the origin of an object by a given number of (x, y) pixels, mutating the object in place