Struct embedded_graphics::image::ImageRaw

pub struct ImageRaw<'a, C, BO = BigEndian> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder,  { /* fields omitted */ }

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.

To draw an ImageRaw object it needs to be wrapped in an Image object.

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::*,
};

/// 12 x 5 pixel image with 1 bit per pixel.
/// 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 image dimensions and the format of the stored raw data must be specified
// when the `new` function is called. The data format can, for example, be specified
// by using the turbofish syntax. For the image dimensions only the width must be
// passed to the `new` function. The image height will be calculated based on the
// length of the image data and the data format.
let raw_image = ImageRaw::<BinaryColor>::new(DATA, 12);

let image = 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>::new(DATA, 8);
// or:
let image2 = ImageRaw::<Rgb888, BigEndian>::new(DATA, 8);

// Rgb565 image with 16 bits per pixel and little endian byte order
let image1 = ImageRawLE::<Rgb565>::new(DATA, 16);
// or:
let image2 = ImageRaw::<Rgb565, LittleEndian>::new(DATA, 16);

Implementations

impl<'a, C, BO> ImageRaw<'a, C, BO> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder, 

pub fn new(data: &'a [u8], width: u32) -> Self

Creates a new image.

Only the width of the image needs to be specified. The height of the image will be calculated based on the length of the given image data. If the length of the image data isn’t an integer multiple of the data length for a single row the last partial row will be ignored.

impl<'a> ImageRaw<'a, BinaryColor>

pub const fn new_binary(data: &'a [u8], width: u32) -> Self

Creates a new binary image.

Due to const fn limitations the new method cannot be used in const contexts. This method provides a workaround to create ImageRaws with BinaryColor images.

Only the width of the image needs to be specified. The height of the image will be calculated based on the length of the given image data.

Panics

This function panics if width == 0.

Trait Implementations

impl<'a, C: Clone, BO: Clone> Clone for ImageRaw<'a, C, BO> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder, 

fn clone(&self) -> ImageRaw<'a, C, BO>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, C: Copy, BO: Copy> Copy for ImageRaw<'a, C, BO> where
    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, 

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

Formats the value using the given formatter.

impl<'a, C: Eq, BO: Eq> Eq for ImageRaw<'a, C, BO> where
    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, 

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, C, BO> ImageDrawable for ImageRaw<'a, C, BO> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder,
    RawDataSlice<'a, C::Raw, BO>: IntoIterator<Item = C::Raw>, 

type Color = C

The color type.

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error> where
    D: DrawTarget<Color = C>, 

Draws the entire image to the target.

fn draw_sub_image<D>(
    &self,
    target: &mut D,
    area: &Rectangle
) -> Result<(), D::Error> where
    D: DrawTarget<Color = Self::Color>, 

Draws a part of the image to the target.

impl<'a, C: Ord, BO: Ord> Ord for ImageRaw<'a, C, BO> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder, 

fn cmp(&self, other: &ImageRaw<'a, C, BO>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<C, BO> OriginDimensions for ImageRaw<'_, C, BO> where
    C: PixelColor + From<<C as PixelColor>::Raw>,
    BO: ByteOrder, 

fn size(&self) -> Size

Returns the size of the bounding box.

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, 

fn eq(&self, other: &ImageRaw<'a, C, BO>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ImageRaw<'a, C, BO>) -> bool

This method tests for !=.

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, 

fn partial_cmp(&self, other: &ImageRaw<'a, C, BO>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, C, BO> StructuralEq for ImageRaw<'a, C, BO> where
    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,