Struct embedded_graphics::framebuffer::Framebuffer

pub struct Framebuffer<C, R, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> { /* private fields */ }

A framebuffer.

Examples

use embedded_graphics::{
    framebuffer,
    framebuffer::{Framebuffer, buffer_size},
    pixelcolor::{Rgb565, raw::LittleEndian},
    prelude::*,
    primitives::PrimitiveStyle,
};

let mut fb = Framebuffer::<Rgb565, _, LittleEndian, 320, 240, {buffer_size::<Rgb565>(320, 240)}>::new();

fb.bounding_box()
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
    .draw(&mut fb)
    .unwrap();

Implementations

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, C::Raw, BO, WIDTH, HEIGHT, N>

where C: PixelColor,

pub const fn new() -> Self

Creates a new framebuffer.

pub const fn data(&self) -> &[u8; N]

Returns a reference to the raw framebuffer data.

pub fn data_mut(&mut self) -> &mut [u8; N]

Returns a mutable reference to the raw framebuffer data.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, C::Raw, BO, WIDTH, HEIGHT, N>

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

pub fn as_image(&self) -> ImageRaw<'_, C, BO>

Returns an image based on the framebuffer content.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU1, BO, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU1>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU2, BO, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU2>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU4, BO, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU4>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU8, BO, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU8>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Setting a pixel outside the framebuffer’s bounding box will be a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU16, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU16>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU16, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU16>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU24, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU24>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU24, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU24>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU32, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU32>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> Framebuffer<C, RawU32, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor + Into<RawU32>,

pub fn set_pixel(&mut self, p: Point, c: C)

Sets the color of a pixel.

Trying to set a pixel outside the framebuffer is a noop.

Trait Implementations

impl<C: Clone, R: Clone, BO: Clone, const WIDTH: usize, const HEIGHT: usize, const N: usize> Clone for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

fn clone(&self) -> Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, R: Debug, BO: Debug, const WIDTH: usize, const HEIGHT: usize, const N: usize> Debug for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

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

Formats the value using the given formatter.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU1, BO, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU1> + Into<RawU1>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU16, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU16> + Into<RawU16>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU16, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU16> + Into<RawU16>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU2, BO, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU2> + Into<RawU2>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU24, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU24> + Into<RawU24>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU24, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU24> + Into<RawU24>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU32, BigEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU32> + Into<RawU32>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU32, LittleEndian, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU32> + Into<RawU32>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU4, BO, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU4> + Into<RawU4>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> DrawTarget for Framebuffer<C, RawU8, BO, WIDTH, HEIGHT, N>

where C: PixelColor<Raw = RawU8> + Into<RawU8>,

type Color = C

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl<C, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> GetPixel for Framebuffer<C, C::Raw, BO, WIDTH, HEIGHT, N>

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

type Color = C

The color type.

fn pixel(&self, p: Point) -> Option<C>

Gets the color of a pixel.

impl<C: Hash, R: Hash, BO: Hash, const WIDTH: usize, const HEIGHT: usize, const N: usize> Hash for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

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

Feeds this value into the given [Hasher].

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl<C: Ord, R: Ord, BO: Ord, const WIDTH: usize, const HEIGHT: usize, const N: usize> Ord for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

fn cmp(&self, other: &Framebuffer<C, R, BO, WIDTH, HEIGHT, N>) -> Ordering

This method returns an [Ordering] between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<C, R, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> OriginDimensions for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

fn size(&self) -> Size

Returns the size of the bounding box.

impl<C: PartialEq, R: PartialEq, BO: PartialEq, const WIDTH: usize, const HEIGHT: usize, const N: usize> PartialEq for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

fn eq(&self, other: &Framebuffer<C, R, BO, WIDTH, HEIGHT, N>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C: PartialOrd, R: PartialOrd, BO: PartialOrd, const WIDTH: usize, const HEIGHT: usize, const N: usize> PartialOrd for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

fn partial_cmp( &self, other: &Framebuffer<C, R, BO, WIDTH, HEIGHT, N>, ) -> Option<Ordering>

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

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

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

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

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

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

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

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<C: Eq, R: Eq, BO: Eq, const WIDTH: usize, const HEIGHT: usize, const N: usize> Eq for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>

impl<C, R, BO, const WIDTH: usize, const HEIGHT: usize, const N: usize> StructuralPartialEq for Framebuffer<C, R, BO, WIDTH, HEIGHT, N>