Struct GainMapInfo 

#[non_exhaustive]
pub struct GainMapInfo {
    pub params: GainMapParams,
    pub width: u32,
    pub height: u32,
    pub channels: u8,
    pub bit_depth: u8,
    pub alternate_cicp: Option<Cicp>,
    pub alternate_icc: Option<Arc<[u8]>>,
}

Complete gain map description: parameters + image properties + alternate color.

Returned from probing when a gain map is detected. Contains enough information to describe the gain map without carrying pixel data.

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.

params: GainMapParams

ISO 21496-1 gain map parameters.

width: u32

Gain map image width in pixels.

height: u32

Gain map image height in pixels.

channels: u8

Number of gain map channels: 1 (luminance) or 3 (per-channel RGB).

bit_depth: u8

Bit depth of the gain map image’s samples: 8, 10, or 12.

The gain-map image can be deeper than 8-bit on AVIF/JXL, and carriers that declare a sample depth (AVIF av1C, the JXL jhgm codestream) need it. Defaults to 8 — the UltraHDR / JPEG-MPF norm.

alternate_cicp: Option<Cicp>

CICP color description of the alternate (typically HDR) rendition.

alternate_icc: Option<Arc<[u8]>>

ICC profile of the alternate rendition.

Implementations

impl GainMapInfo

pub fn new(params: GainMapParams, width: u32, height: u32, channels: u8) -> Self

Create with required fields. bit_depth defaults to 8 and the optional alternate-color fields to None; set them with the builders.

pub fn with_bit_depth(self, bit_depth: u8) -> Self

Set the gain map image’s sample bit depth (8, 10, or 12). Defaults to 8.

pub fn with_alternate_cicp(self, cicp: Cicp) -> Self

Set the alternate rendition’s CICP color description.

pub fn with_alternate_icc(self, icc: impl Into<Arc<[u8]>>) -> Self

Set the alternate rendition’s ICC profile.

Trait Implementations

impl Clone for GainMapInfo

fn clone(&self) -> GainMapInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GainMapInfo

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

Formats the value using the given formatter.

impl PartialEq for GainMapInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GainMapInfo