Struct embedded_graphics_framebuf::FrameBuf

pub struct FrameBuf<C: PixelColor, B: FrameBufferBackend<Color = C>> {
    pub data: B,
    /* private fields */
}

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

Example

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

// Create a framebuffer for a 16-Bit 240x135px display
let mut data = [Rgb565::BLACK; 240 * 135];
let mut fbuff = FrameBuf::new(&mut data, 240, 135);

// write "Good luck" into the framebuffer.
Text::new(
    &"Good luck!",
    Point::new(10, 13),
    MonoTextStyle::new(&FONT_10X20, Rgb565::WHITE.into()),
)
.draw(&mut fbuff)
.unwrap();

Fields

data: B

Implementations

impl<C: PixelColor, B: FrameBufferBackend<Color = C>> FrameBuf<C, B>

pub fn new(data: B, width: usize, height: usize) -> Self

Create a new FrameBuf on top of an existing memory slice.

Panic

Panics if the size of the memory does not match the given width and height.

Example

use embedded_graphics::{pixelcolor::Rgb565, prelude::RgbColor};
use embedded_graphics_framebuf::FrameBuf;
let mut data = [Rgb565::BLACK; 240 * 135];
let mut fbuff = FrameBuf::new(&mut data, 240, 135);

pub fn new_with_origin( data: B, width: usize, height: usize, origin: Point ) -> Self

Create a new FrameBuf on top of an existing memory slice where pixels from .draw_iter() are mapped relative to provided origin.

Panic

Panics if the size of the memory does not match the given width and height.

Example

use embedded_graphics::{pixelcolor::Rgb565, prelude::RgbColor, prelude::Point};
use embedded_graphics_framebuf::FrameBuf;
let mut data = [Rgb565::BLACK; 240 * 135];
let mut fbuff = FrameBuf::new_with_origin(&mut data, 240, 135, Point::new(100, 100));

pub fn width(&self) -> usize

Get the framebuffers width.

pub fn height(&self) -> usize

Get the framebuffers height.

pub fn size(&self) -> Size

Get the framebuffers size.

pub fn origin(&self) -> Point

pub fn set_color_at(&mut self, p: Point, color: C)

Set a pixel’s color.

pub fn get_color_at(&self, p: Point) -> C

Get a pixel’s color.

impl<C: PixelColor + Default, B: FrameBufferBackend<Color = C>> FrameBuf<C, B>

pub fn reset(&mut self)

Trait Implementations

impl<C: PixelColor, B: FrameBufferBackend<Color = C>> DrawTarget for FrameBuf<C, B>

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, B: FrameBufferBackend<Color = C>> IntoIterator for &'a FrameBuf<C, B>

fn into_iter(self) -> Self::IntoIter

Creates an iterator over all Pixels in the frame buffer. Can be used for rendering the framebuffer to the physical display.

Example

use embedded_graphics::{
    draw_target::DrawTarget,
    mock_display::MockDisplay,
    pixelcolor::BinaryColor,
    prelude::{Point, Primitive},
    primitives::{Line, PrimitiveStyle},
    Drawable,
};
use embedded_graphics_framebuf::FrameBuf;
let mut data = [BinaryColor::Off; 12 * 11];
let mut fbuf = FrameBuf::new(&mut data, 12, 11);
let mut display: MockDisplay<BinaryColor> = MockDisplay::new();
Line::new(Point::new(2, 2), Point::new(10, 2))
    .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 2))
    .draw(&mut fbuf)
    .unwrap();
display.draw_iter(fbuf.into_iter()).unwrap();

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = PixelIterator<'a, C, B>

Which kind of iterator are we turning this into?

impl<C: PixelColor, B: FrameBufferBackend<Color = C>> OriginDimensions for FrameBuf<C, B>

fn size(&self) -> Size

Returns the size of the bounding box.

impl<C: PixelColor, B: DMACapableFrameBufferBackend<Color = C>> ReadBuffer for FrameBuf<C, B>

type Word = u8

unsafe fn read_buffer(&self) -> (*const Self::Word, usize)

Provide a buffer usable for DMA reads.