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

Properties

_pass? dependencies passId uiConfig OldPluginType PluginType

Accessors

Methods

_beforeRender _createPass onAdded onRemove

Constructors

constructor

new TemporalAAPlugin(enabled?: boolean): TemporalAAPlugin
Parameters
- enabled: boolean = true
Returns TemporalAAPlugin
Overrides PipelinePassPlugin<TemporalAAPluginPass<TemporalAAPassId>, TemporalAAPassId, ''>.constructor

Properties

`Protected` `Optional`_pass

_pass?: TemporalAAPluginPass<"taa">

dependencies

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

`Readonly`passId

passId: "taa" = passId

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Readonly`OldPluginType

OldPluginType: "TemporalAAPlugin" = 'TemporalAAPlugin'

`Static` `Readonly`PluginType

PluginType: "TAA" = 'TAA'

Accessors

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: boolean): void
Parameters
- v: boolean
Returns void

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

`Protected`_createPass

_createPass(): TemporalAAPluginPass<"taa">
Returns TemporalAAPluginPass<"taa">
Overrides PipelinePassPlugin._createPass

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove