Skip to main content

Class: GBufferPlugin

Plugins.GBufferPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "GBuffer"

Defined in

webgi/src/plugins/GBufferPlugin.ts:32


passId

passId: "gbuffer"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/GBufferPlugin.ts:25


renderFlagsBuffer

renderFlagsBuffer: boolean = true


renderDepthTexture

renderDepthTexture: boolean = false


depthTextureType

depthTextureType: 1012 | 1014 | 1015 = UnsignedIntType


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/GBufferPlugin.ts:27


_afterFilters

Protected _afterFilters: never[] = []

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/GBufferPlugin.ts:28


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/GBufferPlugin.ts:29


_pass

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

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:9

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


viewer

get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

GenericFilterPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


material

get material(): undefined | DepthNormalMaterial

Returns

undefined | DepthNormalMaterial

Defined in

webgi/src/plugins/GBufferPlugin.ts:22


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:24

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:28


pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:69

Methods

exportState

exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

GenericFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88


passCtor

passCtor(v): GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget>

Parameters

NameType
vViewerApp

Returns

GBufferRenderPass<WebGLMultipleRenderTargets | WebGLRenderTarget>

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/GBufferPlugin.ts:38


getDepthNormal

getDepthNormal(): undefined | Texture

Returns

undefined | Texture

Defined in

webgi/src/plugins/GBufferPlugin.ts:97


getFlagsTexture

getFlagsTexture(): undefined | Texture

Returns

undefined | Texture

Defined in

webgi/src/plugins/GBufferPlugin.ts:100


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Overrides

GenericFilterPlugin.onDispose

Defined in

webgi/src/plugins/GBufferPlugin.ts:104


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/GBufferPlugin.ts:108


getTarget

getTarget(): undefined | WebGLMultipleRenderTargets | WebGLRenderTarget

Returns

undefined | WebGLMultipleRenderTargets | WebGLRenderTarget

Defined in

webgi/src/plugins/GBufferPlugin.ts:116


getDepthTexture

getDepthTexture(): undefined | DepthTexture

Returns

undefined | DepthTexture

Defined in

webgi/src/plugins/GBufferPlugin.ts:120


getUnpackSnippet

getUnpackSnippet(): string

Returns

string

Defined in

webgi/src/plugins/GBufferPlugin.ts:124


updateShaderProperties

updateShaderProperties(material): GBufferPlugin

Parameters

NameType
materialObject
material.definesRecord<string, undefined | string | number>
material.uniformsObject

Returns

GBufferPlugin

Implementation of

IShaderPropertiesUpdater.updateShaderProperties

Defined in

webgi/src/plugins/GBufferPlugin.ts:128


registerGBufferUpdater

registerGBufferUpdater(updater): void

Parameters

NameType
updater(object: Object3D<Event, string>, data: Vector4) => void

Returns

void

Defined in

webgi/src/plugins/GBufferPlugin.ts:142


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Inherited from

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:36


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:73


fromJSON

fromJSON(data, meta?): null | GBufferPlugin

Parameters

NameType
dataany
meta?any

Returns

null | GBufferPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:82


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64


_update

Protected _update(v): boolean

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

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/GBufferPlugin.ts:80

Constructors

constructor

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

Parameters

NameTypeDefault value
renderFlagsBufferbooleantrue
renderDepthTexturebooleanfalse
depthTextureType1012 | 1014 | 1015UnsignedIntType

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/GBufferPlugin.ts:89