Class ColorGradingSettings

Settings that control color grading post-process.

Index

Constructors

Properties

_contrast _gain _offset _saturation

Accessors

contrast gain offset saturation

Methods

assign clone isEqual isEqual

Constructors

constructor

new ColorGradingSettings(saturation?, contrast?, gain?, offset?): ColorGradingSettings
Parameters
- Optionalsaturation: Immutable<Vector3>
- Optionalcontrast: Immutable<Vector3>
- Optionalgain: Immutable<Vector3>
- Optionaloffset: Immutable<Vector3>
Returns ColorGradingSettings

Properties

`Protected`_contrast

_contrast: Vector3

`Protected`_gain

_gain: Vector3

`Protected`_offset

_offset: Vector3

`Protected`_saturation

_saturation: Vector3

Accessors

contrast

get contrast(): Vector3
Contrast to be applied during color grading. Larger values increase difference between light and dark areas of the image. In range [0.0f, 2.0f].

Returns Vector3
set contrast(value): void
Parameters
- value: Immutable<Vector3>
Returns void

gain

get gain(): Vector3
Gain to be applied during color grading. Simply increases all color values by an equal scale. In range [0.0f, 2.0f].

Returns Vector3
set gain(value): void
Parameters
- value: Immutable<Vector3>
Returns void

offset

get offset(): Vector3
Gain to be applied during color grading. Simply offsets all color values by an equal amount. In range [-1.0f, 1.0f].

Returns Vector3
set offset(value): void
Parameters
- value: Immutable<Vector3>
Returns void

saturation

get saturation(): Vector3
Saturation to be applied during color grading. Larger values increase vibrancy of the image. In range [0.0f, 2.0f].

Returns Vector3
set saturation(value): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

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

clone

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

Returns ColorGradingSettings

isEqual

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

`Static`isEqual

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