Class FilmGrainSettings

Settings that control the film grain effect. Film grains adds a time-varying noise effect over the entire image.

Index

Constructors

Properties

_channelIntensity _intensity _isEnabled _isMonochromatic _speed

Accessors

channelIntensity intensity isEnabled isMonochromatic speed

Methods

assign clone isEqual isEqual

Constructors

constructor

new FilmGrainSettings(isEnabled?, isMonochromatic?, intensity?, speed?, channelIntensity?): FilmGrainSettings
Parameters
- OptionalisEnabled: boolean
- OptionalisMonochromatic: boolean
- Optionalintensity: number
- Optionalspeed: number
- OptionalchannelIntensity: Immutable<Vector3>
Returns FilmGrainSettings

Properties

`Protected`_channelIntensity

_channelIntensity: Vector3

`Protected`_intensity

_intensity: number

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_isMonochromatic

_isMonochromatic: boolean

`Protected`_speed

_speed: number

Accessors

channelIntensity

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

intensity

get intensity(): number
Controls how intense are the displayed film grains.

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

isEnabled

get isEnabled(): boolean
Enables or disables the effect.

Returns boolean
set isEnabled(value): void
Parameters
- value: boolean
Returns void

isMonochromatic

get isMonochromatic(): boolean
Returns boolean
set isMonochromatic(value): void
Parameters
- value: boolean
Returns void

speed

get speed(): number
Controls at what speed do the film grains change.

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

Methods

assign

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

clone

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

Returns FilmGrainSettings

isEqual

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

`Static`isEqual

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