Struct embedded_graphics_framebuf::FrameBuf

#[repr(transparent)]
pub struct FrameBuf<C: PixelColor, const X: usize, const Y: usize>(pub [[C; X]; Y]);

Constructs frame buffer in memory. Lets you define the size (width & height) and pixel type your using in your display (RGB, Monochrome etc.)

Example

use embedded_graphics::mono_font::ascii::FONT_10X20;
use embedded_graphics_framebuf::FrameBuf;
use embedded_graphics::prelude::*;
use embedded_graphics::mono_font::MonoTextStyle;
use embedded_graphics::text::Text;
use embedded_graphics::pixelcolor::Rgb565;

static mut FBUFF: FrameBuf<Rgb565, 240_usize, 135_usize> = FrameBuf([[Rgb565::BLACK; 240]; 135]);
let mut fbuff = unsafe { &mut FBUFF };
fbuff.clear_black();
Text::new(
   &"Good luck!",
   Point::new(10, 13),
   MonoTextStyle::new(&FONT_10X20, Rgb565::WHITE.into()),
)
.draw(&mut fbuff).unwrap();

Tuple Fields

0: [[C; X]; Y]

Implementations

impl<C: PixelColor + Default, const X: usize, const Y: usize> FrameBuf<C, X, Y>

pub fn clear_black(&mut self)

Set all pixels to black.

Trait Implementations

impl<C: Clone + PixelColor, const X: usize, const Y: usize> Clone for FrameBuf<C, X, Y>

fn clone(&self) -> FrameBuf<C, X, Y>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: PixelColor, const X: usize, const Y: usize> DrawTarget for &mut FrameBuf<C, X, Y>

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 clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

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.

impl<'a, C: PixelColor, const X: usize, const Y: usize> IntoIterator for &'a mut FrameBuf<C, X, Y>

type Item = C

The type of the elements being iterated over.

type IntoIter = FrameBufIntoIterator<'a, C, X, Y>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C: PixelColor, const X: usize, const Y: usize> IntoIterator for &'a FrameBuf<C, X, Y>

type Item = C

The type of the elements being iterated over.

type IntoIter = FrameBufIntoIterator<'a, C, X, Y>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C: PixelColor, const X: usize, const Y: usize> OriginDimensions for &mut FrameBuf<C, X, Y>

fn size(&self) -> Size

Returns the size of the bounding box.

impl<C: Copy + PixelColor, const X: usize, const Y: usize> Copy for FrameBuf<C, X, Y>