Struct benimator::Animation

pub struct Animation { /* private fields */ }

Definition of an animation

Deserialization format

# The mode can be one of: 'Once', 'Repeat', 'PingPong'
# or '!RepeatFrom: n' (where 'n' is the frame-index to repeat from)
# The default is 'Repeat'
mode: PingPong
frames:
  - index: 0 # index in the sprite sheet for that frame
    duration: 100 # duration of the frame in milliseconds
  - index: 1
    duration: 100
  - index: 2
    duration: 120

There is also a short-hand notation if all frames have the same duration:

fps: 12 # may be substitued by 'frame_duration' of 'total_duration'
frames: [0, 1, 2] # sequence of frame indices

Implementations

impl Animation

pub fn from_frames(frames: impl IntoIterator<Item = Frame>) -> Self

Create a new animation from frames

pub fn from_indices( indices: impl IntoIterator<Item = usize>, frame_rate: FrameRate ) -> Self

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

Examples

// From an index range
let animation = Animation::from_indices(0..=5, FrameRate::from_fps(12.0));

// From an index array
let animation = Animation::from_indices([1, 2, 3, 4], FrameRate::from_fps(12.0));

// Reversed animation
let animation = Animation::from_indices((0..5).rev(), FrameRate::from_fps(12.0));

// Chained ranges
let animation = Animation::from_indices((0..3).chain(10..15), FrameRate::from_fps(12.0));

Note, the FrameRate may be created from fps, frame-duration and animation-duration

To use different non-uniform frame-duration, see from_frames

Panics

Panics if the duration is zero

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 Animation

fn clone(&self) -> Animation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Animation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<Frame> for Animation

fn extend<T: IntoIterator<Item = Frame>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Frame> for Animation

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

Creates a value from an iterator.

impl PartialEq<Animation> for Animation

fn eq(&self, other: &Animation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Animation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Animation

impl StructuralEq for Animation

impl StructuralPartialEq for Animation