Struct embedded_graphics::image::ImageBmp

pub struct ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>,  {
    pub offset: Point,
    // some fields omitted
}

BMP format image

ImageBmp is available with the bmp feature turned on

Examples

Load a 16 bit per pixel image from a raw byte slice and draw it to a display

Note that images must be passed to Display#draw by reference, or by explicitly calling .into_iter() on them, unlike other embedded_graphics objects.

use embedded_graphics::prelude::*;
use embedded_graphics::image::ImageBmp;

// Load `patch_16bpp.bmp`, a 16BPP 4x4px image
let image = ImageBmp::new(include_bytes!("../../../assets/patch_16bpp.bmp")).unwrap();

// Equivalent behavior
display.draw(&image);
display.draw(image.into_iter());

Fields

offset: Point

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

Trait Implementations

impl<'a, C> Drawable for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

impl<'a, C> Dimensions for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

fn top_left(&self) -> Point

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

fn bottom_right(&self) -> Point

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

fn size(&self) -> Size

Get the width and height for an object

impl<'a, C> ImageFile<'a> for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

fn new(image_data: &'a [u8]) -> Result<Self, ()>

Create a new BMP from a byte slice

fn width(&self) -> u32

Get the width in pixels of an image

fn height(&self) -> u32

Get the height in pixels of an image

impl<'a, C> Transform for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

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

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

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

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

impl<'a, C: Debug> Debug for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

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

Formats the value using the given formatter.

impl<'a, C> IntoIterator for &'a ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = ImageBmpIterator<'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: Clone> Clone for ImageBmp<'a, C> where
    C: PixelColor + From<<C as PixelColor>::Raw>, 

fn clone(&self) -> ImageBmp<'a, C>

Returns a copy of the value.

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

Performs copy-assignment from source.