Struct benimator::SpriteSheetAnimation

pub struct SpriteSheetAnimation { /* private fields */ }

Asset that define an animation of TextureAtlasSprite

See crate level documentation for usage

Implementations

impl SpriteSheetAnimation

pub fn from_frames(frames: Vec<Frame>) -> Self

Create a new animation from frames

pub fn from_range(
    index_range: RangeInclusive<usize>,
    frame_duration: Duration
) -> Self

Create a new animation from index-range, using the same frame duration for each frame.

For more granular configuration, see from_frames

pub fn from_iter(
    indices: impl IntoIterator<Item = usize>,
    frame_duration: Duration
) -> Self

Create a new animation from an index iterator, using the same frame duration for each frame.

Example

You may use this to create a reversed animation:

let animation = SpriteSheetAnimation::from_iter((0..5).rev(), Duration::from_millis(100));

For more granular configuration, see from_frames

pub fn once(self) -> Self

Runs the animation once and then stop playing

pub fn repeat(self) -> Self

Repeat the animation forever

pub fn repeat_from(self, frame_index: usize) -> Self

Repeat the animation forever, from a given frame index (loop back to it at the end of the animation)

pub fn ping_pong(self) -> Self

Repeat the animation forever, going back and forth between the first and last frame.

Trait Implementations

impl Clone for SpriteSheetAnimation

fn clone(&self) -> SpriteSheetAnimation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpriteSheetAnimation

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

Formats the value using the given formatter.

impl Default for SpriteSheetAnimation

fn default() -> SpriteSheetAnimation

Returns the “default value” for a type.

impl FromIterator<Frame> for SpriteSheetAnimation

fn from_iter<T: IntoIterator<Item = Frame>>(iter: T) -> Self

Creates a value from an iterator.

impl TypeUuid for SpriteSheetAnimation

const TYPE_UUID: Uuid