Skip to main content

Class: TemporalAAPlugin

Plugins.TemporalAAPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "TAA"

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:10


passId

passId: "taa"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:11


dependencies

dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:17


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_pass

Protected Optional _pass: IFilter<TAAPass, "taa">

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:13


_afterFilters

Protected _afterFilters: never[] = []

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:14


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:15

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:23

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:27


pass

get pass(): undefined | IFilter<T, TPassId>

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:68


stableNoise

get stableNoise(): boolean

Same as BaseRenderer.stableNoise Use total frame count, if this is set to true, then frameCount won't be reset when the viewer is set to dirty. Which will generate different random numbers for each frame during postprocessing steps. With TAA set properly, this will give a smoother result.

Returns

boolean

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:62

set stableNoise(v): void

Same as BaseRenderer.stableNoise Use total frame count, if this is set to true, then frameCount won't be reset when the viewer is set to dirty. Which will generate different random numbers for each frame during postprocessing steps. With TAA set properly, this will give a smoother result.

Parameters

NameType
vboolean

Returns

void

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:65


uiConfig

get uiConfig(): undefined | UiObjectConfig<any, string>

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:75

Methods

exportState

exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

GenericFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Inherited from

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:61


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:72


fromJSON

fromJSON(data, meta?): null | TemporalAAPlugin

Parameters

NameType
dataany
meta?any

Returns

null | TemporalAAPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:81


passCtor

passCtor(v): TAAPass

Parameters

NameType
vViewerApp

Returns

TAAPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:19


setDirty

setDirty(): void

Returns

void

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:26


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Overrides

GenericFilterPlugin.onDispose

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:30


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:52


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_update

Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/TemporalAAPlugin.ts:35

Constructors

constructor

new TemporalAAPlugin()

Inherited from

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:32