Class FilmGrainSettings

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

Hierarchy

FrameworkObject
- FilmGrainSettings

Index

Constructors

Accessors

channelIntensity intensity isEnabled isMonochromatic speed

Methods

markAsDirty modify

Constructors

`Protected`constructor

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

Accessors

channelIntensity

get channelIntensity(): Immutable<Vector3>
Returns Immutable<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

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