Class SSGIPlugin

SSGI Plugin

Adds screen space reflections to the scene.

Hierarchy

PipelinePassPlugin<SSGIPluginPass, SSGIPassId>
- SSGIPlugin

Index

Constructors

Properties

_pass? bufferType dependencies passId sizeMultiplier target? texture? OldPluginType PluginType

Accessors

Methods

_beforeRender _createPass _createTarget _disposeTarget fromJSON onAdded onRemove

Constructors

constructor

new SSGIPlugin(
    bufferType?: TextureDataType,
    sizeMultiplier?: number,
    enabled?: boolean,
): SSGIPlugin
Parameters
- bufferType: TextureDataType = UnsignedByteType
- sizeMultiplier: number = 1
- enabled: boolean = true
Returns SSGIPlugin
Overrides PipelinePassPlugin<SSGIPluginPass, SSGIPassId>.constructor

Properties

`Protected` `Optional`_pass

_pass?: SSGIPluginPass

`Readonly`bufferType

bufferType: TextureDataType

dependencies

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

`Readonly`passId

passId: "ssrtgi" = passId

`Readonly`sizeMultiplier

sizeMultiplier: number

`Optional`target

target?: SSGIPluginTarget

`Optional`texture

texture?: Texture<TextureEventMap>

`Static` `Readonly`OldPluginType

OldPluginType: "SSGI" = 'SSGI'

`Static` `Readonly`PluginType

PluginType: "SSGIPlugin" = 'SSGIPlugin'

Accessors

rtgiTarget

get rtgiTarget(): undefined | SSGIPluginTarget
Returns undefined | SSGIPluginTarget
Deprecated
use target instead

Methods

`Protected`_beforeRender

_beforeRender(
    _?: IScene<ISceneEventMap>,
    _1?: ICamera<ICameraEventMap>,
    _2?: IRenderManager<IRenderManagerEventMap>,
): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional_: IScene<ISceneEventMap>
- Optional_1: ICamera<ICameraEventMap>
- Optional_2: IRenderManager<IRenderManagerEventMap>
Returns boolean
Overrides PipelinePassPlugin._beforeRender

`Protected`_createPass

_createPass(): SSGIPluginPass
Returns SSGIPluginPass
Overrides PipelinePassPlugin._createPass

`Protected`_createTarget

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

`Protected`_disposeTarget

_disposeTarget(): void
Returns void

fromJSON

fromJSON(data: any, meta?: any): null | SSGIPlugin | Promise<null | SSGIPlugin>
Parameters
- data: any
- Optionalmeta: any
Returns null | SSGIPlugin | Promise<null | SSGIPlugin>
Overrides PipelinePassPlugin.fromJSON

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