Struct simple_tilemap::Tileset

pub struct Tileset<C> { /* private fields */ }

Tileset holds a collection of tiles stored as their pixel data.

Currently only supports RGBA 8 bits per channel.

Tiles are counted left-to-right then top-to-bottom.

Generic parameter C is the container type, which should implement AsRef<[u8]>. You can use a simple Vec<u8>/&[u8] with RGBA data, Rc<[u8]>/Arc<[u8]> for cheap cloning or e.g. image’s ImageBuffer.

Implementations

impl<C> Tileset<C>

pub fn contains(&self, id: TileId) -> bool

Whether id is a valid tile id for this tileset.

Basically id < self.tile_count().

pub fn tile_count(&self) -> u32

Total amount of tiles in the tileset.

pub fn options(&self) -> &TilesetOptions

Tileset options used when creating the tileset.

impl<C> Tileset<C>

where C: AsRef<[u8]>,

pub fn new( data: C, width: u32, height: u32, opts: TilesetOptions ) -> Option<Self>

Construct a new tileset. width and height are data’s size in pixels.

pub fn get_tile_pos(&self, id: TileId) -> Option<(u32, u32)>

Get the position of a tile in the tileset. Useful if you need to render a single tile.

pub fn render_tile( &self, surface: &mut (impl BufferMut<Color> + ?Sized), id: TileId, offset_x: i32, offset_y: i32, opts: BlitOptions )

Render a single tile from the tileset, accounting for the key color.

Trait Implementations

impl<C> Buffer<RGBA<u8>> for Tileset<C>

where C: AsRef<[u8]>,

fn width(&self) -> u32

Buffer width

fn height(&self) -> u32

Buffer height

fn get(&self, x: u32, y: u32) -> &Color

Get a value at (x, y). This function must not panic when x < self.width() && y < self.height() (unless you want blit functions to panic). It will not be called with values outside of that range.

impl<C> BufferMut<RGBA<u8>> for Tileset<C>

where C: AsRef<[u8]> + AsMut<[u8]>,

fn get_mut(&mut self, x: u32, y: u32) -> &mut Color

Get a mutable value at (x, y). This function must not panic when x < self.width() && y < self.height() (unless you want blit functions to panic). It will not be called with values outside of that range.

impl<C: Clone> Clone for Tileset<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Tileset<C>

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

Formats the value using the given formatter.