Class: GBufferPlugin

Plugins.GBufferPlugin

Hierarchy

• GenericFilterPlugin<GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget>, "gbuffer", "">

  ↳ GBufferPlugin

Implements

• IViewerPluginAsync
• IShaderPropertiesUpdater

Properties

PluginType

▪ Static Readonly PluginType: "GBuffer"

---

passId

• passId: "gbuffer"

Overrides

GenericFilterPlugin.passId

---

renderFlagsBuffer

• renderFlagsBuffer: boolean = true

---

renderDepthTexture

• renderDepthTexture: boolean = false

---

depthTextureType

• depthTextureType: 1012 | 1014 | 1015 = UnsignedIntType

---

_dirty

• Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

---

_beforeFilters

• Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

---

_afterFilters

• Protected _afterFilters: never[] = []

Overrides

GenericFilterPlugin._afterFilters

---

_requiredFilters

• Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

---

_pass

• Protected Optional _pass: IFilter<GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>>, "gbuffer">

Inherited from

GenericFilterPlugin._pass

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

GenericFilterPlugin.viewer

---

material

• get material(): undefined | DepthNormalMaterial

Returns

undefined | DepthNormalMaterial

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

---

pass

• get pass(): undefined | IFilter<T, TPassId>

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Methods

exportState

▸ exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

GenericFilterPlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

GenericFilterPlugin.loadState

---

passCtor

▸ passCtor(v): GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>>

Parameters

Name	Type
v	ViewerApp

Returns

GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>>

Overrides

GenericFilterPlugin.passCtor

---

getDepthNormal

▸ getDepthNormal(): undefined | Texture<TextureEventMap>

Returns

undefined | Texture<TextureEventMap>

---

getFlagsTexture

▸ getFlagsTexture(): undefined | Texture<TextureEventMap>

Returns

undefined | Texture<TextureEventMap>

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Overrides

GenericFilterPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

GenericFilterPlugin.onRemove

---

getTarget

▸ getTarget(): undefined | WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>

Returns

undefined | WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>

---

getDepthTexture

▸ getDepthTexture(): undefined | DepthTexture

Returns

undefined | DepthTexture

---

getUnpackSnippet

▸ getUnpackSnippet(): string

Returns

string

---

updateShaderProperties

▸ updateShaderProperties(material): GBufferPlugin

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

GBufferPlugin

Implementation of

IShaderPropertiesUpdater.updateShaderProperties

---

registerGBufferUpdater

▸ registerGBufferUpdater(updater): void

Parameters

Name	Type
updater	(object: Object3D<Object3DEventMap>, data: Vector4) => void

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Inherited from

GenericFilterPlugin.onAdded

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

GenericFilterPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | GBufferPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | GBufferPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

---

_update

▸ Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

Name	Type
v	ViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Constructors

constructor

• new GBufferPlugin(renderFlagsBuffer?, renderDepthTexture?, depthTextureType?)

Parameters

Name	Type	Default value
renderFlagsBuffer	boolean	true
renderDepthTexture	boolean	false
depthTextureType	1012 | 1014 | 1015	UnsignedIntType

Overrides

GenericFilterPlugin.constructor