Struct tetra::graphics::animation::Animation

pub struct Animation { /* fields omitted */ }

An animation, cycling between regions of a texture at a regular interval.

Calling advance within your draw method will drive the animation, switching the texture region once the specified time has passed.

Methods

impl Animation

pub fn new(
    texture: Texture,
    frames: Vec<Rectangle>,
    frame_length: Duration
) -> Animation

Creates a new animation.

pub fn advance(&mut self, ctx: &Context)

Advances the animation's timer, switching the texture region if required.

pub fn advance_by(&mut self, duration: Duration)

Advances the animation's timer by a specified amount, switching the texture region if required.

pub fn restart(&mut self)

Restarts the animation from the first frame.

pub fn texture(&self) -> &Texture

Returns a reference to the texture currently being used by the animation.

pub fn set_texture(&mut self, texture: Texture)

Sets the texture that will be used by the animation.

This method will not change the frame definitions or current state of the animation, so it can be used for e.g. swapping spritesheets. If you need to change the slicing for the new texture, call set_frames.

pub fn frames(&self) -> &[Rectangle]

Gets the sections of the texture being displayed for each frame of the animation.

pub fn set_frames(&mut self, new_frames: Vec<Rectangle>)

Sets the sections of the texture being displayed for each frame of the animation.

This method will reset the animation back to frame zero.

pub fn frame_length(&self) -> Duration

Gets the amount of time that each frame of the animation lasts for.

pub fn set_frame_length(&mut self, new_frame_length: Duration)

Sets the amount of time that each frame of the animation lasts for.

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 Drawable for Animation

fn draw<P>(&self, ctx: &mut Context, params: P) where
    P: Into<DrawParams>, 

Draws self to the screen (or a canvas, if one is enabled), using the specified parameters.