Struct EncoderOptions

pub struct EncoderOptions {
    pub anim_params: AnimParams,
    pub minimize_size: bool,
    pub kmin: isize,
    pub kmax: isize,
    pub allow_mixed: bool,
    pub verbose: bool,
    pub color_mode: ColorMode,
    pub encoding_config: Option<EncodingConfig>,
}

An options struct for Encoder instance

See also EncodingConfig for frame encoding configuration. Can be set globally or per-frame.

Fields

anim_params: AnimParams

Animation parameters

minimize_size: bool

If true, minimize the output size (slow). Implicitly disables key-frame insertion. Default false

kmin: isize

Minimum and maximum distance between consecutive key frames in the output. The library may insert some key frames as needed to satisfy this criteria. Note that these conditions should hold: kmax > kmin and kmin >= kmax / 2 + 1. Also, if kmax <= 0, then key-frame insertion is disabled; and if kmax == 1, then all frames will be key-frames (kmin value does not matter for these special cases). Defaults to zero

kmax: isize

allow_mixed: bool

If true, use mixed compression mode; may choose either lossy and lossless for each frame. Default false

verbose: bool

If true, print info and warning messages to stderr. Default false

color_mode: ColorMode

Input colorspace. ColorMode::Rgba by default

encoding_config: Option<EncodingConfig>

Default per-frame encoding config, optional. Can also be added per-frame by Encoder::add_frame_with_config

Trait Implementations

impl Clone for EncoderOptions

fn clone(&self) -> EncoderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for EncoderOptions

fn default() -> Self

Returns the “default value” for a type.