Class SSGIPlugin

SSGI Plugin

Adds screen space reflections to the scene.

Hierarchy

PipelinePassPlugin<SSGIPluginPass, SSGIPassId>
- SSGIPlugin

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
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:87

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_pass

_pass?: SSGIPluginPass

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

`Readonly`bufferType

bufferType: TextureDataType

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

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

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`passId

passId: "ssrtgi" = passId

`Readonly`sizeMultiplier

sizeMultiplier: number

`Optional`target

target?: SSGIPluginTarget

`Optional`texture

texture?: Texture<TextureEventMap>

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Readonly`OldPluginType

OldPluginType: "SSGI" = 'SSGI'

`Static` `Readonly`PluginType

PluginType: "SSGIPlugin" = 'SSGIPlugin'

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

rtgiTarget

get rtgiTarget(): SSGIPluginTarget | undefined
Returns SSGIPluginTarget | undefined
Deprecated
use target instead
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:214

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
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:188

`Protected`_createPass

_createPass(): SSGIPluginPass
Returns SSGIPluginPass
Overrides PipelinePassPlugin._createPass
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:138

`Protected`_createTarget

_createTarget(recreate?: boolean): void
Parameters
- recreate: boolean = true
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:98

`Protected`_disposeTarget

_disposeTarget(): void
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:118

`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: any, meta?: any): SSGIPlugin | Promise<SSGIPlugin | null> | null
Parameters
- data: any
- Optionalmeta: any
Returns SSGIPlugin | Promise<SSGIPlugin | null> | null
Overrides PipelinePassPlugin.fromJSON
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:171

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/SSGIPlugin.ts:146

onRemove

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

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 SSGIPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSGIPlugin

Properties

Protected_dirty

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

ReadonlybufferType

constructor

dependencies

enabled

isViewerPluginSync

ReadonlypassId

ReadonlysizeMultiplier

Optionaltarget

Optionaltexture

OptionaluiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

pass

Returns T | undefined

rtgiTarget

Returns SSGIPluginTarget | undefined

Deprecated

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns SSGIPluginPass

Protected_createTarget

Parameters

Returns void

Protected_disposeTarget

Returns void

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 SSGIPlugin | Promise<SSGIPlugin | null> | null

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

`Protected`_dirty

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`bufferType

`Readonly`passId

`Readonly`sizeMultiplier

`Optional`target

`Optional`texture

`Optional`uiConfig

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected`_createPass

`Protected`_createTarget

`Protected`_disposeTarget

`Protected`_onViewerEvent

`Protected`_storeKey