One Logo Pool Ball
ColorSync · IOS API REFERENCE

ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping

struct · iOS 27.0+ · SDK 27.1

struct ToneMapping

Headroom-adaptive tone mapping that adjusts HDR content to the display's available headroom. A tone mapping pairs a baseline headroom with a ``Method`` that describes how to map content above reference white.

Members (5)

init · iOS 27.0+

init

TypeScript
static init(baselineHeadroomStops: number, method?: ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping_Method): ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping
Swift declaration
init(baselineHeadroomStops: Float, method: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping.Method = .referenceWhiteBased) throws

Creates a headroom-adaptive tone mapping. - Parameters: - baselineHeadroomStops: The headroom of the source content in stops above reference white. Must be greater than or equal to `0`. - method: The tone-mapping method to apply. Defaults to ``Method/referenceWhiteBased``. - Throws: ``Error/negativeBaselineHeadroom(_:)`` if `baselineHeadroomStops` is negative.

get · iOS 27.0+

baselineHeadroomStops

TypeScript
get baselineHeadroomStops(): number
Swift declaration
var baselineHeadroomStops: Float

Baseline headroom in stops above reference white.

set · iOS 27.0+

baselineHeadroomStops

TypeScript
set baselineHeadroomStops(value: number)
Swift declaration
var baselineHeadroomStops: Float

Baseline headroom in stops above reference white.

get · iOS 27.0+

method

TypeScript
get method(): ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping_Method
Swift declaration
var method: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping.Method

The method used to tone map content above reference white.

set · iOS 27.0+

method

TypeScript
set method(value: ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform_ToneMapping_Method)
Swift declaration
var method: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform.ToneMapping.Method

The method used to tone map content above reference white.

Skipped declarations

No declarations were skipped in this snapshot.

All ColorSync types →