Struct webp_animation::prelude::Decoder

source ·

pub struct Decoder<'a> { /* private fields */ }

Expand description

A decoder for webp animation data

Will take a webp buffer, and try to decode it to frame(s)

use webp_animation::prelude::*;

let buffer = std::fs::read("./data/animated.webp").unwrap();
let decoder = Decoder::new(&buffer).unwrap();

for frame in decoder.into_iter() {
  assert_eq!(frame.dimensions(), (400, 400));
  assert_eq!(frame.data().len(), 400 * 400 * 4); // w * h * rgba
}

See also documentation for the item produced by iterator: Frame

If image feature is enabled, frames can be produced in [image::ImageBuffer] format:

use webp_animation::prelude::*;
for frame in decoder.into_iter() {
  #[cfg(feature = "image")]
  assert_eq!(frame.into_image().unwrap().dimensions(), (400, 400));
}

Implementations§

source §

impl<'a> Decoder<'a>

source

pub fn new(buffer: &'a [u8]) -> Result<Self, Error>

Construct a new decoder from webp buffer

Returns an Error in case of a decoding failure (e.g. malformed input)

let buffer = std::fs::read("./data/animated.webp").unwrap();
let decoder = Decoder::new(&buffer).unwrap();

source

pub fn new_with_options(
buffer: &'a [u8],
options: DecoderOptions
) -> Result<Self, Error>

Construct a new decoder from webp buffer

Returns an Error in case of a decoding failure (e.g. malformed input)

let buf = std::fs::read("./data/animated.webp").unwrap();
let decoder = Decoder::new_with_options(&buf, DecoderOptions {
  use_threads: false,
  color_mode: ColorMode::Bgra
}).unwrap();

source

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

Returns dimensions for webp frames (width, height)

let buffer = std::fs::read("./data/animated.webp").unwrap();
let decoder = Decoder::new(&buffer).unwrap();
assert_eq!(decoder.dimensions(), (400, 400));