Class SSGIPluginPass

Hierarchy

ExtendedShaderPass
- SSGIPluginPass

Implements

IPipelinePass

Constructors

constructor

new SSGIPluginPass(
    pid: string,
    target?: ValOrFunc<WebGLRenderTarget<Texture<TextureEventMap>> | undefined>,
    giEnabled?: boolean,
): SSGIPluginPass
Parameters
- pid: string
- Optionaltarget: ValOrFunc<WebGLRenderTarget<Texture<TextureEventMap>> | undefined>
- giEnabled: boolean = true
Returns SSGIPluginPass
Overrides ExtendedShaderPass.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:292

Properties

`Protected`_gbufferUnpackExtension

_gbufferUnpackExtension: MaterialExtension | undefined

after

after: string[] = ...

Passes that should run before this pass

autoRadius

autoRadius: boolean = true

before

before: string[] = ...

Passes that should run after this pass

bias

bias: number = 0.001

`Readonly`bilateralPass

bilateralPass: BilateralFilterPass

enabled

enabled: boolean = true

falloff

falloff: number = 0.7

giEnabled

giEnabled: boolean = true

intensity

intensity: number = 2

`Readonly`isExtendedShaderPass

isExtendedShaderPass: true

material

material: ShaderMaterial2

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

objectRadius

objectRadius: number = 1

onDirty

onDirty: (() => void)[] = []

overrideReadBuffer

overrideReadBuffer: { texture?: Texture<TextureEventMap> } | null = null

`Readonly`passId

passId: string

Unique id for the pass. Used to determine the order of passes in the pipeline.

power

power: number = 1.1

rayCount

rayCount: number = 4

renderWithCamera

renderWithCamera: boolean = true

required

required: string[] = ...

Passes that are required to be present in the pipeline to run this pass.

smoothEnabled

smoothEnabled: boolean = true

split

split: number = 0

stepCount

stepCount: number = 8

`Optional`target

target?: ValOrFunc<WebGLRenderTarget<Texture<TextureEventMap>> | undefined>

tolerance

tolerance: number = 1

`Static` `Readonly`DEFAULT_TEX_ID

DEFAULT_TEX_ID: "tDiffuse" = 'tDiffuse'

Accessors

isShaderPass2

get isShaderPass2(): boolean
Returns boolean
Deprecated
renamed to isExtendedShaderPass
Inherited from ExtendedShaderPass.isShaderPass2
- Defined in src/postprocessing/ExtendedShaderPass.ts:67

uniformsNeedUpdate

set uniformsNeedUpdate(value: true): void
Parameters
- value: true
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:551

Methods

beforeRender

beforeRender(
    scene: IScene,
    camera: ICamera,
    renderManager: IRenderManager,
): void
This function gets called at the beginning of every frame where this pass would be enabled.
Parameters
- scene: IScene
- camera: ICamera
- renderManager: IRenderManager
Returns void
Implementation of IPipelinePass.beforeRender
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:417

dispose

dispose(): void
Returns void
Implementation of IPipelinePass.dispose
Inherited from ExtendedShaderPass.dispose
- Defined in src/postprocessing/ExtendedShaderPass.ts:50

render

render(
    renderer: IWebGLRenderer,
    writeBuffer: WebGLRenderTarget,
    readBuffer: WebGLRenderTarget,
    deltaTime: number,
    maskActive: boolean,
): void
Parameters
- renderer: IWebGLRenderer
- writeBuffer: WebGLRenderTarget
- readBuffer: WebGLRenderTarget
- deltaTime: number
- maskActive: boolean
Returns void
Implementation of IPipelinePass.render
Overrides ExtendedShaderPass.render
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:379

setDirty

setDirty(): void
Returns void
Implementation of IPipelinePass.setDirty
Overrides ExtendedShaderPass.setDirty
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:578

setGBufferUnpackExtension

setGBufferUnpackExtension(extension: MaterialExtension | undefined): void
Parameters
- extension: MaterialExtension | undefined
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/SSGIPlugin.ts:557

updateShaderProperties

updateShaderProperties(
    updater?:
        | IShaderPropertiesUpdater
        | (IShaderPropertiesUpdater | undefined)[],
): void
to be called from beforeRender or onObjectRender or similar.
Parameters
- Optionalupdater: IShaderPropertiesUpdater | (IShaderPropertiesUpdater | undefined)[]
Returns void
Inherited from ExtendedShaderPass.updateShaderProperties
- Defined in src/postprocessing/ExtendedShaderPass.ts:43

Class SSGIPluginPass

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSGIPluginPass

Properties

Protected_gbufferUnpackExtension

after

autoRadius

before

bias

ReadonlybilateralPass

enabled

falloff

giEnabled

intensity

ReadonlyisExtendedShaderPass

material

ReadonlymaterialExtension

objectRadius

onDirty

overrideReadBuffer

ReadonlypassId

power

rayCount

renderWithCamera

required

smoothEnabled

split

stepCount

Optionaltarget

tolerance

Static ReadonlyDEFAULT_TEX_ID

Accessors

isShaderPass2

Returns boolean

Deprecated

uniformsNeedUpdate

Parameters

Returns void

Methods

beforeRender

Parameters

Returns void

dispose

Returns void

render

Parameters

Returns void

setDirty

Returns void

setGBufferUnpackExtension

Parameters

Returns void

updateShaderProperties

Parameters

Returns void

Settings

On This Page

`Protected`_gbufferUnpackExtension

`Readonly`bilateralPass

`Readonly`isExtendedShaderPass

`Readonly`materialExtension

`Readonly`passId

`Optional`target

`Static` `Readonly`DEFAULT_TEX_ID