Class: TemporalAAPlugin
Plugins.TemporalAAPlugin
Hierarchy
GenericFilterPlugin
<TAAPass
,"taa"
,""
,ViewerApp
>↳
TemporalAAPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "TAA"
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:10
passId
• passId: "taa"
Overrides
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:11
dependencies
• dependencies: typeof GBufferPlugin
[]
Implementation of
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:17
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
_pass
• Protected
Optional
_pass: IFilter
<TAAPass
, "taa"
>
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:9
_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
Inherited from
GenericFilterPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
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:24
• set
enabled(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
GenericFilterPlugin.enabled
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:28
pass
• get
pass(): undefined
| IFilter
<T
, TPassId
>
Returns
undefined
| IFilter
<T
, TPassId
>
Inherited from
GenericFilterPlugin.pass
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:69
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
Name | Type |
---|---|
v | boolean |
Returns
void
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:65
uiConfig
• get
uiConfig(): undefined
| UiObjectConfig
<any
, string
>
Returns
undefined
| UiObjectConfig
<any
, string
>
Implementation of
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
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
GenericFilterPlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Implementation of
Inherited from
GenericFilterPlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:84
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:62
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
IViewerPlugin.toJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:73
fromJSON
▸ fromJSON(data
, meta?
): null
| TemporalAAPlugin
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| TemporalAAPlugin
Implementation of
IViewerPlugin.fromJSON
Inherited from
Defined in
webgi/src/plugins/GenericFilterPlugin.ts:82
passCtor
▸ passCtor(v
): TAAPass
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
TAAPass
Overrides
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
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:30
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:52
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
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
Name | Type |
---|---|
v | ViewerApp |
Returns
boolean
Overrides
Defined in
webgi/src/plugins/TemporalAAPlugin.ts:35
Constructors
constructor
• new TemporalAAPlugin()
Inherited from
GenericFilterPlugin.constructor