Struct AvifEncoderOptions 

#[non_exhaustive]
pub struct AvifEncoderOptions {
    pub quality: Option<u8>,
    pub q: Option<u8>,
    pub alpha_q: Option<u8>,
    pub chroma: StillChroma,
    pub premultiplied: bool,
    pub speed: EncodeSpeed,
    pub threads: Option<usize>,
}

The registry encoder’s option schema (see the module docs): the typed form of the quality / q / alpha_q / chroma / premultiplied codec options, parsed strictly at construction through oxideav_core::parse_options (an unknown key or a malformed value is InvalidData).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

quality: Option<u8>

quality 0..=100 (100 = lossless); None when not given.

q: Option<u8>

Explicit colour base_q_idx (q); wins over quality.

alpha_q: Option<u8>

Explicit alpha base_q_idx (alpha_q); wins over quality.

chroma: StillChroma

Chroma layout for a lossy packed-RGB encode (chroma).

premultiplied: bool

Emit the prem iref (premultiplied).

speed: EncodeSpeed

AV1 search effort (speed).

threads: Option<usize>

Explicit worker threads (threads); None = the execution context’s budget.

Implementations

impl AvifEncoderOptions

pub fn new() -> Self

The defaults (lossless, 4:2:0 for lossy RGB, straight alpha).

pub fn with_quality(self, quality: Option<u8>) -> Self

Setter: replace quality.

pub fn with_q(self, q: Option<u8>) -> Self

Setter: replace q.

pub fn with_alpha_q(self, alpha_q: Option<u8>) -> Self

Setter: replace alpha_q.

pub fn with_chroma(self, chroma: StillChroma) -> Self

Setter: replace chroma.

pub fn with_premultiplied(self, premultiplied: bool) -> Self

Setter: replace premultiplied.

pub fn with_speed(self, speed: EncodeSpeed) -> Self

Setter: replace speed.

pub fn with_threads(self, threads: Option<usize>) -> Self

Setter: replace threads (None = the execution context’s budget).

pub fn from_params(params: &CodecParameters) -> Result<Self>

Strict parse of a parameter set’s option bag.

pub fn resolve(&self) -> EncodeOptions

The still-encoder tuning these options resolve to: q else the quality mapping else lossless for the colour planes, the same for alpha with alpha_q; chroma / premultiplied / speed as given; threads as given, else 1 (the encoder fills the execution context’s budget in per frame).

Trait Implementations

impl Clone for AvifEncoderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodecOptionsStruct for AvifEncoderOptions

const SCHEMA: &'static [OptionField]

Static schema listing every option key this struct consumes, with its declared kind, default, and help text.

fn apply(&mut self, key: &str, value: &OptionValue) -> Result<()>

Write one coerced value into the struct. key is guaranteed to be present in SCHEMA and value to match the declared OptionKind when called via parse_options.

impl Copy for AvifEncoderOptions

impl Debug for AvifEncoderOptions

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

Formats the value using the given formatter.

impl Default for AvifEncoderOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AvifEncoderOptions

impl PartialEq for AvifEncoderOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AvifEncoderOptions