Class FilmicTonemappingSettings

Settings for the Filmic tonemapping curve (Uncharted 2).

Index

Constructors

Properties

_linearAngle _linearStrength _linearWhitePoint _shoulderStrength _toeDenominator _toeNumerator _toeStrength

Accessors

linearAngle linearStrength linearWhitePoint shoulderStrength toeDenominator toeNumerator toeStrength

Methods

assign clone isEqual isEqual

Constructors

constructor

new FilmicTonemappingSettings(shoulderStrength?, linearStrength?, linearAngle?, toeStrength?, toeNumerator?, toeDenominator?, linearWhitePoint?): FilmicTonemappingSettings
Parameters
- OptionalshoulderStrength: number
- OptionallinearStrength: number
- OptionallinearAngle: number
- OptionaltoeStrength: number
- OptionaltoeNumerator: number
- OptionaltoeDenominator: number
- OptionallinearWhitePoint: number
Returns FilmicTonemappingSettings

Properties

`Protected`_linearAngle

_linearAngle: number

`Protected`_linearStrength

_linearStrength: number

`Protected`_linearWhitePoint

_linearWhitePoint: number

`Protected`_shoulderStrength

_shoulderStrength: number

`Protected`_toeDenominator

_toeDenominator: number

`Protected`_toeNumerator

_toeNumerator: number

`Protected`_toeStrength

_toeStrength: number

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): 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): 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): 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): 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): 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): 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): void
Parameters
- value: number
Returns void

Methods

assign

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

clone

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

Returns FilmicTonemappingSettings

isEqual

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

`Static`isEqual

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