Class VelocityBufferPlugin

Velocity Buffer Plugin

Adds a pre-render pass to render the normal buffer to a render target that can be used for postprocessing.

Hierarchy

PipelinePassPlugin<
    VelocityBufferPluginPass,
    "velocityBuffer",
    VelocityBufferPluginEventTypes,
>
- VelocityBufferPlugin

Index

Constructors

Properties

_attachToTaa bufferType material passId target? texture? unpackExtension OldPluginType PluginType

Methods

_beforeRender _createPass _createTarget _disposeTarget onAdded onRemove setDirty

Constructors

constructor

new VelocityBufferPlugin(
    bufferType?: TextureDataType,
    enabled?: boolean,
    _attachToTaa?: boolean,
): VelocityBufferPlugin
Parameters
- bufferType: TextureDataType = UnsignedByteType
- enabled: boolean = true
- _attachToTaa: boolean = true
Returns VelocityBufferPlugin
Overrides PipelinePassPlugin<VelocityBufferPluginPass, 'velocityBuffer', VelocityBufferPluginEventTypes>.constructor

Properties

`Protected` `Readonly`_attachToTaa

_attachToTaa: boolean

`Readonly`bufferType

bufferType: TextureDataType

`Readonly`material

material: SSVelocityMaterial = ...

`Readonly`passId

passId: "velocityBuffer" = 'velocityBuffer'

`Optional`target

target?: WebGLRenderTarget

`Optional`texture

texture?: Texture

unpackExtension

unpackExtension: MaterialExtension = ...

`Static` `Readonly`OldPluginType

OldPluginType: "VelocityBufferPlugin" = 'VelocityBufferPlugin'

`Static` `Readonly`PluginType

PluginType: "VelocityBuffer" = 'VelocityBuffer'

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(): any
Returns any
Overrides PipelinePassPlugin._createPass

`Protected`_createTarget

_createTarget(recreate?: boolean): void
Parameters
- recreate: boolean = true
Returns void

`Protected`_disposeTarget

_disposeTarget(): void
Returns void

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

setDirty

setDirty(): void
Returns void
Overrides PipelinePassPlugin.setDirty