Struct FrameBuffer 

pub struct FrameBuffer<'a> { /* private fields */ }

A structure representing a frame buffer.

Implementations

impl<'a> FrameBuffer<'a>

pub fn new(buffer: &'a mut [u8], width: u32, height: u32) -> Self

Creates a new frame buffer.

Arguments

• buffer - A mutable slice representing the pixel data.
• width - The width of the frame buffer.
• height - The height of the frame buffer.

pub fn get_buffer(&self) -> &[u8]

Returns a reference to the buffer.

Returns

A reference to the buffer.

pub fn clear(&mut self, color: Rgb565)

Clears the frame buffer with the specified color.

Arguments

• color - The color to clear the buffer with.

pub fn copy_region( &mut self, src_buffer: &[u8], src_x: u16, src_y: u16, src_width: u32, src_height: u32, dest_x: u16, dest_y: u16, )

Copies a region from another buffer into this buffer.

Arguments

• src_buffer - The source buffer.
• src_x - The x-coordinate of the top-left corner of the source region.
• src_y - The y-coordinate of the top-left corner of the source region.
• src_width - The width of the source region.
• src_height - The height of the source region.
• dest_x - The x-coordinate of the top-left corner of the destination region.
• dest_y - The y-coordinate of the top-left corner of the destination region.

pub fn copy_regions(&mut self, src_buffer: &[u8], regions: &[Option<Region>])

Restores regions from a source buffer into the frame buffer.

Arguments

• src_buffer - The source buffer.
• regions - An array of regions to restore.

pub fn diff_with<'b>( &'b self, other: &'b FrameBuffer<'a>, ) -> impl Iterator<Item = Pixel<Rgb565>> + 'b

Compares the current frame buffer with another frame buffer and returns an iterator of Pixel that can be drawn to update the display.

Arguments

• other - The other frame buffer to compare against.

Returns

An iterator of Pixel<Rgb565>.

Trait Implementations

impl<'a> DrawTarget for FrameBuffer<'a>

type Color = Rgb565

The pixel color type the targetted display supports.

type Error = ()

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<'a> OriginDimensions for FrameBuffer<'a>

fn size(&self) -> Size

Returns the size of the bounding box.