ColorSync · IOS API REFERENCE

ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform

struct · iOS 27.0+ · SDK 27.1

struct ColorVolumeTransform

A color volume transform that maps HDR content into a display's dynamic range. A color volume transform can override the standard HDR reference white and, optionally, supply headroom-adaptive tone mapping.

Members (5)

get · iOS 27.0+

adaptiveToneMapping

TypeScript

get adaptiveToneMapping(): (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping) | null

Swift declaration

var adaptiveToneMapping: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping?

The adaptive tone mapping to apply, if any.

set · iOS 27.0+

adaptiveToneMapping

TypeScript

set adaptiveToneMapping(value: (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping) | null)

Swift declaration

var adaptiveToneMapping: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping?

The adaptive tone mapping to apply, if any.

init · iOS 27.0+

init

TypeScript

static init(customHDRReferenceWhite?: (number) | null, adaptiveToneMapping?: (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping) | null): ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform

Swift declaration

init(customHDRReferenceWhite: Float? = nil, adaptiveToneMapping: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping? = nil) throws

Creates a color volume transform. - Parameters: - customHDRReferenceWhite: A custom HDR reference white luminance in nits, or `nil` to use the standard 203-nit reference white. Must be greater than `0` when specified. - adaptiveToneMapping: The headroom-adaptive tone mapping to apply, or `nil` for none. - Throws: ``Error/invalidHDRReferenceWhite(_:)`` if `customHDRReferenceWhite` is less than or equal to `0`.

get · iOS 27.0+

customHDRReferenceWhite

TypeScript

get customHDRReferenceWhite(): (number) | null

Swift declaration

var customHDRReferenceWhite: Float?

A custom HDR reference white value, if specified.

set · iOS 27.0+

customHDRReferenceWhite

TypeScript

set customHDRReferenceWhite(value: (number) | null)

Swift declaration

var customHDRReferenceWhite: Float?

A custom HDR reference white value, if specified.

Skipped declarations

No declarations were skipped in this snapshot.

All ColorSync types →