Struct AsepriteFile 

pub struct AsepriteFile<'a> {
    pub file: File<'a>,
    pub layers: Vec<Layer>,
    pub frames: Vec<Frame>,
    pub tags: Vec<Tag>,
    pub images: Vec<Image<'a>>,
}

This can be used to load an Aseprite file.

Fields

file: File<'a>

Parsed low-level file representation.

layers: Vec<Layer>

All layers in the file in order

frames: Vec<Frame>

All frames in the file in order

tags: Vec<Tag>

All tags in the file

images: Vec<Image<'a>>

All images in the file

Implementations

impl AsepriteFile<'_>

pub fn load(data: &[u8]) -> Result<AsepriteFile<'_>, LoadSpriteError>

Load a aseprite file from a byte slice

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

Get size of the sprite (width, height)

pub fn tags(&self) -> &[Tag]

Get tag names

pub fn layers(&self) -> &[Layer]

Get layer names

pub fn frames(&self) -> &[Frame]

Get the image indices for a given tag and layer

pub fn image_count(&self) -> usize

Get image count

pub fn select_layers( &self, predicate: impl Fn(&Layer) -> bool, ) -> LayerSelection

Convert layer names into a LayerSelection for use with render_frame.

The premise is used to select the layers which should be included.

pub fn select_layers_by_name(&self, names: &[&str]) -> LayerSelection

Convert layer names into a LayerSelection for use with render_frame.

The returned selection marks a layer as visible if its name appears in names. Call this once and reuse the result across frames.

pub fn combined_frame_image( &self, frame_index: usize, target: &mut [u8], ) -> Result<u64, LoadImageError>

👎Deprecated: Use render_frame instead.

Render a frame for a given frame index. This combines all visible layers into a buffer.

Returns a hash describing the image, since cels can be reused in multiple frames.

pub fn render_frame( &self, frame_index: usize, target: &mut [u8], layers: &LayerSelection, ) -> Result<(), LoadImageError>

Render a frame for a given frame index. This combines layers depending on the layer selection into a buffer.

The target buffer must be at least width * height * 4 bytes. Pixels are written as RGBA8.

pub fn load_image( &self, index: usize, target: &mut [u8], ) -> Result<(), LoadImageError>

Get image loader for a given image index

pub fn slices(&self) -> &[SliceChunk<'_>]

Return all slice chunks from the source file.

Trait Implementations

impl<'a> Debug for AsepriteFile<'a>

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

Formats the value using the given formatter.