Struct benimator::SpriteSheetAnimationLoader

pub struct SpriteSheetAnimationLoader { /* private fields */ }

Loader of animation file

It is not necessary to use this directly if you are using the bevy plugin, as it is already registered as an asset loader.

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

Ron 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)),
  ]
)

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

(
  frame_duration: 100,
  frames: [0, 1, 2, 3, 4],
)

Implementations

impl SpriteSheetAnimationLoader

pub fn supported_extensions(&self) -> &[&str]

Available on crate feature load-from-file only.

Returns supported extensions

SpriteSheetAnimationLoader::load can only succeed one of the returned extensions

pub fn load(
    &self,
    extension: &str,
    data: &[u8]
) -> Result<SpriteSheetAnimation, AnimationParseError>

Available on crate feature load-from-file only.

Load animation from file content

Errors

Returns an error if the extension is not supported or if the data content is not valid for that extension

Trait Implementations

impl AssetLoader for SpriteSheetAnimationLoader

Available on crate feature load-from-file only.

fn load<'a>(
    &'a self,
    bytes: &'a [u8],
    load_context: &'a mut LoadContext<'_>
) -> BoxedFuture<'a, Result<(), Error>>

Processes the asset in an asynchronous closure.

fn extensions(&self) -> &[&str]

Returns a list of extensions supported by this asset loader, without the preceding dot.

impl Debug for SpriteSheetAnimationLoader

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

Formats the value using the given formatter.

impl Default for SpriteSheetAnimationLoader

fn default() -> Self

Returns the “default value” for a type.