Struct DmaFrameBuffer 

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

Row-major BCM framebuffer for row-by-row Binary Code Modulation.

See the module-level documentation for layout details and DMA descriptor patterns.

Type Parameters

• NROWS: number of multiplexed row pairs (panel height / 2)
• COLS: number of columns (panel width)
• PLANES: number of bit-planes (typically 8 for full 8-bit colour)

Implementations

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

pub const fn new() -> Self

Creates a new framebuffer, 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 divisible by 4 (the ESP32’s byte-order rearrangement requires column counts that are multiples of 4). In const contexts (e.g. static framebuffers) this is a compile-time error.

pub const fn bcm_chunk_count() -> usize

👎Deprecated since 0.11.0:

use BCM_SEQUENCE instead

Number of bit-planes.

pub const fn bcm_chunk_bytes() -> usize

👎Deprecated since 0.11.0:

use BCM_SEQUENCE instead

Byte size of one plane’s payload for a single row (pixel data plus its four address bytes).

pub const fn bcm_row_count() -> usize

Number of multiplexed scan rows.

pub const fn bcm_row_bytes() -> usize

Byte size of the per-row inter-row blanking gap.

pub const fn format(&mut self)

Formats the framebuffer with row addresses and control bits.

Every plane carries the current row address; blanking is applied around the plane0→plane1 address change. See the module-level documentation for the exact distribution.

pub fn erase(&mut self)

Erase pixel colours while preserving row control data.

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

Set a pixel in the framebuffer.

pub fn pixel_row_ptr_len( &self, row_idx: usize, plane_idx: usize, ) -> (*const u8, usize)

Returns a pointer and byte length for a plane’s payload (pixel data plus its four address bytes) within a single row.

Panics

Panics if row_idx >= NROWS or plane_idx >= PLANES.

pub fn gap_ptr_len(&self, row_idx: usize) -> (*const u8, usize)

Returns a pointer and byte length for a row’s inter-row blanking gap.

The gap is streamed between plane 0 (whose address bytes latch the data and change the row address) and plane 1. Returns length 0 when no inter-row-blank-* feature is enabled.

Panics

Panics if row_idx >= NROWS.

Trait Implementations

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

fn clone(&self) -> DmaFrameBuffer<NROWS, COLS, PLANES>

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

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

const BCM_SEQUENCE_COUNT: usize = NROWS

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).

const BCM_SEGMENTS_PER_GROUP: usize

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.

type Word = u8

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).

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.