Struct AnimationState 

pub struct AnimationState { /* private fields */ }

Retained prepared-clip playback using Kit’s controllable executor clock. Controls are inherited from core::AnimationState; use now(cx) for them.

Implementations

impl AnimationState

pub fn new(initial: Target) -> Self

Creates a player at a static initial target. Retain it between renders.

pub fn now(&self, cx: &App) -> Duration

Current native timestamp for pause/play/seek/speed/restart controls. Returns zero before the first native frame; no system clock is mixed in.

pub fn frame( &mut self, animation: &Animation, window: &mut Window, cx: &App, ) -> Frame

Samples a prepared clip and schedules only while playing or delayed.

pub fn sample( &mut self, animation: &Animation, now: Duration, reduced_motion: bool, ) -> Frame

Samples an explicit epoch and returns a Kit-ready frame. Do not mix explicit timestamps with native frame/now on one player.

Methods from Deref<Target = AnimationState>

pub fn sample( &mut self, animation: &Animation, now: Duration, reduced_motion: bool, ) -> Frame

Samples a retained prepared clip; cloning an Animation preserves its identity. Rebuilding a clip intentionally restarts it. Reduced motion finishes even infinite clips.

pub fn pause(&mut self, now: Duration)

Pauses playback; call the host’s notify method after controls change.

pub fn play(&mut self, now: Duration)

Resumes playback.

pub fn stop(&mut self, now: Duration)

Stops at the current presentation. Use play to resume, or restart to reset.

pub fn seek(&mut self, time: Duration, now: Duration)

Seeks to a virtual playhead, including initial delay and repeats.

pub fn set_speed( &mut self, speed: f64, now: Duration, ) -> Result<(), AnimationError>

Changes playback speed; negative speed is supported after seeking forward.

pub fn restart(&mut self, now: Duration)

Restarts the same clip from its captured origin.

pub fn finish(&mut self)

Finishes immediately on the next sample, including an infinite clip.

pub fn completion(&mut self) -> Completion

A completion future for this run. Sampling drives it; replacement, restart, explicit cancellation and owner drop resolve Cancelled.

pub fn cancel(&mut self, now: Duration)

Pauses playback and cancels completion observers. play may resume the retained trajectory; a new observer can follow that resumed run.

pub fn iteration(&self) -> u64

Current repeat iteration, zero based.

pub fn is_complete(&self) -> bool

Whether the last sample reached its endpoint.

pub fn is_playing(&self) -> bool

Whether controls permit time to advance.

Trait Implementations

impl Debug for AnimationState

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

Formats the value using the given formatter.

impl Default for AnimationState

fn default() -> Self

Returns the “default value” for a type.

impl Deref for AnimationState

type Target = AnimationState

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for AnimationState

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.