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>
impl<C: PixelColor, B: FrameBufferBackend<Color = C>> FrameBuf<C, B>
Sourcepub fn new(data: B, width: usize, height: usize) -> Self
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);
Sourcepub fn new_with_origin(
data: B,
width: usize,
height: usize,
origin: Point,
) -> Self
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 origin(&self) -> Point
Sourcepub fn set_color_at(&mut self, p: Point, color: C)
pub fn set_color_at(&mut self, p: Point, color: C)
Set a pixel’s color.
Sourcepub fn get_color_at(&self, p: Point) -> C
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>
impl<C: PixelColor + Default, B: FrameBufferBackend<Color = C>> FrameBuf<C, B>
Trait Implementations§
Source§impl<C: PixelColor, B: FrameBufferBackend<Color = C>> DrawTarget for FrameBuf<C, B>
impl<C: PixelColor, B: FrameBufferBackend<Color = C>> DrawTarget for FrameBuf<C, B>
Source§type Error = Infallible
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>
fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
Draw individual pixels to the display without a defined order. Read more
Source§fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>
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>,
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§impl<'a, C: PixelColor, B: FrameBufferBackend<Color = C>> IntoIterator for &'a FrameBuf<C, B>
impl<'a, C: PixelColor, B: FrameBufferBackend<Color = C>> IntoIterator for &'a FrameBuf<C, B>
Source§fn into_iter(self) -> Self::IntoIter
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 IntoIter = PixelIterator<'a, C, B>
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>
impl<C: PixelColor, B: FrameBufferBackend<Color = C>> OriginDimensions for FrameBuf<C, B>
Source§impl<C: PixelColor, B: DMACapableFrameBufferBackend<Color = C>> ReadBuffer for FrameBuf<C, B>
impl<C: PixelColor, B: DMACapableFrameBufferBackend<Color = C>> ReadBuffer for FrameBuf<C, B>
Source§impl<C: PixelColor, B: DMACapableFrameBufferBackend<Color = C>> WriteBuffer for FrameBuf<C, B>
impl<C: PixelColor, B: DMACapableFrameBufferBackend<Color = C>> WriteBuffer for FrameBuf<C, B>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> Dimensions for Twhere
T: OriginDimensions,
impl<T> Dimensions for Twhere
T: OriginDimensions,
Source§fn bounding_box(&self) -> Rectangle
fn bounding_box(&self) -> Rectangle
Returns the bounding box.
Source§impl<T> DrawTargetExt for Twhere
T: DrawTarget,
impl<T> DrawTargetExt for Twhere
T: DrawTarget,
Source§fn translated(&mut self, offset: Point) -> Translated<'_, T>
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>
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>
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>
fn color_converted<C>(&mut self) -> ColorConverted<'_, T, C>
Creates a color conversion draw target. Read more
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.