Struct asefile::AsepriteFile

pub struct AsepriteFile { /* private fields */ }

A parsed Aseprite file.

Implementations

impl AsepriteFile

pub fn read_file(path: &Path) -> Result<Self>

Load Aseprite file. Loads full file into memory.

pub fn read<R: Read>(input: R) -> Result<AsepriteFile>

Load Aseprite file from any input that implements std::io::Read.

You can use this to read from an in-memory file.

pub fn width(&self) -> usize

Width in pixels.

pub fn height(&self) -> usize

Height in pixels.

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

Width and height in pixels.

pub fn num_frames(&self) -> u32

Number of animation frames.

pub fn num_layers(&self) -> u32

Number of layers.

pub fn pixel_format(&self) -> PixelFormat

The pixel format used by the origal file. This library internally represents all images as RGBA.

pub fn palette(&self) -> Option<&ColorPalette>

The color palette in the image.

For indexed color images, this includes all colors used by individual cels. However, the final image after layer blending may contain colors outside of this palette (or with different transparency levels).

pub fn is_indexed_color(&self) -> bool

Does this file use indexed color format.

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

The color index of the transparent pixel.

pub fn layer(&self, id: u32) -> Layer<'_>

Access a layer by ID.

Panics

Panics if the ID is not valid. ID must be less than number of layers.

pub fn layer_by_name(&self, name: &str) -> Option<Layer<'_>>

Access a layer by name.

If multiple layers with the same name exist returns the layer with the lower ID.

pub fn layers(&self) -> LayersIter<'_>

An iterator over all layers.

pub fn frame(&self, index: u32) -> Frame<'_>

A reference to a single frame.

Panics

Panics if index is not less than num_frames.

pub fn cel(&self, frame: u32, layer: u32) -> Cel<'_>

Get a direct reference to a Cel.

Argument order is x, y if you think of the timeline panel in the GUI.

Panics

Panics if frame is not less than num_frames or if layer is not less than num_layers.

pub fn external_files(&self) -> &ExternalFilesById

A mapping from external file ids to external files.

pub fn external_file_by_id(&self, id: &ExternalFileId) -> Option<&ExternalFile>

Get a reference to an external file by ID, if the file exists.

pub fn num_tags(&self) -> u32

Total number of tags.

pub fn get_tag(&self, tag_id: u32) -> Option<&Tag>

Get a reference to the tag by ID.

pub fn tag(&self, tag_id: u32) -> &Tag

Get a reference to the tag by ID.

Panics

Panics if tag_id is not less than num_tags.

pub fn tag_by_name(&self, name: &str) -> Option<&Tag>

Lookup tag by name.

If multiple tags with the same name exist, returns the one with the lower ID.

pub fn tilesets(&self) -> &TilesetsById

Access the file’s Tilesets.

pub fn tilemap(&self, layer_id: u32, frame: u32) -> Option<Tilemap<'_>>

Get the Tilemap at the given cel.

Returns None if the cel is empty or if it is not a tilemap.

pub fn sprite_user_data(&self) -> Option<&UserData>

The user data for the entire sprite, if any exists.

pub fn slices(&self) -> &[Slice]

All Slices in the file.

Trait Implementations

impl Debug for AsepriteFile

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

Formats the value using the given formatter.