Skip to main content

GifEncoder

Struct GifEncoder 

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

Configures and runs GIF encoding.

use pltrs_codec::gif::{GifEncoder, GifFrame};
let black = vec![0, 0, 0, 255].repeat(16);
let white = vec![255; 4 * 16];
let frames = [
    GifFrame { pixels: &black, delay: 10 },
    GifFrame { pixels: &white, delay: 10 },
];
let gif = GifEncoder::new().encode(4, 4, &frames)?;
assert!(gif.starts_with(b"GIF89a"));

Implementations§

Source§

impl GifEncoder

Source

pub fn new() -> Self

An encoder looping forever.

Source

pub fn plays(self, plays: u16) -> Self

How often the animation plays (0, the default, loops forever).

Source

pub fn encode( &self, width: u32, height: u32, frames: &[GifFrame<'_>], ) -> Result<Vec<u8>, GifError>

Encodes width × height frames into a complete GIF file.

§Errors

When there are no frames, a side is out of GIF’s range or a frame has the wrong amount of pixel data.

Trait Implementations§

Source§

impl Clone for GifEncoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for GifEncoder

Source§

impl Debug for GifEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GifEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for GifEncoder

Source§

impl PartialEq for GifEncoder

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GifEncoder

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.