Struct embedded_graphics_simulator::SimulatorDisplay

pub struct SimulatorDisplay<C> { /* fields omitted */ }

Simulator display.

Methods

impl<C> SimulatorDisplay<C> where
    C: PixelColor, 

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

Creates a new display filled with a color.

This constructor can be used if C doesn't implement From<BinaryColor> or another default color is wanted.

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

Returns the color of the pixel at a point.

Panics

Panics if point is outside the display.

impl<C> SimulatorDisplay<C> where
    C: PixelColor + From<BinaryColor>, 

pub fn new(size: Size) -> Self

Creates a new display.

The display is filled with C::from(BinaryColor::Off).

impl<C> SimulatorDisplay<C> where
    C: PixelColor + Into<Rgb888>, 

pub fn to_image_buffer(
    &self,
    output_settings: &OutputSettings
) -> ImageBuffer<Rgb<u8>, Box<[u8]>>

Converts the display contents into an image.rs ImageBuffer.

Examples

use embedded_graphics::{prelude::*, pixelcolor::Rgb888};
use embedded_graphics_simulator::{OutputSettingsBuilder, SimulatorDisplay};

let output_settings = OutputSettingsBuilder::new().scale(2).build();

let display: SimulatorDisplay<Rgb888> = SimulatorDisplay::new(Size::new(128, 64));

// draw something to the display

let image_buffer = display.to_image_buffer(&output_settings);
assert_eq!(image_buffer.width(), 256);
assert_eq!(image_buffer.height(), 128);

// use image buffer
// example: image_buffer.save

Trait Implementations

impl<C> DrawTarget<C> for SimulatorDisplay<C> where
    C: PixelColor, 

type Error = Infallible

Error type to return when a drawing operation fails.

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

Draws a pixel on the display.

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_line(
    &mut self,
    item: &Styled<Line, PrimitiveStyle<C>>
) -> Result<(), Self::Error>

Draws a styled line primitive.

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

Draws a styled triangle primitive.

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

Draws a styled rectangle primitive.

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

Draws a styled circle primitive.

fn draw_image<'b, I>(
    &mut self,
    item: &'a Image<'b, I, C>
) -> Result<(), Self::Error> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    I: ImageDimensions,
    &'b I: IntoPixelIter<C>, 

Draws an image with known size