Struct EncodeOptions

#[non_exhaustive]
pub struct EncodeOptions {
    pub quality: Option<u8>,
    pub effort: Option<u8>,
}

Custom options when encoding pixel data into an encapsulated form.

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>

The quality of the output image as a number between 0 and 100, where 100 is the best quality that the encapsulated form can achieve and smaller values represent smaller data size with an increasingly higher error. It is ignored if the transfer syntax only supports lossless compression. If it does support lossless compression, it is expected that a quality of 100 results in a mathematically lossless encoding.

If this option is not specified, the output quality is decided automatically by the underlying adapter.

effort: Option<u8>

The amount of effort that the encoder may take to encode the pixel data, as a number between 0 and 100. If supported, higher values result in better compression, at the expense of more processing time. Encoders are not required to support this option. If this option is not specified, the actual effort is decided by the underlying adapter.

Implementations

impl EncodeOptions

pub fn new() -> Self

Trait Implementations

impl Clone for EncodeOptions

fn clone(&self) -> EncodeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodeOptions

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

Formats the value using the given formatter.

impl Default for EncodeOptions

fn default() -> EncodeOptions

Returns the “default value” for a type.