Class WhiteBalanceSettings

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Hierarchy

FrameworkObject
- WhiteBalanceSettings

Index

Constructors

Accessors

temperature tint

Methods

markAsDirty modify

Constructors

`Protected`constructor

new WhiteBalanceSettings(isInternalConstructor?): WhiteBalanceSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns WhiteBalanceSettings
Overrides FrameworkObject.constructor

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

markAsDirty

markAsDirty(dirtyFlags): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: (() => void)
  The scope where the object is modified.
  - - (): void
    - Returns void
Returns void