Struct Image

pub struct Image<'a, C: PixelColor> { /* private fields */ }

Store image data.

Image can be constructed using the include_image macro at compile time. To draw an image it must be put inside a Sprite.

Implementations

impl<'a, C: PixelColor> Image<'a, C>

pub const fn new( colors: &'a [C], transparenty: &'a [u8], width: u16, height: u16, ) -> Result<Self, Error>

create a new Image from a array of PixelColors, a transparenty map.

Return an error, if the length of colors does not fit to the widht and height. You can unwrap the error in a const contexts, by using the konst crate see konst::result::unwrap_ctx for more informations.

transparency can be created by using the transparency! macro. It’s length doesn’t have to match the image length, missing data will be interpreted as fully opaque.

use embedded_graphics::pixelcolor::Bgr565;
use embedded_sprites::{image::Image, transparency};
use konst::result::unwrap_ctx;

type Color = Bgr565;
const IMAGE_DATA: [Color; 6] = [
	Color::new(255, 0, 0),
	Color::new(0, 255, 0),
	Color::new(0, 0, 255),
	Color::new(255, 0, 255),
	Color::new(255, 255, 255),
	Color::new(255, 255, 255),
];
const IMAGE: Image<Color> =
	unwrap_ctx!(Image::new(&IMAGE_DATA, &transparency![0, 0, 0, 1, 0], 3, 2));

Trait Implementations

impl<'a, C: Debug + PixelColor> Debug for Image<'a, C>

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

Formats the value using the given formatter.