Class ColorGradingSettings

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

Hierarchy

FrameworkObject
- ColorGradingSettings

Index

Constructors

Accessors

contrast gain offset saturation

Methods

markAsDirty modify

Constructors

`Protected`constructor

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

Accessors

contrast

get contrast(): Immutable<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 Immutable<Vector3>
set contrast(value): void
Parameters
- value: Immutable<Vector3>
Returns void

gain

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

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

offset

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

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

saturation

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

Returns Immutable<Vector3>
set saturation(value): void
Parameters
- value: Immutable<Vector3>
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