Struct IndexedFrameBuffer 

pub struct IndexedFrameBuffer<C: ColorIndex = GbColor> { /* private fields */ }

A fixed-size framebuffer storing palette indices instead of RGBA pixels.

C is the palette index type (GbColor for 4-color DMG, GbaColor for 16-color GBA). Dimensions are chosen at construction (see Default for the 160×144 Game Boy screen). Storage is a packed planar bitplane array (see the module docs); index values are implicitly masked to the storage width on write.

Implementations

impl<C: ColorIndex> IndexedFrameBuffer<C>

pub fn new(width: usize, height: usize, clear: C) -> Self

Create a new width × height buffer, cleared to clear.

pub const fn width(&self) -> usize

Screen width in pixels.

pub const fn height(&self) -> usize

Screen height in pixels.

pub fn len(&self) -> usize

Total number of pixels.

pub fn is_empty(&self) -> bool

Whether the buffer holds no pixels.

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

Clear the entire buffer to a single index.

pub fn set_pixel(&mut self, x: u32, y: u32, color: C) -> bool

Set a single pixel. Returns false if out of bounds.

pub fn get_pixel(&self, x: u32, y: u32) -> Option<C>

Get the index of a single pixel. Returns None if out of bounds.

pub fn fill_rect( &mut self, x: u32, y: u32, rect_width: u32, rect_height: u32, color: C, )

Fill a rectangular region with an index. Coordinates are clamped to buffer bounds.

pub fn to_rgba(&self, palette: &Palette<C>, out: &mut [u8]) -> bool

Expand the indexed buffer into RGBA using palette.

Writes width * height * 4 bytes of row-major [r, g, b, a] pixel data into out. Returns false (and writes nothing) if out is too small. The palette should define an entry for every index in the buffer.

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

Raw packed storage, in the planar bitplane format described in the module docs. For GbColor this is GB 2bpp tile data, so any 8×8-aligned region can be fed directly to crate::tile::Tile::from_2bpp.

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

Mutable raw packed storage (e.g. for tile blits into 8×8-aligned regions, or for serialization). The caller must preserve the planar bitplane layout.

Trait Implementations

impl<C: Clone + ColorIndex> Clone for IndexedFrameBuffer<C>

fn clone(&self) -> IndexedFrameBuffer<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + ColorIndex> Debug for IndexedFrameBuffer<C>

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

Formats the value using the given formatter.

impl<C: ColorIndex> Default for IndexedFrameBuffer<C>

The default IndexedFrameBuffer is a 160×144 Game Boy screen, cleared to index 0.

fn default() -> Self

Returns the “default value” for a type.

impl<C: Eq + ColorIndex> Eq for IndexedFrameBuffer<C>

impl<C: PartialEq + ColorIndex> PartialEq for IndexedFrameBuffer<C>

fn eq(&self, other: &IndexedFrameBuffer<C>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<C: PartialEq + ColorIndex> StructuralPartialEq for IndexedFrameBuffer<C>

impl<C: ColorIndex> TransitionFb for IndexedFrameBuffer<C>

fn size(&self) -> (usize, usize)

(width, height) in pixels.

fn tile_black(&mut self, tx: usize, ty: usize)

Fill the 8×8 tile at tile coordinates (tx, ty) with black. Out-of-bounds tiles are clamped to the visible area.

fn tile_copy( &mut self, tx: usize, ty: usize, src: &Self, stx: usize, sty: usize, )

Copy the 8×8 tile at tile coordinates (stx, sty) of src into tile (tx, ty) of self. Out-of-bounds areas are clamped.