Class FilmGrainSettings

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

Index

Constructors

Accessors

channelIntensity intensity isEnabled isMonochromatic speed

Methods

markAsDirty modify

Constructors

`Protected`constructor

new FilmGrainSettings(isInternalConstructor?: boolean): FilmGrainSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns FilmGrainSettings

Overrides FrameworkObject.constructor

Accessors

channelIntensity

get channelIntensity(): Immutable<Vector3>

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

intensity

get intensity(): number

Controls how intense are the displayed film grains.

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

isEnabled

get isEnabled(): boolean

Enables or disables the effect.

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

isMonochromatic

get isMonochromatic(): boolean

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

speed

get speed(): number

Controls at what speed do the film grains change.

Returns number
set speed(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