Class TemporalAAPlugin

Temporal Anti-Aliasing Plugin

This plugin uses a temporal anti-aliasing pass to smooth out the final image when the camera or some mesh is moving

Hierarchy

PipelinePassPlugin<TemporalAAPluginPass<TemporalAAPassId>, TemporalAAPassId>
- TemporalAAPlugin

Index

Constructors

Constructors

constructor

new TemporalAAPlugin(enabled?: boolean): TemporalAAPlugin
Parameters
- enabled: boolean = true
Returns TemporalAAPlugin
Overrides PipelinePassPlugin<TemporalAAPluginPass<TemporalAAPassId>, TemporalAAPassId>.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:49

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_pass

_pass?: TemporalAAPluginPass<"taa">

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: (typeof ProgressivePlugin | typeof GBufferPlugin)[] = ...

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`passId

passId: "taa" = passId

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Readonly`OldPluginType

OldPluginType: "TemporalAAPlugin" = 'TemporalAAPlugin'

`Static` `Readonly`PluginType

PluginType: "TAA" = 'TAA'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

pass

get pass(): T | undefined
Returns T | undefined
Inherited from PipelinePassPlugin.pass
- Defined in src/plugins/base/PipelinePassPlugin.ts:62

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 plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:62
set stableNoise(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:65

Methods

`Protected`_beforeRender

_beforeRender(
    scene: IScene,
    camera: ICamera,
    renderManager: IRenderManager,
): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- scene: IScene
- camera: ICamera
- renderManager: IRenderManager
Returns boolean
Overrides PipelinePassPlugin._beforeRender
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:118

`Protected`_createPass

_createPass(): TemporalAAPluginPass<"taa">
Returns TemporalAAPluginPass<"taa">
Overrides PipelinePassPlugin._createPass
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:83

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from PipelinePassPlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from PipelinePassPlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from PipelinePassPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from PipelinePassPlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig & { pass?: any },
meta?: SerializationMetaType,
): TemporalAAPlugin | Promise<TemporalAAPlugin | null> | null
Parameters
- data: ISerializedConfig & { pass?: any }
- Optionalmeta: SerializationMetaType
Returns TemporalAAPlugin | Promise<TemporalAAPlugin | null> | null
Inherited from PipelinePassPlugin.fromJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:70

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from PipelinePassPlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:94

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/TemporalAAPlugin.ts:102

setDirty

setDirty(): void
Returns void
Inherited from PipelinePassPlugin.setDirty
- Defined in src/plugins/base/PipelinePassPlugin.ts:74

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig & { pass?: any }
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig & { pass?: any }
Inherited from PipelinePassPlugin.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:66

Class TemporalAAPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TemporalAAPlugin

Properties

Protected_dirty

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

isViewerPluginSync

ReadonlypassId

uiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

pass

Returns T | undefined

stableNoise

Returns boolean

Parameters

Returns void

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns TemporalAAPluginPass<"taa">

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns TemporalAAPlugin | Promise<TemporalAAPlugin | null> | null

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig & { pass?: any }

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`passId

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected`_createPass

`Protected`_onViewerEvent

`Protected`_storeKey