Struct OutputImage

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

Output image.

An output image is the result of applying OutputSettings to a SimulatorDisplay. It can be used to save a simulator display to a PNG file.

Implementations

impl<C> OutputImage<C>

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

pub fn update<DisplayC>(&mut self, display: &SimulatorDisplay<DisplayC>)

where DisplayC: PixelColor + Into<Rgb888>,

Updates the image from a SimulatorDisplay.

impl<C: OutputImageColor> OutputImage<C>

pub fn save_png<PATH: AsRef<Path>>(&self, path: PATH) -> ImageResult<()>

Saves the image content to a PNG file.

Examples found in repository

examples/png-file.rs (line 33)

fn main() {
    let mut display = SimulatorDisplay::<BinaryColor>::new(Size::new(256, 64));

    let large_text = MonoTextStyle::new(&FONT_10X20, BinaryColor::On);
    let centered = TextStyleBuilder::new()
        .baseline(Baseline::Middle)
        .alignment(Alignment::Center)
        .build();

    Text::with_text_style(
        "embedded-graphics",
        display.bounding_box().center(),
        large_text,
        centered,
    )
    .draw(&mut display)
    .unwrap();

    let output_settings = OutputSettingsBuilder::new().scale(2).build();
    let output_image = display.to_rgb_output_image(&output_settings);

    let path = std::env::args_os()
        .nth(1)
        .expect("expected PNG file name argument");
    output_image.save_png(path).unwrap();
}

pub fn to_base64_png(&self) -> ImageResult<String>

Returns the image as a base64 encoded PNG.

Examples found in repository

examples/png-base64.rs (line 32)

fn main() {
    let mut display = SimulatorDisplay::<BinaryColor>::new(Size::new(256, 64));

    let large_text = MonoTextStyle::new(&FONT_10X20, BinaryColor::On);
    let centered = TextStyleBuilder::new()
        .baseline(Baseline::Middle)
        .alignment(Alignment::Center)
        .build();

    Text::with_text_style(
        "embedded-graphics",
        display.bounding_box().center(),
        large_text,
        centered,
    )
    .draw(&mut display)
    .unwrap();

    let output_settings = OutputSettingsBuilder::new().scale(2).build();
    let output_image = display.to_grayscale_output_image(&output_settings);

    println!(
        "<img src=\"data:image/png;base64,{}\">",
        output_image.to_base64_png().unwrap()
    );
}

pub fn as_image_buffer(&self) -> ImageBuffer<C::ImageColor, &[u8]>

Returns the output image as an image crate ImageBuffer.

Trait Implementations

impl<C: Clone> Clone for OutputImage<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for OutputImage<C>

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

Formats the value using the given formatter.

impl<C> OriginDimensions for OutputImage<C>

fn size(&self) -> Size

Returns the size of the bounding box.

impl<C: PartialEq> PartialEq for OutputImage<C>

fn eq(&self, other: &OutputImage<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: Eq> Eq for OutputImage<C>

impl<C> StructuralPartialEq for OutputImage<C>