Class WhiteBalanceSettings

Settings that control white balance post-process.

Index

Constructors

Properties

_temperature _tint

Accessors

temperature tint

Methods

assign clone isEqual isEqual

Constructors

constructor

new WhiteBalanceSettings(temperature?, tint?): WhiteBalanceSettings
Parameters
- Optionaltemperature: number
- Optionaltint: number
Returns WhiteBalanceSettings

Properties

`Protected`_temperature

_temperature: number

`Protected`_tint

_tint: number

Accessors

temperature

get temperature(): number
Temperature used for white balancing, in Kelvins.

Moves along the Planckian locus. In range [1500.0f, 15000.0f].

Returns number
set temperature(value): void
Parameters
- value: number
Returns void

tint

get tint(): number
Additional tint to be applied during white balancing. Can be used to further tweak the white balancing effect by modifying the tint of the light. The tint is chosen on the Planckian locus isothermal, depending on the light temperature specified by #temperature.

In range [-1.0f, 1.0f].

Returns number
set tint(value): void
Parameters
- value: number
Returns void

Methods

assign

assign(other): WhiteBalanceSettings
Copies all properties defined by the prototype of WhiteBalanceSettings from other to this instance.
Parameters
- other: Immutable<WhiteBalanceSettings>
Returns WhiteBalanceSettings

clone

clone(): WhiteBalanceSettings
Clones this instance and returns a new WhiteBalanceSettings with identical values.

Returns WhiteBalanceSettings

isEqual

isEqual(this, other): boolean
Determines if this WhiteBalanceSettings instance is equal to the other instance.
Parameters
- this: Immutable<WhiteBalanceSettings>
- other: Immutable<WhiteBalanceSettings>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both WhiteBalanceSettings instances are equal.
Parameters
- lhs: Immutable<WhiteBalanceSettings>
- rhs: Immutable<WhiteBalanceSettings>
Returns boolean