Struct DitherConfig

Source

pub struct DitherConfig {
    pub mode: DitherMode,
    pub serpentine: bool,
    pub exposure: f64,
    pub saturation: f64,
    pub shadows: f64,
    pub highlights: f64,
    pub tone: ToneCompression,
    pub gamut: GamutCompression,
}

Expand description

Configuration for dither(). All fields have sensible defaults.

Construct with struct-update syntax:

dither(&img, palette, DitherConfig { mode: DitherMode::Burkes, ..Default::default() });

Pre-processing pipeline (applied in order, each step is a no-op at its identity value): exposure → saturation → shadows/highlights → tone → gamut → dither.

Fields§

§mode: DitherMode

Dithering algorithm.

§serpentine: bool

Use serpentine scanning for error diffusion (alternates row direction). Ignored for None and Ordered.

§exposure: f64

Linear-RGB exposure multiplier. 1.0 = no change, 2.0 = +1 stop, 0.5 = -1 stop.

§saturation: f64

OKLab saturation multiplier. 1.0 = no change, 0.0 = grayscale, >1.0 = boost. Hue-preserving.

§shadows: f64

Shadow lift strength (lower-half S-curve). 0.0 = identity, 1.0 = strong lift.

§highlights: f64

Highlight compression strength (upper-half S-curve). 0.0 = identity, 1.0 = strong.

§tone: ToneCompression

Dynamic-range compression. Auto = histogram-based; Fixed(s) = manual blend strength.

§gamut: GamutCompression

Gamut compression. Auto = full strength on out-of-gamut; Fixed(s) = manual.

Trait Implementations§

Source §

impl Clone for DitherConfig

Source §

fn clone(&self) -> DitherConfig

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for DitherConfig

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for DitherConfig

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl PartialEq for DitherConfig

Source §

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

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

1.0.0 (const: unstable) · Source§

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

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

Source §

impl StructuralPartialEq for DitherConfig

Auto Trait Implementations§

§

impl UnwindSafe for DitherConfig

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §