Struct zune_core::options::EncoderOptions

pub struct EncoderOptions {
    pub width: usize,
    pub height: usize,
    pub colorspace: ColorSpace,
    pub quality: u8,
    pub depth: BitDepth,
}

Fields

width: usize

The image width

This is the width the image will be encoded in

Note

Images have different width and height limit, encoding an image larger than that limit is an error.

Consult with your favourite image codec on its limit

height: usize

The image height

This is the height the image will be encoded in.

Note

Images have different width and height limit, encoding an image larger than that limit is an error.

Consult with your favourite image codec on its limit

colorspace: ColorSpace

The colorspace the pixels are in.

Note

Each encoder has different set of supported colorspaces.

Check with your favourite image codec on its limit.

quality: u8

The quality expected for the image

This has different results depending on encoder.

• lossy encoders: Higher values, good visual quality/larger file, lower values bad visual quality/smaller file.
• lossless encoders: Higher values, more encoding time/smaller image, lower value, less encoding time/image.

Though this is not respected by some encoders, e.g ppm doesn’t have a notion of quality.

depth: BitDepth

The bit depth of the data

The data is expected in native endian the encoder will convert the data to whatever endian is needed by the format.

• Respected by: png,ppm

Implementations

impl EncoderOptions

pub const fn get_width(&self) -> usize

pub const fn get_height(&self) -> usize

pub const fn get_depth(&self) -> BitDepth

pub const fn get_quality(&self) -> u8

pub const fn get_colorspace(&self) -> ColorSpace

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 Debug for EncoderOptions

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

Formats the value using the given formatter.

impl Default for EncoderOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for EncoderOptions