Struct kludgine::sprite::Sprite

pub struct Sprite {
    pub animations: SpriteAnimations,
    /* private fields */
}

A sprite is a renderable graphic with optional animations.

Cloning a sprite is cheap. When cloning, the animations will be shared between all clones of the sprite, but each sprite will track its current frame/tag independently.

Fields

animations: SpriteAnimations

The animations that form this sprite.

Implementations

impl Sprite

pub const fn new(animations: SpriteAnimations) -> Self

Returns a new sprite with animations.

pub fn merged<S: Into<String>, I: IntoIterator<Item = (S, Self)>>( source: I ) -> Self

For merging multiple Sprites that have no tags within them

pub fn single_frame(texture: SharedTexture) -> Self

Creates an instance from a texture. This creates a SpriteAnimation with no tag and a single frame.

pub fn load_aseprite_json( raw_json: &str, texture: impl Into<ShareableTexture> ) -> Result<Self, SpriteParseError>

Loads Aseprite JSON export format, when using the correct settings.

For the JSON data, use the Hash export option (default), and use either spaces or underscores (_) inbetween the fields in the name. Ensure {frame} is the last field in the name before the extension. E.g., {tag}_{frame}.{extension}

Errors

Returns an error when raw_json does not match the expected format.

pub fn set_current_tag<S: Into<String>>( &mut self, tag: Option<S> ) -> Result<(), InvalidSpriteTag>

Sets the current tag for the animation. If the tag currently matches, nothing will happen. If it is a new tag, the current frame and animation direction will be switched to the values from the new tag.

Errors

Returns an error if tag is not a valid animation tag.

pub fn current_tag(&self) -> Option<&str>

Returns the current tag.

pub fn get_frame( &mut self, elapsed: Option<Duration> ) -> Result<SpriteSource, InvalidSpriteTag>

Gets the current frame after advancing the animation for elapsed duration. If you need to invoke this multiple times in a single frame, pass None on subsequent calls. In general, you should clone sprites rather than reuse them. Kludgine ensures that your texture and animation data will be shared and not cloned.

Errors

Returns an error the current animation tag does not match any defined animation.

pub fn current_frame(&self) -> Result<SpriteSource, InvalidSpriteTag>

Retrieve the current animation frame, if set and valid.

Errors

Returns an error the current animation tag does not match any defined animation.

pub fn remaining_frame_duration( &self ) -> Result<Option<Duration>, InvalidSpriteTag>

Returns the amount of time remaining until the next frame is due to be shown for this sprite. Can be used to calculate redraws more efficiently if you’re not rendering at a constant framerate.

Errors

Returns an error the current animation tag does not match any defined animation.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl From<SpriteAnimations> for Sprite

fn from(animations: SpriteAnimations) -> Self

Converts to this type from the input type.