Struct asefile::Tileset

pub struct Tileset<P = Pixels> { /* private fields */ }

A set of tiles of the same size.

In the GUI, this is the collection of tiles that you build up in the side bar. Each tile has the same size and is identified by an Id.

See official docs for tilemaps and tilesets for details.

Implementations

impl<P> Tileset<P>

pub fn id(&self) -> u32

Tileset id.

pub fn empty_tile_is_id_zero(&self) -> bool

From the Aseprite file spec: When true, tilemaps using this tileset use tile ID=0 as empty tile. In rare cases this is false, the empty tile will be equal to 0xffffffff (used in internal versions of Aseprite).

pub fn tile_count(&self) -> u32

Number of tiles.

pub fn tile_size(&self) -> TileSize

Tile width and height.

pub fn base_index(&self) -> i16

Number to show in the UI for the tile with index=0. Default is 1. Only used for Aseprite UI purposes. Not used for data representation.

pub fn name(&self) -> &str

Tileset name. May not be unique among tilesets.

pub fn external_file(&self) -> Option<&ExternalTilesetReference>

When non-empty, describes a link to an external file.

impl Tileset<Pixels>

pub fn tile_image(&self, tile_index: u32) -> RgbaImage

Get the image for the given tile.

pub fn image(&self) -> RgbaImage

Collect all tiles into one long vertical image.

The image has width equal to the tile width and height equal to tile_size().width() * tile_count().

Trait Implementations

impl<P: Debug> Debug for Tileset<P>

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

Formats the value using the given formatter.