Class SSReflectionPlugin

SSReflection Plugin

Adds screen space reflections to the scene.

Hierarchy

PipelinePassPlugin<SSReflectionPluginPass, SSReflectionPassId>
- SSReflectionPlugin

Index

Constructors

Properties

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

Accessors

Methods

_beforeRender _createPass _createTarget _disposeTarget fromJSON onAdded onRemove

Constructors

constructor

new SSReflectionPlugin(
    inlineShaderRayTrace?: boolean,
    bufferType?: TextureDataType,
    sizeMultiplier?: number,
    enabled?: boolean,
): SSReflectionPlugin
Parameters
- inlineShaderRayTrace: boolean = true
- bufferType: TextureDataType = UnsignedByteType
- sizeMultiplier: number = 1
- enabled: boolean = true
Returns SSReflectionPlugin
Overrides PipelinePassPlugin<SSReflectionPluginPass, SSReflectionPassId>.constructor

Properties

`Protected` `Optional`_pass

_pass?: SSReflectionPluginPass

_viewerListeners

_viewerListeners: { postRender: () => void; preRender: () => void } = ...

`Readonly`bufferType

bufferType: TextureDataType

dependencies

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

`Readonly`inlineShaderRayTrace

inlineShaderRayTrace: boolean = true

`Readonly`passId

passId: "ssrefl" = passId

`Readonly`sizeMultiplier

sizeMultiplier: number

`Optional`target

target?: SSReflectionPluginTarget

`Optional`texture

texture?: Texture<TextureEventMap>

`Static` `Readonly`OldPluginType

OldPluginType: "SSReflection" = 'SSReflection'

`Static` `Readonly`PluginType

PluginType: "SSReflectionPlugin" = 'SSReflectionPlugin'

Accessors

ssrTarget

get ssrTarget(): undefined | SSReflectionPluginTarget
Returns undefined | SSReflectionPluginTarget
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(): SSReflectionPluginPass
Returns SSReflectionPluginPass
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 | SSReflectionPlugin | Promise<null | SSReflectionPlugin>
Parameters
- data: any
- Optionalmeta: any
Returns null | SSReflectionPlugin | Promise<null | SSReflectionPlugin>
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