Struct embedded_graphics::image::Image

pub struct Image<'a, T> { /* fields omitted */ }

Image object.

The Image struct serves as a wrapper around an ImageDrawable that provides support for an image 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.

Refer to the module documentation for examples.

Implementations

impl<'a, T> Image<'a, T> where
    T: ImageDrawable, 

pub fn new(image_drawable: &'a T, position: Point) -> Self

Creates a new Image.

Trait Implementations

impl<'a, T: Clone> Clone for Image<'a, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Copy> Copy for Image<'a, T>

impl<'a, T: Debug> Debug for Image<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Dimensions for Image<'a, T> where
    T: OriginDimensions, 

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl<'a, T> Drawable for Image<'a, T> where
    T: ImageDrawable, 

type Color = T::Color

The pixel color type.

fn draw<D>(&self, display: &mut D) -> Result<(), D::Error> where
    D: DrawTarget<Color = Self::Color>, 

Draw the graphics object using the supplied DrawTarget.

impl<T, '_> Transform for Image<'_, T>

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::new(&image, Point::zero());

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

assert_eq!(image.bounding_box().top_left, Point::zero());
assert_eq!(image_moved.bounding_box().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::new(&image, Point::zero());

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

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