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
sourceimpl<'a, T> Image<'a, T> where
T: ImageDrawable,
impl<'a, T> Image<'a, T> where
T: ImageDrawable,
Trait Implementations
sourceimpl<'a, T> Dimensions for Image<'a, T> where
T: OriginDimensions,
impl<'a, T> Dimensions for Image<'a, T> where
T: OriginDimensions,
sourcefn bounding_box(&self) -> Rectangle
fn bounding_box(&self) -> Rectangle
Returns the bounding box.
sourceimpl<'a, T> Drawable for Image<'a, T> where
T: ImageDrawable,
impl<'a, T> Drawable for Image<'a, T> where
T: ImageDrawable,
sourceimpl<T> Transform for Image<'_, T>
impl<T> Transform for Image<'_, T>
sourcefn translate(&self, by: Point) -> Self
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));
sourcefn translate_mut(&mut self, by: Point) -> &mut Self
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));
impl<'a, T: Copy> Copy for Image<'a, T>
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedAs for T
impl<T> CheckedAs for T
sourcepub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
sourcepub fn checked_cast_from(src: Src) -> Option<Dst>
pub fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
sourceimpl<T> OverflowingAs for T
impl<T> OverflowingAs for T
sourcepub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
pub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
sourcepub fn overflowing_cast_from(src: Src) -> (Dst, bool)
pub fn overflowing_cast_from(src: Src) -> (Dst, bool)
OverflowingCasts the value.
sourceimpl<T> SaturatingAs for T
impl<T> SaturatingAs for T
sourcepub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
sourcepub fn saturating_cast_from(src: Src) -> Dst
pub fn saturating_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
sourcepub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
sourcepub fn unwrapped_cast_from(src: Src) -> Dst
pub fn unwrapped_cast_from(src: Src) -> Dst
UnwrappedCasts the value.
sourceimpl<T> WrappingAs for T
impl<T> WrappingAs for T
sourcepub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
sourcepub fn wrapping_cast_from(src: Src) -> Dst
pub fn wrapping_cast_from(src: Src) -> Dst
WrappingCasts the value.