Class GBufferPlugin

G-Buffer Plugin

Adds a pre-render pass to render the g-buffer(depth+normal+flags) to render target(s) that can be used as gbuffer and for postprocessing.

Hierarchy (View Summary)

PipelinePassPlugin<GBufferPluginPass, "gbuffer">
- GBufferPlugin

Constructors

constructor

new GBufferPlugin(
    bufferType?: TextureDataType,
    isPrimaryGBuffer?: boolean,
    enabled?: boolean,
    renderFlagsBuffer?: boolean,
    renderDepthTexture?: boolean,
    depthTextureType?: 1012 | 1014 | 1015,
): GBufferPlugin
Parameters
- bufferType: TextureDataType = UnsignedByteType
- isPrimaryGBuffer: boolean = true
- enabled: boolean = true
- renderFlagsBuffer: boolean = true
- renderDepthTexture: boolean = false
- depthTextureType: 1012 | 1014 | 1015 = UnsignedIntType
Returns GBufferPlugin
Overrides PipelinePassPlugin.constructor
- Defined in src/plugins/pipeline/GBufferPlugin.ts:247

Properties

`Protected`_dirty

_dirty: boolean = false

depthTextureType

depthTextureType: 1012 | 1014 | 1015 = UnsignedIntType

enabled

enabled: boolean = true

`Readonly`isPrimaryGBuffer

isPrimaryGBuffer: boolean

`Optional`material

material?: GBufferMaterial

`Readonly`passId

passId: "gbuffer" = 'gbuffer'

renderDepthTexture

renderDepthTexture: boolean = false

renderFlagsBuffer

renderFlagsBuffer: boolean = true

`Optional`target

target?: GBufferPluginTarget

textures

textures: Texture<TextureEventMap>[] = []

`Optional`uiConfig

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

unpackExtension

unpackExtension: MaterialExtension = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "GBuffer" = 'GBuffer'

Accessors

depthTexture

get depthTexture(): undefined | ITexture<TextureEventMap> & DepthTexture
Returns undefined | ITexture<TextureEventMap> & DepthTexture
- Defined in src/plugins/pipeline/GBufferPlugin.ts:60

dirty

get dirty(): boolean
Returns boolean
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

flagsTexture

get flagsTexture(): undefined | ITexture<TextureEventMap>
Returns undefined | ITexture<TextureEventMap>
- Defined in src/plugins/pipeline/GBufferPlugin.ts:55

normalDepthTexture

get normalDepthTexture(): undefined | ITexture<TextureEventMap>
Returns undefined | ITexture<TextureEventMap>
- Defined in src/plugins/pipeline/GBufferPlugin.ts:50

pass

get pass(): undefined | T
Returns undefined | T
Inherited from PipelinePassPlugin.pass
- Defined in src/plugins/base/PipelinePassPlugin.ts:62

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
- Defined in src/plugins/pipeline/GBufferPlugin.ts:241

`Protected`_createPass

_createPass(): GBufferRenderPass<"gbuffer", undefined | GBufferPluginTarget>
Returns GBufferRenderPass<"gbuffer", undefined | GBufferPluginTarget>
Overrides PipelinePassPlugin._createPass
- Defined in src/plugins/pipeline/GBufferPlugin.ts:204

`Protected`_createTargetAndMaterial

_createTargetAndMaterial(recreateTarget?: boolean): void
Parameters
- recreateTarget: boolean = true
Returns void
- Defined in src/plugins/pipeline/GBufferPlugin.ts:136

`Protected`_disposeTarget

_disposeTarget(): void
Returns void
- Defined in src/plugins/pipeline/GBufferPlugin.ts:189

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from PipelinePassPlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:68

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from PipelinePassPlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:54

createMaterial

createMaterial(): GBufferMaterial
Returns GBufferMaterial
- Defined in src/plugins/pipeline/GBufferPlugin.ts:127

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:75

dispose

dispose(): void
Returns void
Inherited from PipelinePassPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:34

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:80

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from PipelinePassPlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:59

fromJSON

