Enum OutputResolution 

pub enum OutputResolution {
    Original,
    Width2560,
    Width1080,
    Custom(u32),
}

Controls the output resolution applied before AVIF encoding.

Set this on Config via Config::output_resolutions to produce one or more outputs at different sizes from a single decode pass.

Downscale-only

When the decoded image is already at or below the target width the pixels are passed through unchanged — img4avif never upscales.

Aspect ratio

The height is always scaled proportionally so the image is never cropped or distorted.

Example

use img4avif::{Config, Converter, OutputResolution};

// Produce only the 1080-wide variant.
let config = Config::default()
    .output_resolutions(vec![OutputResolution::Width1080]);
let converter = Converter::new(config)?;
let avif_1080 = converter.convert(&std::fs::read("photo.jpg")?)?;
std::fs::write("photo_1080.avif", avif_1080)?;

Variants

Original

Preserve the original image dimensions (no resize).

Width2560

Shrink so the width is at most 2560 pixels, preserving the aspect ratio. Images already ≤ 2560 px wide are passed through unchanged.

Width1080

Shrink so the width is at most 1080 pixels, preserving the aspect ratio. Images already ≤ 1080 px wide are passed through unchanged.

Custom(u32)

Shrink so the width is at most the given number of pixels, preserving the aspect ratio. Images already at or below this width are passed through unchanged.

A width of 0 is treated the same as Original — the image is returned at its full size without any resizing. This is a deliberate design choice that makes it safe to derive a target width from arithmetic that could produce zero; callers that want a hard error on zero should validate the value before constructing this variant.

Trait Implementations

impl Clone for OutputResolution

fn clone(&self) -> OutputResolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputResolution

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

Formats the value using the given formatter.

impl Hash for OutputResolution

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OutputResolution

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for OutputResolution

impl Eq for OutputResolution

impl StructuralPartialEq for OutputResolution