Class: TemporalAAPlugin

Plugins.TemporalAAPlugin

Hierarchy

• GenericFilterPlugin<TAAPass, "taa", "">

  ↳ TemporalAAPlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "TAA"

---

passId

• passId: "taa"

Overrides

GenericFilterPlugin.passId

---

dependencies

• dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPluginAsync.dependencies

---

_dirty

• Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

---

_pass

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

Inherited from

GenericFilterPlugin._pass

---

_beforeFilters

• Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

---

_afterFilters

• Protected _afterFilters: never[] = []

Overrides

GenericFilterPlugin._afterFilters

---

_requiredFilters

• Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

GenericFilterPlugin.viewer

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

---

pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

---

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

• 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

Name	Type
v	boolean

Returns

void

---

uiConfig

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

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

Methods

exportState

▸ exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

GenericFilterPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

GenericFilterPlugin.loadState

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Inherited from

GenericFilterPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

GenericFilterPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | TemporalAAPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | TemporalAAPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

---

passCtor

▸ passCtor(v): TAAPass

Parameters

Name	Type
v	ViewerApp

Returns

TAAPass

Overrides

GenericFilterPlugin.passCtor

---

setDirty

▸ setDirty(): void

Returns

void

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Overrides

GenericFilterPlugin.onDispose

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

GenericFilterPlugin.onAdded

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

---

_update

▸ Protected _update(v): boolean

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

Parameters

Name	Type
v	ViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Constructors

constructor

• new TemporalAAPlugin()

Inherited from

GenericFilterPlugin.constructor