Struct benimator::State

pub struct State { /* private fields */ }

Animation state

Implementations

impl State

pub fn new() -> Self

Create a new state

pub fn reset(&mut self)

Reset animation state

The animation will restart from the first frame, like if the animation was freshly spawned.

pub fn animation_frame_index(&self) -> usize

Returns the index of the current animation frame

The index is relative to the animation sequence. not to the sprite-sheet.

pub fn sprite_frame_index(&self) -> usize

Returns the index of the current sprite frame

The index is relative to the sprite atlas. not to the animation frame sequence.

pub fn is_ended(&self) -> bool

Returns true if the animation has ended

pub fn update(&mut self, animation: &Animation, delta: Duration)

Update the animation state

Trait Implementations

impl Default for State

fn default() -> State

Returns the “default value” for a type.