fromJSON(
data: ISerializedConfig & { pass?: any },
meta?: SerializationMetaType,
): null | GBufferPlugin | Promise<null | GBufferPlugin>
Parameters
- data: ISerializedConfig & { pass?: any }
- Optionalmeta: SerializationMetaType
Returns null | GBufferPlugin | Promise<null | GBufferPlugin>
Inherited from PipelinePassPlugin.fromJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:70

getDepthNormal

getDepthNormal(): undefined | Texture<TextureEventMap>
Returns undefined | Texture<TextureEventMap>
Deprecated
use normalDepthTexture instead
- Defined in src/plugins/pipeline/GBufferPlugin.ts:281

getFlagsTexture

getFlagsTexture(): undefined | Texture<TextureEventMap>
Returns undefined | Texture<TextureEventMap>
Deprecated
use flagsTexture instead
- Defined in src/plugins/pipeline/GBufferPlugin.ts:287

getTarget

getTarget(): undefined | GBufferPluginTarget
Returns undefined | GBufferPluginTarget
Deprecated
use target instead
- Defined in src/plugins/pipeline/GBufferPlugin.ts:294

getUnpackSnippet

getUnpackSnippet(): string
Returns string
Deprecated
use unpackExtension instead
- Defined in src/plugins/pipeline/GBufferPlugin.ts:301

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from PipelinePassPlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:62

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:85

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from PipelinePassPlugin.onAdded
- Defined in src/plugins/base/PipelinePassPlugin.ts:44

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove
- Defined in src/plugins/pipeline/GBufferPlugin.ts:271

registerGBufferUpdater

registerGBufferUpdater(
key: string,
updater: (data: Vector4, context: GBufferUpdaterContext) => void,
): void
Parameters
- key: string
- updater: (data: Vector4, context: GBufferUpdaterContext) => void
Returns void
- Defined in src/plugins/pipeline/GBufferPlugin.ts:263

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

unregisterGBufferUpdater

unregisterGBufferUpdater(key: string): void
Parameters
- key: string
Returns void
- Defined in src/plugins/pipeline/GBufferPlugin.ts:267

updateShaderProperties

updateShaderProperties(
    material: {
        defines: Record<string, string | number | undefined>;
        needsUpdate?: boolean;
        uniforms: { [p: string]: IUniform<any> };
    },
): this
Parameters
- material: {
      defines: Record<string, string | number | undefined>;
      needsUpdate?: boolean;
      uniforms: { [p: string]: IUniform<any> };
  }
Returns this
Deprecated
use unpackExtension instead, it adds the same uniforms and defines
- Defined in src/plugins/pipeline/GBufferPlugin.ts:309

Class GBufferPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GBufferPlugin

Properties

Protected_dirty

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

ReadonlybufferType

constructor

depthTextureType

enabled

ReadonlyisPrimaryGBuffer

Optionalmaterial

ReadonlypassId

renderDepthTexture

renderFlagsBuffer

Optionaltarget

textures

OptionaluiConfig

unpackExtension

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

depthTexture

Returns undefined | ITexture<TextureEventMap> & DepthTexture

dirty

Returns boolean

Parameters

Returns void

flagsTexture

Returns undefined | ITexture<TextureEventMap>

normalDepthTexture

Returns undefined | ITexture<TextureEventMap>

pass

Returns undefined | T

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns GBufferRenderPass<"gbuffer", undefined | GBufferPluginTarget>

Protected_createTargetAndMaterial

Parameters

Returns void

Protected_disposeTarget

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

createMaterial

Returns GBufferMaterial

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | GBufferPlugin | Promise<null | GBufferPlugin>

getDepthNormal

Returns undefined | Texture<TextureEventMap>

Deprecated

getFlagsTexture

`Protected`_dirty

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`bufferType

`Readonly`isPrimaryGBuffer

`Optional`material

`Readonly`passId

`Optional`target

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected`_createPass

`Protected`_createTargetAndMaterial

`Protected`_disposeTarget

`Protected`_onViewerEvent

`Protected`_storeKey