Struct gif::Decoder

pub struct Decoder<R: Read> { /* private fields */ }

GIF decoder

Implementations

impl<R> Decoder<R> where
    R: Read, 

pub fn new(reader: R) -> Result<Self, DecodingError>

Create a new decoder with default options.

pub fn build() -> DecodeOptions

Return a builder that allows configuring limits etc.

pub fn next_frame_info(
    &mut self
) -> Result<Option<&Frame<'static>>, DecodingError>

Returns the next frame info

pub fn read_next_frame(
    &mut self
) -> Result<Option<&Frame<'static>>, DecodingError>

Reads the next frame from the image.

Do not call Self::next_frame_info beforehand. Deinterlaces the result.

pub fn read_into_buffer(&mut self, buf: &mut [u8]) -> Result<(), DecodingError>

Reads the data of the current frame into a pre-allocated buffer.

Self::next_frame_info needs to be called beforehand. The length of buf must be at least Self::buffer_size. Deinterlaces the result.

pub fn fill_buffer(&mut self, buf: &mut [u8]) -> Result<bool, DecodingError>

Reads data of the current frame into a pre-allocated buffer until the buffer has been filled completely.

Self::next_frame_info needs to be called beforehand. Returns true if the supplied buffer could be filled completely. Should not be called after false had been returned.

pub fn buffer_size(&self) -> usize

Output buffer size

pub fn line_length(&self) -> usize

Line length of the current frame

pub fn palette(&self) -> Result<&[u8], DecodingError>

Returns the color palette relevant for the current (next) frame

pub fn global_palette(&self) -> Option<&[u8]>

The global color palette

pub fn width(&self) -> u16

Width of the image

pub fn height(&self) -> u16

Height of the image

pub fn bg_color(&self) -> Option<usize>

Index of the background color in the global palette