[−][src]Struct embedded_graphics::image::Image
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.
Methods
impl<'a, I, C> Image<'a, I, C> where
&'a I: IntoPixelIter<C>,
I: ImageDimensions,
C: PixelColor + From<<C as PixelColor>::Raw>,
[src]
&'a I: IntoPixelIter<C>,
I: ImageDimensions,
C: PixelColor + From<<C as PixelColor>::Raw>,
pub fn new(image_data: &'a I, position: Point) -> Self
[src]
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>
[src]
fn clone(&self) -> Image<'a, I, C>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, I: Copy, C: Copy> Copy for Image<'a, I, C>
[src]
impl<'a, I: Debug, C: Debug> Debug for Image<'a, I, C>
[src]
impl<'a, I, C> Dimensions for Image<'a, I, C> where
I: ImageDimensions,
C: PixelColor + From<<C as PixelColor>::Raw>,
[src]
I: ImageDimensions,
C: PixelColor + From<<C as PixelColor>::Raw>,
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>,
[src]
&'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>
[src]
impl<'a, 'b, I, C> IntoIterator for &'a Image<'b, I, C> where
&'b I: IntoPixelIter<C>,
C: PixelColor + From<<C as PixelColor>::Raw>,
[src]
&'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
[src]
impl<'_, I, C> Transform for Image<'_, I, C>
[src]
fn translate(&self, by: Point) -> Self
[src]
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
[src]
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));
Auto Trait Implementations
impl<'a, I, C> Send for Image<'a, I, C> where
C: Send,
I: Sync,
C: Send,
I: Sync,
impl<'a, I, C> Sync for Image<'a, I, C> where
C: Sync,
I: Sync,
C: Sync,
I: Sync,
impl<'a, I, C> Unpin for Image<'a, I, C> where
C: Unpin,
C: Unpin,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn is_in_subset(&self) -> bool
unsafe fn to_subset_unchecked(&self) -> SS
fn from_subset(element: &SS) -> SP
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
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>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,