Struct Animation 

#[non_exhaustive]
pub struct Animation {
    pub frame_count: u32,
    pub loop_count: u32,
    pub frame_durations_ms: Vec<u32>,
}

How an animated image plays: its frames and their timing.

Reported by Decoder::animation for a file with more than one frame. The pipeline processes the first frame; this describes the source, so a caller can see it is animated and decide what to do (pass it through, refuse it, or take the still).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

frame_count: u32

Frames in the animation, always two or more.

loop_count: u32

How many times it plays; 0 means forever, as in GIF and WebP.

frame_durations_ms: Vec<u32>

How long each frame shows, in milliseconds, in order.

Implementations

impl Animation

pub fn new(frame_durations_ms: Vec<u32>, loop_count: u32) -> Option<Self>

An animation of the given frame durations, playing loop_count times (0 for forever). None for fewer than two frames, which is a still image.

pub fn duration_ms(&self) -> u64

The total time one play-through takes, in milliseconds.

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.

impl Debug for Animation

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

Formats the value using the given formatter.

impl Eq for Animation

impl Hash for Animation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Animation

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Animation