Skip to main content

AnimFrame

Struct AnimFrame 

Source
pub struct AnimFrame {
    pub pixels: Vec<u8>,
    pub width: u32,
    pub height: u32,
    pub x: u32,
    pub y: u32,
    pub duration: u32,
    pub blend: BlendingMethod,
    pub dispose: DisposalMethod,
    pub mode: AnimFrameMode,
}
Expand description

A single animation frame to encode.

pixels is width * height * 4 interleaved 8-bit [R, G, B, A] bytes in scan-line order — the same flat layout crate::WebpFrame::rgba decodes to. x / y place the frame’s upper-left corner on the canvas (must be even per §2.7.1.1, since the on-disk field is the coordinate / 2).

Fields§

§pixels: Vec<u8>

width * height * 4 interleaved [R, G, B, A] bytes, scan order.

§width: u32

Frame width in pixels (≥ 1).

§height: u32

Frame height in pixels (≥ 1).

§x: u32

X coordinate of the frame’s upper-left corner on the canvas. Must be even (§2.7.1.1 stores x / 2).

§y: u32

Y coordinate of the frame’s upper-left corner on the canvas. Must be even (§2.7.1.1 stores y / 2).

§duration: u32

Display duration in 1-millisecond units (the §2.7.1.1 Frame Duration field).

§blend: BlendingMethod

§2.7.1.1 blending method (B bit).

§dispose: DisposalMethod

§2.7.1.1 disposal method (D bit).

§mode: AnimFrameMode

Per-frame compression mode.

Implementations§

Source§

impl AnimFrame

Source

pub fn new(width: u32, height: u32, pixels: Vec<u8>, duration: u32) -> Self

Construct a top-left, overwrite-blended, non-disposed lossless frame from a flat RGBA buffer — the common case.

BlendingMethod::Overwrite (§2.7.1.1 B = 1) is the default so a full-canvas frame round-trips byte-for-byte through crate::decode_webp’s canvas-compositing path. Callers that want §2.7.1.1 alpha-blending of a translucent sub-frame onto the existing canvas must build the struct literally and set blend: BlendingMethod::AlphaBlend.

Trait Implementations§

Source§

impl Clone for AnimFrame

Source§

fn clone(&self) -> AnimFrame

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnimFrame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for AnimFrame

Source§

impl PartialEq for AnimFrame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AnimFrame

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.