Struct asefile::Cel

pub struct Cel<'a> { /* private fields */ }

A reference to a single Cel. A cel contains the image data at a specific layer and frame. In the timeline view these are the dots.

You can get a cel by going either via frame then layer or vice versa.

Official docs for cels.

Implementations

impl<'a> Cel<'a>

pub fn image(&self) -> RgbaImage

This cel as an image. Result has the same dimensions as the AsepriteFile. If the cel is empty, all image pixels will be transparent.

pub fn is_empty(&self) -> bool

Returns true if the cel contains no data.

pub fn frame(&self) -> u32

The frame coordinate of this cel.

pub fn layer(&self) -> u32

The layer coordinate of this cel.

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

Returns the cel’s user data, if any is present.

pub fn top_left(&self) -> (i32, i32)

Top-left corner of the non-empty rectangular area of the cel.

In other words, the first component is the smallest x coordinate of a non-empty pixel. And the second is the same for y.

These may be negative or outside of the visible area. This can happen if you drag a layer around.

pub fn is_tilemap(&self) -> bool

Does this cel include a tilemap.

Trait Implementations

impl<'a> Debug for Cel<'a>

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

Formats the value using the given formatter.