Skip to main content

GifDecoder

oximedia_codec::gif

Struct GifDecoder 

Source 
pub struct GifDecoder { /* private fields */ }
Expand description

GIF decoder for reading GIF89a files.

Supports:

  • Single images and animations
  • Transparency
  • Interlaced images
  • Global and local color tables

Implementations§

Source§

impl GifDecoder

Source

pub fn new(data: &[u8]) -> CodecResult<Self>

Create a new GIF decoder from data.

§Arguments
  • data - GIF file data
§Errors

Returns error if data is not a valid GIF file.

Source

pub fn width(&self) -> u32

Get canvas width.

Source

pub fn height(&self) -> u32

Get canvas height.

Source

pub fn frame_count(&self) -> usize

Get number of frames.

Source

pub fn loop_count(&self) -> u16

Get loop count (0 = infinite).

Source

pub fn screen_descriptor(&self) -> &LogicalScreenDescriptor

Get the logical screen descriptor.

Source

pub fn global_color_table(&self) -> &[u8] ⓘ

Get the global color table.

Source

pub fn frame_info(&self, index: usize) -> CodecResult<&GifFrame>

Get frame information.

§Arguments
  • index - Frame index
§Errors

Returns error if index is out of range.

Source

pub fn decode_frame(&self, index: usize) -> CodecResult<VideoFrame>

Decode a specific frame.

§Arguments
  • index - Frame index to decode
§Errors

Returns error if decoding fails or index is out of range.

Source

pub fn decode_all_frames(&self) -> CodecResult<Vec<VideoFrame>>

Decode all frames.

§Errors

Returns error if decoding fails.

Source

pub fn frame_delay_ms(&self, index: usize) -> CodecResult<u32>

Get frame delay time in milliseconds.

§Arguments
  • index - Frame index
§Errors

Returns error if index is out of range.

Source

pub fn frame_has_transparency(&self, index: usize) -> CodecResult<bool>

Check if frame has transparency.

§Arguments
  • index - Frame index
§Errors

Returns error if index is out of range.

Source

pub fn frame_disposal_method(&self, index: usize) -> CodecResult<DisposalMethod>

Get frame disposal method.

§Arguments
  • index - Frame index
§Errors

Returns error if index is out of range.

Source

pub fn is_animated(&self) -> bool

Check if this is an animated GIF.

Source

pub fn total_duration_ms(&self) -> u32

Get total animation duration in milliseconds.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.