[−][src]Struct embedded_graphics::image::ImageRaw
An image constructed from a slice of raw pixel data.
The ImageRaw
struct can be used to construct an image from a slice
of raw image data. The storage format is determined by the PixelColor
type C
and the ByteOrder
BO
. The byteorder doesn't need to be
specified for colors which aren't stored in multiple bytes.
For color types with less than 8 bits per pixels the start of each row is aligned to the next whole byte.
Details about the conversion of raw data to color types are explained in the
raw
module documentation.
As ImageRaw
does not implement [Drawable
], it cannot be directly drawn to a supported
display. The Image
struct should be used to wrap an ImageRaw
to make it drawable.
Examples
Draw a 1BPP image
This example creates an image from 1 bit per pixel data.
use embedded_graphics::{ image::{Image, ImageRaw}, pixelcolor::BinaryColor, prelude::*, }; /// Image data with 12 x 5 pixels. /// The data for each row is 12 bits long and is padded with zeros on the /// end because each row needs to contain a whole number of bytes. #[rustfmt::skip] const DATA: &[u8] = &[ 0b11101111, 0b0101_0000, 0b10001000, 0b0101_0000, 0b11101011, 0b0101_0000, 0b10001001, 0b0101_0000, 0b11101111, 0b0101_0000, ]; // The type annotation `ImageRaw<BinaryColor>` is used to specify the format // of the stored raw data (`PixelColor::Raw`) and which color type the // raw data gets converted into. let raw_image: ImageRaw<BinaryColor> = ImageRaw::new(DATA, 12, 5); let image: Image<_, BinaryColor> = Image::new(&raw_image, Point::zero()); let mut display = Display::default(); image.draw(&mut display)?;
Draw an image that uses multibyte pixel encoding
Colors with more than one byte per pixel need an additional type annotation for the byte order.
For convenience, the ImageRawBE
and ImageRawLE
type aliases can be used to abbreviate
the type.
use embedded_graphics::{ image::{Image, ImageRaw, ImageRawBE, ImageRawLE}, pixelcolor::{ raw::{BigEndian, LittleEndian}, Rgb565, Rgb888, }, prelude::*, }; // Rgb888 image with 24 bits per pixel and big endian byte order let image1: ImageRawBE<Rgb888> = ImageRaw::new(DATA, 8, 8); // or: let image2: ImageRaw<Rgb888, BigEndian> = ImageRaw::new(DATA, 8, 8); // Rgb565 image with 16 bits per pixel and little endian byte order let image1: ImageRawLE<Rgb565> = ImageRaw::new(DATA, 16, 6); // or: let image2: ImageRaw<Rgb565, LittleEndian> = ImageRaw::new(DATA, 16, 6);
Methods
impl<'a, C, BO> ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
Trait Implementations
impl<'a, C: Clone, BO: Clone> Clone for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
fn clone(&self) -> ImageRaw<'a, C, BO>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, C: Copy, BO: Copy> Copy for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
impl<'a, C: Debug, BO: Debug> Debug for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
impl<'a, C: Eq, BO: Eq> Eq for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
impl<'a, C: Hash, BO: Hash> Hash for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<'_, C, BO> ImageDimensions for ImageRaw<'_, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
impl<'a, 'b, C, BO> IntoIterator for &'a ImageRaw<'b, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
RawDataIter<'b, C::Raw, BO>: Iterator<Item = C::Raw>,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
RawDataIter<'b, C::Raw, BO>: Iterator<Item = C::Raw>,
type Item = Pixel<C>
The type of the elements being iterated over.
type IntoIter = ImageRawIterator<'a, 'b, C, BO>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
impl<'a, 'b, C, BO> IntoPixelIter<C> for &'a ImageRaw<'b, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
RawDataIter<'b, C::Raw, BO>: Iterator<Item = C::Raw>,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
RawDataIter<'b, C::Raw, BO>: Iterator<Item = C::Raw>,
type PixelIterator = ImageRawIterator<'a, 'b, C, BO>
Iterator over pixels in the image
fn pixel_iter(self) -> Self::PixelIterator
[src]
impl<'a, C: Ord, BO: Ord> Ord for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
fn cmp(&self, other: &ImageRaw<'a, C, BO>) -> Ordering
[src]
#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<'a, C: PartialEq, BO: PartialEq> PartialEq<ImageRaw<'a, C, BO>> for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
fn eq(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
fn ne(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
impl<'a, C: PartialOrd, BO: PartialOrd> PartialOrd<ImageRaw<'a, C, BO>> for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
fn partial_cmp(&self, other: &ImageRaw<'a, C, BO>) -> Option<Ordering>
[src]
fn lt(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
fn le(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
fn gt(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
fn ge(&self, other: &ImageRaw<'a, C, BO>) -> bool
[src]
impl<'a, C, BO> StructuralEq for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
impl<'a, C, BO> StructuralPartialEq for ImageRaw<'a, C, BO> where
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
[src]
C: PixelColor + From<<C as PixelColor>::Raw>,
BO: ByteOrder,
Auto Trait Implementations
impl<'a, C, BO> Send for ImageRaw<'a, C, BO> where
BO: Send,
C: Send,
BO: Send,
C: Send,
impl<'a, C, BO> Sync for ImageRaw<'a, C, BO> where
BO: Sync,
C: Sync,
BO: Sync,
C: Sync,
impl<'a, C, BO> Unpin for ImageRaw<'a, C, BO> where
BO: Unpin,
C: Unpin,
BO: 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<T> Scalar for T where
T: PartialEq<T> + Copy + Any + Debug,
[src]
T: PartialEq<T> + Copy + Any + Debug,
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>,