Struct DmaFrameBuffer 

pub struct DmaFrameBuffer<const NROWS: usize, const COLS: usize, const PLANES: usize> { /* private fields */ }

Plane-major BCM framebuffer (per-plane storage).

Implementations

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> DmaFrameBuffer<NROWS, COLS, PLANES>

pub const fn new() -> Self

Creates a new frame buffer, pre-formatted and ready for use.

Panics

Panics if NROWS is not within 1..=32 (5-bit row address) or PLANES is not within 1..=8 (8-bit color depth). With the esp32-ordering feature, also panics if COLS is not even (the ESP32’s byte-order swap requires an even column count). In const contexts (e.g. static framebuffers) this is a compile-time error.

Memory placement (⚠️ large buffer)

This framebuffer is a large inline array (roughly PLANES × NROWS × (COLS + gap) × 2 bytes). A 64×64 panel at PLANES = 8 is tens of kilobytes, which will overflow a task stack if bound to a local let. The framebuffer is mutable, so give it a 'static home that hands out &'static mut (e.g. static_cell::StaticCell) — never static mut. See the crate-level Memory placement section for a worked example.

pub const fn bcm_chunk_count() -> usize

👎Deprecated since 0.11.0:

use BCM_SEQUENCE instead

Returns the number of BCM chunks (one per bit-plane).

pub const fn bcm_chunk_bytes() -> usize

👎Deprecated since 0.11.0:

use BCM_SEQUENCE instead

Returns the byte size of one BCM chunk (a single bit-plane including tail word).

pub const fn format(&mut self)

Formats the frame buffer with row addresses and control bits.

pub fn erase(&mut self)

Erase pixel colors while preserving row control data.

pub fn set_pixel(&mut self, p: Point, color: Color)

Set a pixel in the framebuffer.

Trait Implementations

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> Clone for DmaFrameBuffer<NROWS, COLS, PLANES>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> Copy for DmaFrameBuffer<NROWS, COLS, PLANES>

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> Debug for DmaFrameBuffer<NROWS, COLS, PLANES>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> Default for DmaFrameBuffer<NROWS, COLS, PLANES>

fn default() -> Self

Returns the “default value” for a type.

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> DrawTarget for DmaFrameBuffer<NROWS, COLS, PLANES>

type Color = Rgb888

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<const NROWS: usize, const COLS: usize, const PLANES: usize> FrameBuffer for DmaFrameBuffer<NROWS, COLS, PLANES>

const BCM_SEQUENCE: [BcmLenReps; 10]

Static (len, reps) of the segments in one sequence, in scan order.

const BCM_SEQUENCE_LEN: usize = PLANES

Number of BCM segments in one sequence, i.e. the number of meaningful entries in BCM_SEQUENCE.

const BCM_SEQUENCE_COUNT: usize = 1

Number of times the sequence repeats in one complete panel refresh: NROWS for row-major framebuffers (one sequence per row), 1 for frame-major and threshold framebuffers (the sequence covers the whole frame).

type Word = u16

The DMA word type used by this framebuffer (u8 for latched, u16 for direct-drive). Driver implementations can use this to enforce that pin configurations match the framebuffer at compile time.

fn bcm_segment_ptr(&self, index: usize) -> *const u8

Returns the byte pointer for the index-th BCM segment.

const BCM_SEGMENT_COUNT: usize = _

Total number of BCM segments streamed for one complete panel refresh (all rows, all planes).

const BCM_SEGMENTS_PER_GROUP: usize = 1

Number of consecutive segments that a driver may chain into a single DMA transfer. Must divide BCM_SEQUENCE_LEN: groups never straddle a sequence boundary.

fn bcm_segment_count(&self) -> usize

Total number of BCM segments streamed for one complete panel refresh.

fn bcm_segment(&self, index: usize) -> BcmSegment

Returns the index-th BCM segment.

fn bcm_segments_per_group(&self) -> usize

Number of consecutive segments that form one transfer group.

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> FrameBufferOperations for DmaFrameBuffer<NROWS, COLS, PLANES>

fn erase(&mut self)

Erase pixel colors while preserving control bits. This is much faster than format() and is the typical way to clear the display.

fn set_pixel(&mut self, p: Point, color: Color)

Set a pixel in the framebuffer.

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> MutableFrameBuffer for DmaFrameBuffer<NROWS, COLS, PLANES>

impl<const NROWS: usize, const COLS: usize, const PLANES: usize> OriginDimensions for DmaFrameBuffer<NROWS, COLS, PLANES>

fn size(&self) -> Size

Returns the size of the bounding box.