Skip to main content

Class: TFilmGrainPostProcessingEffect

Defined in: graphics/post-processing/effects/film-grain.ts:39

Extends​

Constructors​

Constructor​

new TFilmGrainPostProcessingEffect(options?): TFilmGrainPostProcessingEffect

Defined in: graphics/post-processing/effects/film-grain.ts:44

Parameters​

options?​

TFilmGrainPostProcessingOptions = {}

Returns​

TFilmGrainPostProcessingEffect

Overrides​

TPostProcessingEffect.constructor

Properties​

enabled​

enabled: boolean = true

Defined in: graphics/post-processing/effect.ts:13

Inherited from​

TPostProcessingEffect.enabled

mask?​

optional mask?: TPostProcessingMask

Defined in: graphics/post-processing/effect.ts:14

Inherited from​

TPostProcessingEffect.mask

Accessors​

amount​

Get Signature​

get amount(): number

Defined in: graphics/post-processing/effects/film-grain.ts:60

Returns​

number

Set Signature​

set amount(value): void

Defined in: graphics/post-processing/effects/film-grain.ts:64

Parameters​
value​

number

Returns​

void

grainSize​

Get Signature​

get grainSize(): number

Defined in: graphics/post-processing/effects/film-grain.ts:69

Returns​

number

Set Signature​

set grainSize(value): void

Defined in: graphics/post-processing/effects/film-grain.ts:73

Parameters​
value​

number

Returns​

void

speed​

Get Signature​

get speed(): number

Defined in: graphics/post-processing/effects/film-grain.ts:78

Returns​

number

Set Signature​

set speed(value): void

Defined in: graphics/post-processing/effects/film-grain.ts:82

Parameters​
value​

number

Returns​

void

Methods​

destroy()​

destroy(jobs): Promise<void>

Defined in: graphics/post-processing/effect.ts:50

Parameters​

jobs​

TJobManager

Returns​

Promise<void>

Inherited from​

TPostProcessingEffect.destroy

serialise()​

serialise(): TSerializedPostProcessingEffect | undefined

Defined in: graphics/post-processing/effect.ts:56

Returns​

TSerializedPostProcessingEffect | undefined

Inherited from​

TPostProcessingEffect.serialise

setUniform()​

setUniform(name, value): void

Defined in: graphics/post-processing/effect.ts:46

Parameters​

name​

string

value​

TPostProcessingUniformValue

Returns​

void

Inherited from​

TPostProcessingEffect.setUniform

create()​

static create(jobs, options?): Promise<TFilmGrainPostProcessingEffect>

Defined in: graphics/post-processing/effects/film-grain.ts:51

Parameters​

jobs​

TJobManager

options?​

TFilmGrainPostProcessingOptions = {}

Returns​

Promise<TFilmGrainPostProcessingEffect>

fromSource()​

static fromSource(jobs, fragmentShader): Promise<TPostProcessingEffect>

Defined in: graphics/post-processing/effect.ts:24

Parameters​

jobs​

TJobManager

fragmentShader​

string

Returns​

Promise<TPostProcessingEffect>

Inherited from​

TPostProcessingEffect.fromSource

fromUrl()​

static fromUrl(jobs, url): Promise<TPostProcessingEffect>

Defined in: graphics/post-processing/effect.ts:33

Parameters​

jobs​

TJobManager

url​

string

Returns​

Promise<TPostProcessingEffect>

Inherited from​

TPostProcessingEffect.fromUrl