Struct Animation 

pub struct Animation {
    pub duration: Duration,
    pub delay: Duration,
    pub repeat: AnimationRepeat,
    pub easing: Rc<dyn Fn(f32) -> f32>,
    pub max_fps: Option<f32>,
}

An animation that can be applied to an element.

Fields

duration: Duration

The amount of time for which this animation should run. A zero duration completes immediately after the delay, including for AnimationRepeat::Forever.

delay: Duration

The amount of time to wait before the animation starts. The delay applies once, when the animation begins; it is not repeated between passes of a repeating animation.

repeat: AnimationRepeat

Whether and how this animation repeats when a pass finishes

easing: Rc<dyn Fn(f32) -> f32>

A function that maps normalized time to an animated value. The result may exceed 0..1 for easing functions that overshoot.

max_fps: Option<f32>

The maximum number of times per second this animation re-renders. When None, the animation re-renders on every frame.

Implementations

impl Animation

pub fn new(duration: Duration) -> Self

Create a new animation with the given duration. By default the animation will only run once and will use a linear easing function.

pub fn repeat(self) -> Self

Set the animation to loop forever when it finishes.

pub fn repeat_n(self, times: u32) -> Self

Set the animation to run the given number of passes in total, then hold its final value. Zero is treated as one pass.

pub fn with_repeat(self, repeat: AnimationRepeat) -> Self

Set how the animation repeats when a pass finishes.

pub fn with_delay(self, delay: Duration) -> Self

Wait for the given duration before the animation starts. While the delay elapses the animation holds its initial value (easing(0)) and no animation frames are requested. In an animation chain (see AnimationExt::with_animations) the delay of each animation counts from the moment that animation begins.

pub fn with_easing(self, easing: impl Fn(f32) -> f32 + 'static) -> Self

Sets the easing function used to map normalized time to an animated value.

The output is not clamped, allowing physical easing functions such as springs to overshoot.

pub fn with_max_fps(self, max_fps: f32) -> Self

Limit how often this animation re-renders. Instead of re-rendering on every frame, the animation schedules its next render 1 / max_fps seconds after the current one. Values that are not finite and positive are ignored.

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.