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_yaml_str(yaml: &str) -> Result<Self, AnimationParseError>

Available on crate features unstable-load-from-file and yaml only.

Parse content of a yaml string representing the animation

Yaml schema

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:

frame_duration: 100
frames: [0, 1, 2] # sequence of frame indices

Errors

Returns an error if the content is not a valid yaml representation of an animation

pub fn from_yaml_bytes(yaml: &[u8]) -> Result<Self, AnimationParseError>

Available on crate features unstable-load-from-file and yaml only.

Parse content of yaml bytes representing the animation

Yaml schema

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:

frame-duration: 100
frames: [0, 1, 2] # sequence of frame indices

Errors

Returns an error if the content is not a valid yaml representation of an animation

pub fn from_ron_str(ron: &str) -> Result<Self, AnimationParseError>

Available on crate features unstable-load-from-file and ron only.

Parse content of a ron file represenging the animation

Schema

(
  // 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: Some(100), // duration of the frame in milliseconds
    ),
    (index: 1, duration: Some(100)),
    (index: 2, duration: Some(120)),
  ]
)

Errors

Returns an error if the content is not a valid ron representation of an animation

pub fn from_ron_bytes(ron: &[u8]) -> Result<Self, AnimationParseError>

Available on crate features unstable-load-from-file and ron only.

Parse content of a ron file represenging the animation

Schema

(
  // 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),
  ]
)

Errors

Returns an error if the content is not a valid ron representation of an animation

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

Panics

Panics if the duration is zero

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

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 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<'de> Deserialize<'de> for SpriteSheetAnimation

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

Deserialize this value from the given Serde deserializer.

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 = _