Struct ColorContext 

#[non_exhaustive]
pub struct ColorContext {
    pub icc: Option<Arc<[u8]>>,
    pub cicp: Option<Cicp>,
    pub diffuse_white: Option<DiffuseWhite>,
}

Color space metadata for pixel data.

Bundles ICC profile bytes and/or CICP parameters into a single shareable context. Carried via Arc on pixel slices and pipeline sources so color metadata travels with pixel data without per-strip cloning overhead.

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.

icc: Option<Arc<[u8]>>

Raw ICC profile bytes.

cicp: Option<Cicp>

CICP parameters (ITU-T H.273).

diffuse_white: Option<DiffuseWhite>

Absolute-luminance anchor: the cd/m² (nits) that a relative-linear sample value of 1.0 represents. None means unsignaled — consumers default to DiffuseWhite::BT2408 (203 nits, the cross-vendor convention). Travels with the pixels so the HDR converter can map relative-linear light to absolute luminance for PQ/HLG encode and tone-mapping.

Implementations

impl ColorContext

pub fn from_icc(icc: impl Into<Arc<[u8]>>) -> ColorContext

Create from an ICC profile.

pub fn from_cicp(cicp: Cicp) -> ColorContext

Create from CICP parameters.

pub fn with_diffuse_white(self, white: DiffuseWhite) -> ColorContext

Attach an absolute-luminance anchor — the nits that relative-linear 1.0 represents — returning the updated context.

Set this on an HDR working buffer (e.g. after gain-map reconstruction, where the anchor is DiffuseWhite::BT2408 = 203) so downstream conversion can map relative-linear light to absolute cd/m² for PQ/HLG encode and tone-mapping.

pub fn from_icc_and_cicp(icc: impl Into<Arc<[u8]>>, cicp: Cicp) -> ColorContext

👎Deprecated since 0.2.6:

use from_icc() or from_cicp(); roundtrip metadata belongs on ColorOrigin

Create from both ICC and CICP.

Deprecated: Codecs should populate only the authoritative field — use from_icc() or from_cicp(). Roundtrip metadata belongs on ColorOrigin, not ColorContext.

pub fn as_profile_source(&self) -> Option<ColorProfileSource<'_>>

Get a ColorProfileSource reference for CMS integration.

Returns ICC if present, otherwise CICP. Returns None when neither is present.

Codecs should populate only the authoritative field on ColorContext at decode time, using ColorAuthority on ColorOrigin to determine which. When only one field is set, this method returns it.

pub fn transfer_function(&self) -> TransferFunction

Derive transfer function from CICP (or Unknown if no CICP).

pub fn is_srgb(&self) -> bool

True if this describes sRGB (either via CICP or trivially).

Trait Implementations

impl Clone for ColorContext

fn clone(&self) -> ColorContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorContext

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

Formats the value using the given formatter.

impl Default for ColorContext

fn default() -> ColorContext

Returns the “default value” for a type.

impl Eq for ColorContext

impl PartialEq for ColorContext

fn eq(&self, other: &ColorContext) -> 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 StructuralPartialEq for ColorContext