Skip to main content

GifEncoder

Struct GifEncoder 

Source
pub struct GifEncoder { /* private fields */ }
Available on crate feature gif only.
Expand description

Builds an animated GIF from RGBA frames.

Buffer frames with Self::add_frame / Self::add_frame_owned, then Self::finish, or stream with Self::encode_iter. For writing directly to a file or socket, prefer GifWriter.

Implementations§

Source§

impl GifEncoder

Source

pub fn new(width: u32, height: u32, plays: u32) -> Self

New encoder; defaults enable dithering, dirty-rects, and local palettes.

Source

pub fn options(self, opts: GifOptions) -> Self

Replace every option at once.

Source

pub fn colors(self, n: u16) -> Self

Source

pub fn transparency(self, on: bool) -> Self

Source

pub fn alpha_threshold(self, t: u8) -> Self

Source

pub fn dither(self, on: bool) -> Self

Source

pub fn diff_rects(self, on: bool) -> Self

Source

pub fn palette_mode(self, mode: PaletteMode) -> Self

Source

pub fn quantizer(self, q: QuantizerKind) -> Self

Source

pub fn disposal(self, mode: DisposalMode) -> Self

Source

pub fn lossy(self, loss: u8) -> Self

Source

pub fn lzw_clear(self, mode: LzwClearMode) -> Self

Source

pub fn interlace(self, on: bool) -> Self

Source

pub fn comment(self, bytes: impl AsRef<[u8]>) -> Self

Source

pub fn add_frame_owned(&mut self, rgba: Vec<u8>, delay_num: u16, delay_den: u16)

Add a frame by moving RGBA bytes (no extra clone of the pixel buffer).

Source

pub fn add_frame(&mut self, rgba: &[u8], delay_num: u16, delay_den: u16)

Add a frame from a borrowed RGBA buffer (one copy into the encoder).

Source

pub fn finish(self) -> Vec<u8> ⓘ

Serialize all buffered frames.

Source

pub fn encode_iter<I>(self, frames: I) -> Vec<u8> ⓘ
where I: IntoIterator<Item = (Vec<u8>, u16, u16)>,

Encode an iterator of (rgba, delay_num, delay_den) frames.

With PaletteMode::Local this streams (keeps only the previous canvas). With PaletteMode::Global / PaletteMode::Auto it may buffer frames to build a shared palette.

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.