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 full)

PipelinePassPlugin<GBufferPluginPass, "gbuffer", GBufferPluginEventTypes>
- GBufferPlugin

Constructors

constructor

new GBufferPlugin(bufferType?, isPrimaryGBuffer?, enabled?, renderFlagsBuffer?, renderDepthTexture?, depthTextureType?): 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:230

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _isPrimaryGBufferSet

_isPrimaryGBufferSet: boolean = false

`Protected` `Optional` _pass

_pass?: GBufferPluginPass

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

`Readonly` bufferType

bufferType: TextureDataType

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

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[] = []

`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 & DepthTexture
Returns undefined | ITexture & DepthTexture
- Defined in src/plugins/pipeline/GBufferPlugin.ts:92

dirty

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

flagsTexture

get flagsTexture(): undefined | ITexture
Returns undefined | ITexture
- Defined in src/plugins/pipeline/GBufferPlugin.ts:87

normalDepthTexture

get normalDepthTexture(): undefined | ITexture
Returns undefined | ITexture
- Defined in src/plugins/pipeline/GBufferPlugin.ts:82

pass

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

Methods

`Protected` _beforeRender

_beforeRender(scene, camera, renderManager): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- scene: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
- camera: ICamera<ICameraEvent, ICameraEventTypes>
- renderManager: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>
Returns boolean
Overrides PipelinePassPlugin._beforeRender
- Defined in src/plugins/pipeline/GBufferPlugin.ts:224

`Protected` _createPass

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

`Protected` _createTargetAndMaterial

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

`Protected` _disposeTarget

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

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

fromJSON

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

getDepthNormal

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

getFlagsTexture

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

getTarget

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

getUnpackSnippet

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

registerGBufferUpdater

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

setDirty

setDirty(): void
Returns void
Inherited from PipelinePassPlugin.setDirty
- Defined in src/plugins/base/PipelinePassPlugin.ts:72

toJSON

toJSON(meta?): ISerializedConfig & {
pass?: any;
}
Parameters
- Optional meta: SerializationMetaType
Returns ISerializedConfig & {
pass?: any;
}
Inherited from PipelinePassPlugin.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:64

unregisterGBufferUpdater

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

updateShaderProperties

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

Class GBufferPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

bufferType: TextureDataType = UnsignedByteType

isPrimaryGBuffer: boolean = true

enabled: boolean = true

renderFlagsBuffer: boolean = true

renderDepthTexture: boolean = false

depthTextureType: 1012 | 1014 | 1015 = UnsignedIntType

Returns GBufferPlugin

Properties

Protected _dirty

Private _isPrimaryGBufferSet

Protected Optional _pass

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Readonly bufferType

constructor

depthTextureType

enabled

Readonly isPrimaryGBuffer

Optional material

Readonly passId

renderDepthTexture

renderFlagsBuffer

Optional target

textures

Optional uiConfig

unpackExtension

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

depthTexture

Returns undefined | ITexture & DepthTexture

dirty

Returns boolean

Parameters

value: boolean

Returns void

flagsTexture

Returns undefined | ITexture

normalDepthTexture

Returns undefined | ITexture

pass

Returns undefined | T

Methods

Protected _beforeRender

Parameters

scene: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

camera: ICamera<ICameraEvent, ICameraEventTypes>

renderManager: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

Returns boolean

Protected _createPass

Returns GBufferRenderPass<"gbuffer", GBufferPluginTarget>

Protected _createTargetAndMaterial

Parameters

recreateTarget: boolean = true

Returns void

Protected _disposeTarget

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

`Protected` _dirty

`Private` _isPrimaryGBufferSet

`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

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}

material: {
defines: Record<string, undefined | string | number>;
needsUpdate?: boolean;
uniforms: {
[p: string]: IUniform;
};
}

`Optional` needsUpdate?: boolean

uniforms: {
[p: string]: IUniform;
}