Instance Method

deviceWhiteBalanceGains(for:)

Converts device-independent chromaticity values to device-specific white balance RGB gain values.

Declaration

func deviceWhiteBalanceGains(for chromaticityValues: AVCaptureDevice.WhiteBalanceChromaticityValues) -> AVCaptureDevice.WhiteBalanceGains

Parameters

chromaticityValues

The chromaticity values for which to get white balance RGB gain values.

Return Value

A fully populated AVCaptureDevice.WhiteBalanceGains structure containing device-specific RGB gain values.

Discussion

This method may be called on the receiver to convert device-independent chromaticity values to device-specific RGB white balance gain values.

This method throws an invalidArgumentException exception if any of the chromaticityValues fields are set outside the range [0,1].

Some chromaticityValues field combinations yield out-of-range device RGB values that will cause an exception to be thrown if passed directly to setWhiteBalanceModeLocked(with:completionHandler:). Be sure to verify that red, green, and blue gain values are within the range of [1.0 - maxWhiteBalanceGain].

See Also

Managing the White Balance

func isWhiteBalanceModeSupported(AVCaptureDevice.WhiteBalanceMode) -> Bool

Returns a Boolean value that indicates whether the given white balance mode is supported.

var isAdjustingWhiteBalance: Bool

Indicates whether the devise is currently adjusting the white balance.

func chromaticityValues(for: AVCaptureDevice.WhiteBalanceGains) -> AVCaptureDevice.WhiteBalanceChromaticityValues

Converts device-specific white balance RGB gain values to device-independent chromaticity values.

var deviceWhiteBalanceGains: AVCaptureDevice.WhiteBalanceGains

The current device-specific RGB white balance gain values.

var maxWhiteBalanceGain: Float

The maximum supported value to which a channel in the AVCaptureWhiteBalanceGains may be set.

func deviceWhiteBalanceGains(for: AVCaptureDevice.WhiteBalanceTemperatureAndTintValues) -> AVCaptureDevice.WhiteBalanceGains

Converts device-independent temperature and tint values to device-specific white balance RGB gain values.

var grayWorldDeviceWhiteBalanceGains: AVCaptureDevice.WhiteBalanceGains

The current device-specific white balance values required for a neutral gray white point.

func setWhiteBalanceModeLocked(with: AVCaptureDevice.WhiteBalanceGains, completionHandler: ((CMTime) -> Void)?)

Sets white balance to locked mode with the specified deviceWhiteBalanceGains values.

func temperatureAndTintValues(for: AVCaptureDevice.WhiteBalanceGains) -> AVCaptureDevice.WhiteBalanceTemperatureAndTintValues

Converts device-specific white balance RGB gain values to device-independent temperature and tint values.

var isLockingWhiteBalanceWithCustomDeviceGainsSupported: Bool

A Boolean value indicating whether the device supports locking white balance to specific gain values.

class let currentWhiteBalanceGains: AVCaptureDevice.WhiteBalanceGains

A special constant representing the current white balance setting.

struct AVCaptureDevice.WhiteBalanceGains

Structure containing RGB white balance gain values.

struct AVCaptureDevice.WhiteBalanceChromaticityValues

Structure containing CIE 1931 xy chromaticity values.

struct AVCaptureDevice.WhiteBalanceTemperatureAndTintValues

Structure containing temperature and tint values correlated to a white-balance color.

enum AVCaptureDevice.WhiteBalanceMode

Constants to specify the white balance mode of a capture device.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software