Skip to main content

OwnedAnimationFrame

Struct OwnedAnimationFrame 

Source
#[non_exhaustive]
pub struct OwnedAnimationFrame { /* private fields */ }
Expand description

A composited full-canvas animation frame with owned pixel data.

Produced by AnimationFrame::to_owned_frame() or AnimationFrameDecoder::render_next_frame_owned().

Implementations§

Source§

impl OwnedAnimationFrame

Source

pub fn new(pixels: PixelBuffer, duration_ms: u32, frame_index: u32) -> Self

Create an owned frame from a PixelBuffer.

Source

pub fn pixels(&self) -> PixelSlice<'_>

Borrow the pixel data as a PixelSlice.

Source

pub fn into_buffer(self) -> PixelBuffer

Take the pixel buffer, consuming this frame.

Source

pub fn duration_ms(&self) -> u32

Frame duration in milliseconds.

Source

pub fn frame_index(&self) -> u32

Displayed frame index (0-based).

Source

pub fn as_animation_frame(&self) -> AnimationFrame<'_>

Borrow as a AnimationFrame.

Source

pub fn with_extras<T: Any + Send + Sync + 'static>(self, extras: T) -> Self

Attach a typed extension value (e.g., per-frame codec metadata).

Multiple independently-typed values can be stored.

Source

pub fn extras<T: Any + Send + Sync + 'static>(&self) -> Option<&T>

Borrow a typed extension value if present.

Source

pub fn take_extras<T: Any + Send + Sync + 'static>(&mut self) -> Option<T>

Remove and return a typed extension value.

Returns Some(T) only when this is the sole Arc reference to the value. Returns None if the type is not present or other references exist.

Source

pub fn extensions(&self) -> &Extensions

Access the full extension map.

Source

pub fn extensions_mut(&mut self) -> &mut Extensions

Mutable access to the full extension map.

Trait Implementations§

Source§

impl Debug for OwnedAnimationFrame

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> 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, 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.