Skip to main content

GainMapConfig

ultrahdr_core::gainmap::compute

Struct GainMapConfig

pub struct GainMapConfig {
    pub scale_factor: u8,
    pub gamma: f32,
    pub multi_channel: bool,
    pub min_boost: f32,
    pub max_boost: f32,
    pub base_offset: f32,
    pub alternate_offset: f32,
    pub base_hdr_headroom: f32,
    pub alternate_hdr_headroom: f32,
}

Expand description

Configuration for gain map computation.

Boost values (min_boost, max_boost) are in linear domain for ergonomics — humans think “4× brighter” not “log2(4)=2”. These are converted to log2 when producing GainMapMetadata.

Fields§

§scale_factor: u8

Scale factor for gain map (1 = same size as image, 4 = 1/4 size).

§gamma: f32

Gamma to apply to the gain map encoding.

§multi_channel: bool

Use multi-channel (RGB) gain map instead of single-channel luminance.

§min_boost: f32

Minimum gain (linear). 1.0 = no darkening, 0.5 = allow 2× darker.

§max_boost: f32

Maximum gain (linear). HDR peak / SDR peak. e.g. 6.0 = ~2.5 stops.

§base_offset: f32

Offset for base (SDR) values to avoid division by zero. Linear domain.

§alternate_offset: f32

Offset for alternate (HDR) values. Linear domain.

§base_hdr_headroom: f32

Minimum display boost (linear). For metadata headroom.

§alternate_hdr_headroom: f32

Maximum display boost (linear). For metadata headroom.

Trait Implementations§

impl Clone for GainMapConfig

fn clone(&self) -> GainMapConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for GainMapConfig

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

Formats the value using the given formatter. Read more

impl Default for GainMapConfig

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for GainMapConfig

impl RefUnwindSafe for GainMapConfig

impl Send for GainMapConfig

impl Sync for GainMapConfig

impl Unpin for GainMapConfig

impl UnsafeUnpin for GainMapConfig

impl UnwindSafe for GainMapConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.