Struct Frame

pub struct Frame { /* private fields */ }

An animation frame containing data and metadata produced by Decoder

Getting metadata:

assert_eq!(frame.dimensions(), (400, 400));
assert_eq!(frame.color_mode(), ColorMode::Rgba);

Accessing frame data in raw ColorMode -encoded bytes:

assert_eq!(frame.data().len(), (400 * 400 * 4));
assert_eq!(frame.data()[0..4], [0, 0, 0, 255]);

If image feature is enabled, frame can be converted into [image::ImageBuffer]:

#[cfg(feature = "image")]
let image = frame.into_image().unwrap();
#[cfg(feature = "image")]
assert_eq!(image.dimensions(), (400, 400));
#[cfg(feature = "image")]
assert_eq!(image.height(), 400);
// image.save("frame.png");

Implementations

impl Frame

pub fn dimensions(&self) -> (u32, u32)

Get dimensions of the frame (width, height)

pub fn color_mode(&self) -> ColorMode

Get ColorMode of the frame (consistent accross frames)

pub fn timestamp(&self) -> i32

Get timestamp of the frame in milliseconds

pub fn data(&self) -> &[u8]

Get decoded frame data, size width * height * 4, pixels in ColorMode format

Trait Implementations

impl Debug for Frame

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

Formats the value using the given formatter.