embedded_graphics_framebuf

Struct FrameBuf

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

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§

Source§

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

Source

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);
Source

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));
Source

pub fn width(&self) -> usize

Get the framebuffers width.

Source

pub fn height(&self) -> usize

Get the framebuffers height.

Source

pub fn size(&self) -> Size

Get the framebuffers size.

Source

pub fn origin(&self) -> Point

Source

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

Set a pixel’s color.

Source

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

Get a pixel’s color.

Source§

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

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

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

Source§

type Color = C

The pixel color type the targetted display supports.
Source§

type Error = Infallible

Error type to return when a drawing operation fails. Read more
Source§

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. Read more
Source§

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

Fill the entire display with a solid color. Read more
Source§

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. Read more
Source§

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

Fill a given area with a solid color. Read more
Source§

impl<'a, C: PixelColor, B: FrameBufferBackend<Color = C>> IntoIterator for &'a FrameBuf<C, B>

Source§

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();
Source§

type Item = Pixel<C>

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

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

Source§

fn size(&self) -> Size

Returns the size of the bounding box.
Source§

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

Source§

type Word = u8

Source§

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

Provide a buffer usable for DMA reads. Read more
Source§

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

Source§

type Word = u8

Source§

unsafe fn write_buffer(&mut self) -> (*mut Self::Word, usize)

Provide a buffer usable for DMA writes. Read more

Auto Trait Implementations§

§

impl<C, B> Freeze for FrameBuf<C, B>
where B: Freeze,

§

impl<C, B> RefUnwindSafe for FrameBuf<C, B>
where B: RefUnwindSafe,

§

impl<C, B> Send for FrameBuf<C, B>
where B: Send,

§

impl<C, B> Sync for FrameBuf<C, B>
where B: Sync,

§

impl<C, B> Unpin for FrameBuf<C, B>
where B: Unpin,

§

impl<C, B> UnwindSafe for FrameBuf<C, B>
where B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> Dimensions for T

Source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
Source§

impl<T> DrawTargetExt for T
where T: DrawTarget,

Source§

fn translated(&mut self, offset: Point) -> Translated<'_, T>

Creates a translated draw target based on this draw target. Read more
Source§

fn cropped(&mut self, area: &Rectangle) -> Cropped<'_, T>

Creates a cropped draw target based on this draw target. Read more
Source§

fn clipped(&mut self, area: &Rectangle) -> Clipped<'_, T>

Creates a clipped draw target based on this draw target. Read more
Source§

fn color_converted<C>(&mut self) -> ColorConverted<'_, T, C>
where C: PixelColor + Into<<T as DrawTarget>::Color>,

Creates a color conversion draw target. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.