Struct GifEncoder 

pub struct GifEncoder { /* private fields */ }

Encodes a single-frame GIF.

Implementations

impl GifEncoder

pub const fn new() -> GifEncoder

An encoder with a full 256-colour palette and dithering.

pub fn with_colours(self, colours: usize) -> Result<GifEncoder, PixelsError>

An encoder aiming for at most colours palette entries.

Errors

Returns PixelsError::InvalidArgument outside 2..=256.

pub const fn without_dithering(self) -> GifEncoder

An encoder with dithering disabled.

pub fn with_dither(self, dither: f32) -> Result<GifEncoder, PixelsError>

An encoder diffusing dither of the quantization error, 0 (none) to 1 (full Floyd-Steinberg, the default), as sharp’s dither.

Errors

Returns PixelsError::InvalidArgument outside 0..=1.

pub fn from_options(options: &EncodeOptions) -> GifEncoder

An encoder configured from generic encode options.

GIF has no quality dial in the JPEG sense — it is lossless given a palette, and the palette is where all the loss lives. So quality is read as palette size, mapping 1..=100 onto 2..=256 entries, which is the axis that actually trades size for fidelity, unless EncodeOptions::colours gives the size outright. EncodeOptions::dither sets the dithering.

pub const fn colours(&self) -> usize

The palette size this encoder aims for.

Trait Implementations

impl Debug for GifEncoder

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

Formats the value using the given formatter.

impl Default for GifEncoder

fn default() -> GifEncoder

Returns the “default value” for a type.

impl Encoder for GifEncoder

fn write_header( &mut self, desc: &ImageDescriptor, _sink: &mut dyn Sink, ) -> Result<(), PixelsError>

Begin an image, writing any container header.

fn write_row( &mut self, row: &[u8], _sink: &mut dyn Sink, ) -> Result<(), PixelsError>

Write the next row, top to bottom.

fn finish(&mut self, sink: &mut dyn Sink) -> Result<(), PixelsError>

Finish the image, writing any trailer and flushing the sink.

fn set_icc_profile(&mut self, profile: Option<&[u8]>) -> Result<(), PixelsError>

Embed profile as the image’s ICC colour profile, or write none.

fn set_exif(&mut self, exif: Option<&[u8]>) -> Result<(), PixelsError>

Embed exif (TIFF-structured bytes, as Decoder::exif gives them) as the image’s EXIF block, or write none.

fn set_xmp(&mut self, xmp: Option<&[u8]>) -> Result<(), PixelsError>

Embed xmp, an XMP packet as Decoder::xmp gives it, or write none.

fn set_density(&mut self, density: Option<Density>) -> Result<(), PixelsError>

Record density as the image’s resolution, or write the format’s default.