Struct embedded_graphics_simulator::SimulatorDisplay

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

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.

pub fn diff( &self, other: &SimulatorDisplay<C>, ) -> Option<SimulatorDisplay<BinaryColor>>

Compares the content of this display with another display.

If both displays are equal None is returned, otherwise a difference image is returned. All pixels that are different will be filled with BinaryColor::On and all equal pixels with BinaryColor::Off.

Panics

Panics if the both display don’t have the same size.

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")?;

impl<C> SimulatorDisplay<C>

where C: PixelColor + ToBytes, <C as ToBytes>::Bytes: AsRef<[u8]>,

pub fn to_be_bytes(&self) -> Vec<u8>

Converts the display content to big endian raw data.

pub fn to_le_bytes(&self) -> Vec<u8>

Converts the display content to little endian raw data.

pub fn to_ne_bytes(&self) -> Vec<u8>

Converts the display content to native endian raw data.

impl<C> SimulatorDisplay<C>

where C: PixelColor + From<Rgb888>,

pub fn load_png<P: AsRef<Path>>(path: P) -> ImageResult<Self>

Loads a PNG file.

Trait Implementations

impl<C: Clone> Clone for SimulatorDisplay<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for SimulatorDisplay<C>

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

Formats the value using the given formatter.

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.

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: Hash> Hash for SimulatorDisplay<C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<C: Ord> Ord for SimulatorDisplay<C>

fn cmp(&self, other: &SimulatorDisplay<C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<C> OriginDimensions for SimulatorDisplay<C>

fn size(&self) -> Size

Returns the size of the bounding box.

impl<C: PartialEq> PartialEq for SimulatorDisplay<C>

fn eq(&self, other: &SimulatorDisplay<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C: PartialOrd> PartialOrd for SimulatorDisplay<C>

fn partial_cmp(&self, other: &SimulatorDisplay<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C: Eq> Eq for SimulatorDisplay<C>

impl<C> StructuralPartialEq for SimulatorDisplay<C>