Struct RawFrameBuf

pub struct RawFrameBuf<C, BUF>
where
    C: IntoRawBytes,
    BUF: RawBufferBackendMut,
{ /* private fields */ }

A framebuffer that writes pixel data directly into a raw byte buffer.

This struct implements DrawTarget and is generic over a color format C (which must implement IntoRawBytes) and a buffer backend BUF (which must implement RawBufferBackendMut). See the module-level documentation for a usage example.

Implementations

impl<C, BUF> RawFrameBuf<C, BUF>

where C: IntoRawBytes, BUF: RawBufferBackendMut,

pub fn new(buffer: BUF, width: usize, height: usize) -> Self

Creates a new raw framebuffer.

Panics

Panics if the provided buffer is smaller than width * height * C::BYTES_PER_PIXEL.

pub fn width(&self) -> usize

Returns the width of the framebuffer in pixels.

pub fn height(&self) -> usize

Returns the height of the framebuffer in pixels.

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

Returns the raw framebuffer data as an immutable byte slice.

pub fn as_mut_bytes(&mut self) -> &mut [u8]

Returns the raw framebuffer data as a mutable byte slice.

Trait Implementations

impl<C, BUF> DrawTarget for RawFrameBuf<C, BUF>

where C: IntoRawBytes, BUF: RawBufferBackendMut,

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

Fill a given area 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.

impl<C, BUF> OriginDimensions for RawFrameBuf<C, BUF>

where C: IntoRawBytes, BUF: RawBufferBackendMut,

fn size(&self) -> Size

Returns the size of the bounding box.