Skip to main content

Animation

Struct Animation 

Source
pub struct Animation {
    pub name: String,
    pub frame_size: Vec2,
    pub frames: Vec<AnimationFrame>,
    pub speed: f32,
    pub looping: bool,
    pub ping_pong: bool,
    pub offset: Vec2,
}
Expand description

A single animation defined from a sprite sheet.

Fields§

§name: String

Human-readable name (e.g., “idle”, “run”, “attack”).

§frame_size: Vec2

Region of the sprite sheet: (x, y, width, height) per frame in pixels.

§frames: Vec<AnimationFrame>

Frames in this animation (indices into the sprite sheet row).

§speed: f32

Playback speed (1.0 = normal, 2.0 = double speed).

§looping: bool

Whether to loop.

§ping_pong: bool

Whether to ping-pong (play forward then backward).

§offset: Vec2

Offset from the sprite’s position (for attack effects, etc.).

Implementations§

Source§

impl Animation

Source

pub fn from_row( name: &str, row: u32, start_col: u32, end_col: u32, frame_duration: f32, ) -> Self

Create a simple animation with evenly-spaced frames in a single row.

  • name — animation name
  • row — sprite sheet row
  • start_col — first column (inclusive)
  • end_col — last column (inclusive)
  • frame_duration — seconds per frame
Source

pub fn with_frame_size(self, w: f32, h: f32) -> Self

Builder: set frame size.

Source

pub fn with_speed(self, speed: f32) -> Self

Builder: set speed.

Source

pub fn with_looping(self, looping: bool) -> Self

Builder: set looping.

Source

pub fn with_ping_pong(self) -> Self

Builder: set ping-pong.

Source

pub fn with_offset(self, x: f32, y: f32) -> Self

Builder: set offset.

Source

pub fn with_frame_event(self, frame_index: usize, event: &str) -> Self

Add an event to a specific frame.

Source

pub fn total_duration(&self) -> f32

Total duration of the animation in seconds.

Source

pub fn frame_count(&self) -> usize

Number of frames.

Trait Implementations§

Source§

impl Clone for Animation

Source§

fn clone(&self) -> Animation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Animation

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.