Struct FrameBuffer 

pub struct FrameBuffer { /* private fields */ }

An owned physical framebuffer region.

Created once per SDRAM allocation at boot. Owns geometry metadata plus the PhysAddr — no raw pointer, no u32 escape hatch in the public API.

Implementations

impl FrameBuffer

pub unsafe fn from_phys( addr: PhysAddr, width: u32, height: u32, stride_bytes: u32, format: PixelFmt, ) -> Self

Construct a FrameBuffer at a physical address.

Safety

The caller must ensure that:

• [addr, addr + stride_bytes * height) is a mapped, writable RAM region for the 'static lifetime of the returned value,
• no other FrameBuffer, &mut [u8], or DMA master references overlapping bytes,
• addr is appropriately aligned for format (4 bytes for Argb8888, 2 bytes for Rgb565, 1 byte for L8/A8/A4),
• stride_bytes >= width * pixel_size(format).

pub fn addr(&self) -> PhysAddr

Physical base address.

pub fn dma_addr(&self) -> DmaAddr

DMA bus address for handoff to a DMA master (DMA2D OMAR, LTDC CFBAR, etc.).

The conversion re-asserts pixel-format alignment; a misaligned framebuffer address is a construction-time bug but dma_addr falls back to byte alignment so callers receive a usable value rather than a panic. Wire errors are surfaced via the pixel validator in the DMA engine itself.

pub fn width(&self) -> u32

Width in pixels.

pub fn height(&self) -> u32

Height in pixels.

pub fn stride_bytes(&self) -> u32

Row stride in bytes.

pub fn format(&self) -> PixelFmt

Pixel format.

pub fn bank(&self) -> Option<u8>

SDRAM bank index (0..SDRAM_BANK_COUNT), or None if this framebuffer lives outside the Bank 2 window.

pub fn byte_len(&self) -> usize

Total framebuffer size in bytes (stride_bytes * height).

Trait Implementations

impl Debug for FrameBuffer

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

Formats the value using the given formatter.