Struct SpriteSheetAnimator 

pub struct SpriteSheetAnimator {
    pub columns: usize,
    pub rows: usize,
    pub total_frames: usize,
    pub current_frame: usize,
    pub fps: f32,
    pub looping: bool,
    pub playing: bool,
    /* private fields */
}

Sprite sheet (texture atlas) animator.

Steps through frames of a regular grid of sprites in a texture atlas.

Fields

columns: usize

Number of columns in the sprite sheet.

rows: usize

Number of rows in the sprite sheet.

total_frames: usize

Total number of frames (may be less than columns * rows if last row is partial).

current_frame: usize

Current frame index.

fps: f32

Frames per second.

looping: bool

Whether to loop.

playing: bool

Whether the animation is playing.

Implementations

impl SpriteSheetAnimator

pub fn new(columns: usize, rows: usize, fps: f32) -> Self

Create a new sprite sheet animator.

pub fn with_total_frames(self, total: usize) -> Self

Set the total frame count (for partial last rows).

pub fn with_looping(self, looping: bool) -> Self

Set looping.

pub fn tick(&mut self, dt: f32)

Advance the animation.

pub fn set_frame(&mut self, frame: usize)

Set the current frame.

pub fn current_uv_rect(&self) -> (Vec2, Vec2)

Get the UV rect for the current frame: (uv_min, uv_max).

pub fn frame_uv_rect(&self, frame: usize) -> (Vec2, Vec2)

Get the UV rect for a specific frame.

pub fn map_uv(&self, local_uv: Vec2) -> Vec2

Transform a normalized UV (0-1) to the atlas UV for the current frame.

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

Get the current frame row and column.

pub fn play(&mut self)

Play the animation.

pub fn pause(&mut self)

Pause the animation.

pub fn reset(&mut self)

Reset to the first frame.

pub fn is_finished(&self) -> bool

Is the animation finished (non-looping only)?