Struct canvas_display::CanvasDisplay

pub struct CanvasDisplay { /* fields omitted */ }

This display is based on a HTML Canvas and is used as draw target for the embedded graphics crate.

Example

use canvas_display::prelude::*;
use embedded_graphics::{
    image::{Image, ImageRaw, ImageRawLE},
    pixelcolor::Rgb565,
    prelude::*,
    primitives::rectangle::Rectangle,
    style::PrimitiveStyleBuilder,
    };

let mut display = CanvasDisplay::new(160, 128, "canvas").unwrap();

let style = PrimitiveStyleBuilder::new().fill_color(Rgb565::BLACK).build();
let black_backdrop = Rectangle::new(Point::new(0, 0), Point::new(160, 128)).into_styled(style);
black_backdrop.draw(&mut display).unwrap();

// draw ferris
let image_raw: ImageRawLE<Rgb565> = ImageRaw::new(include_bytes!("../../../assets/ferris.raw"), 86, 64);
let image: Image<_, Rgb565> = Image::new(&image_raw, Point::new(34, 8));
image.draw(&mut display).unwrap();

Implementations

impl CanvasDisplay

pub fn new(width: u32, height: u32, canvas: &str) -> Result<Self, String>

Creates a new canvas display with the given. The canvas get the given with and height and will be referenced by the given canvas css id. If no canvas with this id exists a canvas will be created.

pub fn context(&self) -> &CanvasRenderingContext2d

Gets the current rendering context 2d.

Trait Implementations

impl Clone for CanvasDisplay

fn clone(&self) -> CanvasDisplay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasDisplay

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

Formats the value using the given formatter.

impl DrawTarget<Rgb565> for CanvasDisplay

type Error = String

Error type to return when a drawing operation fails.

fn draw_pixel(&mut self, pixel: Pixel<Rgb565>) -> Result<(), Self::Error>

Draws a pixel on the display.

fn draw_line(
    &mut self,
    item: &Styled<Line, PrimitiveStyle<Rgb565>>
) -> Result<(), Self::Error>

Draws a styled line primitive.

fn draw_rectangle(
    &mut self,
    item: &Styled<Rectangle, PrimitiveStyle<Rgb565>>
) -> Result<(), Self::Error>

Draws a styled rectangle primitive.

fn draw_circle(
    &mut self,
    item: &Styled<Circle, PrimitiveStyle<Rgb565>>
) -> Result<(), Self::Error>

Draws a styled circle primitive.

fn draw_image<'a, 'b, I>(
    &mut self,
    item: &'a Image<'b, I, Rgb565>
) -> Result<(), Self::Error> where
    &'b I: IntoPixelIter<Rgb565>,
    I: ImageDimensions, 

Draws an image with known size

fn size(&self) -> Size

Returns the dimensions of the DrawTarget in pixels.

fn draw_iter<T>(&mut self, item: T) -> Result<(), Self::Error> where
    T: IntoIterator<Item = Pixel<C>>, 

Draws an object from an iterator over its pixels.

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

Clears the display with the supplied color.

fn draw_triangle(
    &mut self,
    item: &Styled<Triangle, PrimitiveStyle<C>>
) -> Result<(), Self::Error>

Draws a styled triangle primitive.

impl PartialEq<CanvasDisplay> for CanvasDisplay

fn eq(&self, other: &CanvasDisplay) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CanvasDisplay) -> bool

This method tests for !=.

impl StructuralPartialEq for CanvasDisplay