Struct embedded_graphics::image::Image

pub struct Image<'a, I, C> { /* private fields */ }

Image drawable.

The Image struct serves as a wrapper around other image types that provide pixel data decoded from a given format (raw bytes, BMP, TGA, etc). It allows an image to be repositioned using Transform::translate() or Transform::translate_mut() and drawn to a display that implements the DrawTarget trait.

Image accepts any item that implements ImageDimensions and &'_ IntoPixelIter.

Refer to the module documentation for examples.

Implementations

impl<'a, I, C> Image<'a, I, C>

where &'a I: IntoPixelIter<C>, I: ImageDimensions, C: PixelColor + From<<C as PixelColor>::Raw>,

pub fn new(image_data: &'a I, position: Point) -> Self

Create a new Image with the given image pixel data.

The passed IntoPixelIter provides a source of pixel data from the original image.

Trait Implementations

impl<'a, I: Clone, C: Clone> Clone for Image<'a, I, C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I: Debug, C: Debug> Debug for Image<'a, I, C>

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

Formats the value using the given formatter.

impl<'a, I, C> Dimensions for Image<'a, I, C>

where I: ImageDimensions, 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, 'b, I, C> Drawable<C> for &'a Image<'b, I, C>

where &'b I: IntoPixelIter<C>, I: ImageDimensions, C: PixelColor + From<<C as PixelColor>::Raw>,

fn draw<D: DrawTarget<C>>(self, display: &mut D) -> Result<(), D::Error>

Draw the graphics object using the supplied DrawTarget.

impl<'a, 'b, I, C> IntoIterator for &'a Image<'b, I, C>

where &'b I: IntoPixelIter<C>, C: PixelColor + From<<C as PixelColor>::Raw>,

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = ImageIterator<'a, 'b, I, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<I, C> Transform for Image<'_, I, C>

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

Translate the image by a given delta, returning a new image

Examples

Move an image around

This examples moves a 4x4 black and white image by (10, 20) pixels without mutating the original image

use embedded_graphics::{
    geometry::Point,
    image::{Image, ImageRaw},
    pixelcolor::BinaryColor,
    prelude::*,
};

let image: ImageRaw<BinaryColor> = ImageRaw::new(&[0xff, 0x00, 0xff, 0x00], 4, 4);

let image: Image<_, BinaryColor> = Image::new(&image, Point::zero());

let image_moved = image.translate(Point::new(10, 20));

assert_eq!(image.top_left(), Point::zero());
assert_eq!(image_moved.top_left(), Point::new(10, 20));

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

Translate the image by a given delta, modifying the original object

Examples

Move an image around

This examples moves a 4x4 black and white image by (10, 20) pixels by mutating the original image

use embedded_graphics::{
    geometry::Point,
    image::{Image, ImageRaw},
    pixelcolor::BinaryColor,
    prelude::*,
};

let image: ImageRaw<BinaryColor> = ImageRaw::new(&[0xff, 0x00, 0xff, 0x00], 4, 4);

let mut image: Image<_, BinaryColor> = Image::new(&image, Point::zero());

image.translate_mut(Point::new(10, 20));

assert_eq!(image.top_left(), Point::new(10, 20));

impl<'a, I: Copy, C: Copy> Copy for Image<'a, I, C>