Struct playdate_rs::graphics::BitmapTable

pub struct BitmapTable { /* private fields */ }

There are two kinds of image tables: matrix and sequential.

Matrix image tables are great as sources of imagery for tilemap. They are loaded from a single file in your game’s source folder with the suffix -table-- before the file extension. The compiler splits the image into separate bitmaps of dimension w by h pixels that are accessible via imagetable:getImage(x,y).

Sequential image tables are useful as a way to load up sequential frames of animation. They are loaded from a sequence of files in your game’s source folder at compile time from filenames with the suffix -table- before the file extension. Individual images in the sequence are accessible via imagetable:getImage(n). The images employed by a sequential image table are not required to be the same size, unlike the images used in a matrix image table.

Implementations

impl BitmapTable

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

pub fn get(&self, idx: usize) -> Option<Ref<'_, Bitmap>>

Returns the idx bitmap in table, If idx is out of bounds, the function returns NULL.

pub fn load(&self, path: impl AsRef<str>) -> Result<(), Error>

Allocates and returns a new LCDBitmap from the file at path. If there is no file at path, the function returns null.

Trait Implementations

impl Debug for BitmapTable

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

Formats the value using the given formatter.

impl Drop for BitmapTable

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<BitmapTable> for BitmapTable

fn eq(&self, other: &BitmapTable) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BitmapTable

impl Send for BitmapTable

impl StructuralEq for BitmapTable

impl StructuralPartialEq for BitmapTable

impl Sync for BitmapTable