One Logo Pool Ball
ColorSync · IOS API REFERENCE

ColorSyncProfile.HeadroomAdaptiveGainCurve

struct · iOS 27.0+ · SDK 27.1

struct HeadroomAdaptiveGainCurve

Headroom Adaptive Gain Curve metadata that describes how to tone map a profile's HDR content to the dynamic range available on the display. A profile stores this metadata in its HAGC tag; it applies only to profiles whose transfer function is PQ, HLG, or linear. Use ``colorVolumeTransform`` to describe the tone mapping to perform, then embed the curve in a profile with `ColorSyncProfileCreateCopyWithHeadroomAdaptiveGainCurveInfoDictionary`.

Members (5)

init · iOS 27.0+

init

TypeScript
static init(applicationVersion?: number, colorVolumeTransform?: (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform) | null): ColorSyncProfile_HeadroomAdaptiveGainCurve
Swift declaration
init(applicationVersion: UInt8 = 0, colorVolumeTransform: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform? = nil) throws

Creates Headroom Adaptive Gain Curve metadata. - Parameters: - applicationVersion: The ST 2094-50 application version. Must be `0`. - colorVolumeTransform: The color volume transform to apply, or `nil` for none. - Throws: ``Error/unsupportedApplicationVersion(_:)`` if `applicationVersion` is not `0`.

get · iOS 27.0+

applicationVersion

TypeScript
get applicationVersion(): number
Swift declaration
var applicationVersion: UInt8

The application version of the metadata, as defined by ST 2094-50. This 3-bit field is currently always `0`. Initializing the metadata with any other value throws ``Error/unsupportedApplicationVersion(_:)``.

set · iOS 27.0+

applicationVersion

TypeScript
set applicationVersion(value: number)
Swift declaration
var applicationVersion: UInt8

The application version of the metadata, as defined by ST 2094-50. This 3-bit field is currently always `0`. Initializing the metadata with any other value throws ``Error/unsupportedApplicationVersion(_:)``.

get · iOS 27.0+

colorVolumeTransform

TypeScript
get colorVolumeTransform(): (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform) | null
Swift declaration
var colorVolumeTransform: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform?

The color volume transform to apply, if any.

set · iOS 27.0+

colorVolumeTransform

TypeScript
set colorVolumeTransform(value: (ColorSyncProfile_HeadroomAdaptiveGainCurve_ColorVolumeTransform) | null)
Swift declaration
var colorVolumeTransform: ColorSyncProfile.HeadroomAdaptiveGainCurve.ColorVolumeTransform?

The color volume transform to apply, if any.

Skipped declarations

No declarations were skipped in this snapshot.

All ColorSync types →