Struct embedded_graphics_simulator::SimulatorDisplay

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

Simulator display.

Implementations

impl<C: PixelColor> SimulatorDisplay<C>

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_rgb_output_image(
    &self,
    output_settings: &OutputSettings
) -> OutputImage<Rgb888>

Converts the display contents into a RGB output image.

Examples

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

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

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

// draw something to the display

let output_image = display.to_rgb_output_image(&output_settings);
assert_eq!(output_image.size(), Size::new(256, 128));

// use output image:
// example: output_image.save_png("out.png")?;

pub fn to_grayscale_output_image(
    &self,
    output_settings: &OutputSettings
) -> OutputImage<Gray8>

Converts the display contents into a grayscale output image.

Examples

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

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

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

// draw something to the display

let output_image = display.to_grayscale_output_image(&output_settings);
assert_eq!(output_image.size(), Size::new(256, 128));

// use output image:
// example: output_image.save_png("out.png")?;

Trait Implementations

impl<C: PixelColor> DrawTarget for SimulatorDisplay<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.

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

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

Fill a given area with a solid color.

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

Fill the entire display with a solid color.

impl<C> OriginDimensions for SimulatorDisplay<C>

fn size(&self) -> Size

Returns the size of the bounding box.