Struct embedded_graphics::image::Image8BPP

pub struct Image8BPP<'a, C: PixelColor> {
    pub offset: Coord,
    /* private fields */
}

8 bits per pixel image

Each byte of input data defines the on/off state for each pixel. This currently only supports monochrome displays, so if the pixel value is 0, it’s off, anything above 0 is on.

You can convert an image to 8BPP for inclusion with include_bytes!() using the following Imagemagick command:

convert image.png -depth 8 gray:"image.raw"

Fields

offset: Coord

Top left corner offset from display origin (0,0)

Trait Implementations

impl<'a, C: Debug + PixelColor> Debug for Image8BPP<'a, C>

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

Formats the value using the given formatter.

impl<'a, C> Dimensions for Image8BPP<'a, C>where
    C: PixelColor,

fn top_left(&self) -> Coord

Get the top left corner of the bounding box for an object

fn bottom_right(&self) -> Coord

Get the bottom right corner of the bounding box for an object

fn size(&self) -> UnsignedCoord

Get the width and height for an object

impl<'a, C> Image<'a> for Image8BPP<'a, C>where
    C: PixelColor,

fn new(imagedata: &'a [u8], width: u32, height: u32) -> Self

Create a new 8BPP image with given data, width and height. Data length must equal width * height

impl<'a, C> IntoIterator for &'a Image8BPP<'a, C>where
    C: PixelColor,

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = Image8BPPIterator<'a, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C> Transform for Image8BPP<'a, C>where
    C: PixelColor,

fn translate(&self, by: Coord) -> Self

Translate the image from its current position to a new position by (x, y) pixels, returning a new Image8BPP. For a mutating transform, see translate_mut.

// 1px x 1px test image
let image: Image8BPP<PixelColorU8> = Image8BPP::new(&[ 0xff ], 1, 1);
let moved = image.translate(Coord::new(25, 30));

assert_eq!(image.offset, Coord::new(0, 0));
assert_eq!(moved.offset, Coord::new(25, 30));

fn translate_mut(&mut self, by: Coord) -> &mut Self

Translate the image from its current position to a new position by (x, y) pixels.

// 1px x 1px test image
let mut image: Image8BPP<PixelColorU8> = Image8BPP::new(&[ 0xff ], 1, 1);
image.translate_mut(Coord::new(25, 30));

assert_eq!(image.offset, Coord::new(25, 30));

impl<'a, C> Drawable for Image8BPP<'a, C>where
    C: PixelColor,