Class FilmicTonemappingSettings

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

Index

Constructors

Accessors

linearAngle linearStrength linearWhitePoint shoulderStrength toeDenominator toeNumerator toeStrength

Methods

markAsDirty modify

Constructors

`Protected`constructor

new FilmicTonemappingSettings(
isInternalConstructor?: boolean,
): FilmicTonemappingSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns FilmicTonemappingSettings

Overrides FrameworkObject.constructor

Accessors

linearAngle

get linearAngle(): number

Controls the linear (middle) section of the filmic curve used for tonemapping. Mostly affects mid-range areas of the image and allows you to control how quickly does the curve climb.

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

linearStrength

get linearStrength(): number

Controls the linear (middle) section of the filmic curve used for tonemapping. Mostly affects mid-range areas of the image.

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

linearWhitePoint

get linearWhitePoint(): number

Controls the white point of the filmic curve used for tonemapping. Affects the entire curve.

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

shoulderStrength

get shoulderStrength(): number

Controls the shoulder (upper non-linear) section of the filmic curve used for tonemapping. Mostly affects bright areas of the image and allows you to reduce over-exposure.

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

toeDenominator

get toeDenominator(): number

Controls the toe (lower non-linear) section of the filmic curve used for tonemapping. Affects low-range.

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

toeNumerator

get toeNumerator(): number

Controls the toe (lower non-linear) section of the filmic curve. used for tonemapping. Affects low-range.

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

toeStrength

get toeStrength(): number

Controls the toe (lower non-linear) section of the filmic curve used for tonemapping. Mostly affects dark areas of the image and allows you to reduce under-exposure.

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

Methods

markAsDirty

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

modify

modify(action: () => void): 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.
Returns void