logo
pub struct Image<'a, T> { /* private fields */ }
Expand description

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

Creates a new Image.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the bounding box.

The pixel color type.

The return type of the draw method. Read more

Draw the graphics object using the supplied DrawTarget.

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);

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));

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);

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));

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Casts the value.

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Casts the value.

Casts the value.

Casts the value.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Casts the value.

OverflowingCasts the value.

Casts the value.

Casts the value.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Casts the value.

UnwrappedCasts the value.

Casts the value.

WrappingCasts the value.