Struct embedded_graphics::image::Image

source ·
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§

source§

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

source

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

Creates a new Image.

source

pub fn with_center(image_drawable: &'a T, center: Point) -> Self

Creates a new Image centered around a given point.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a, T> Dimensions for Image<'a, T>

source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
source§

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

§

type Color = <T as ImageDrawable>::Color

The pixel color type.
§

type Output = ()

The return type of the draw method. Read more
source§

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

Draw the graphics object using the supplied DrawTarget.
source§

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

source§

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

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

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

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

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

Auto Trait Implementations§

§

impl<'a, T> Freeze for Image<'a, T>

§

impl<'a, T> RefUnwindSafe for Image<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for Image<'a, T>
where T: Sync,

§

impl<'a, T> Sync for Image<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for Image<'a, T>

§

impl<'a, T> UnwindSafe for Image<'a, T>
where T: RefUnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.