Class NormalBufferPlugin

Normal Buffer Plugin

Adds a pre-render pass to render the normal buffer to a render target that can be used for postprocessing.

Hierarchy

PipelinePassPlugin<NormalBufferPluginPass, "normal", NormalBufferPluginEventTypes>
- NormalBufferPlugin

Index

Constructors

Properties

_dirty _pass? _viewer? bufferType constructor material passId target? texture? uiConfig? PluginType

Accessors

dirty enabled pass

Methods

_beforeRender _createPass _createTarget _disposeTarget _storeKey dispose exportState fromJSON importState onAdded onRemove setDirty toJSON

Constructors

constructor

new NormalBufferPlugin(bufferType?, enabled?): NormalBufferPlugin
Parameters
- bufferType: TextureDataType = HalfFloatType
- enabled: boolean = true
Returns NormalBufferPlugin
Overrides PipelinePassPlugin.constructor
- Defined in src/plugins/pipeline/NormalBufferPlugin.ts:95

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` `Optional` _pass

_pass?: NormalBufferPluginPass

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Readonly` bufferType

bufferType: TextureDataType

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Readonly` material

material: MeshNormalMaterial = ...

`Readonly` passId

passId: "normal" = 'normal'

`Optional` target

target?: WebGLRenderTarget

`Optional` texture

texture?: Texture

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "NormalBufferPlugin" = 'NormalBufferPlugin'

Accessors

dirty

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

enabled

get enabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.enabled
- Defined in src/plugins/base/PipelinePassPlugin.ts:10
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.enabled
- Defined in src/plugins/base/PipelinePassPlugin.ts:16

pass

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

Methods

`Protected` _beforeRender

_beforeRender(): boolean
Protected
This function is called every frame before composer render, if this pass is being used in the pipeline

Returns boolean
Inherited from PipelinePassPlugin._beforeRender
- Defined in src/plugins/base/PipelinePassPlugin.ts:32

`Protected` _createPass

_createPass(): GBufferRenderPass<"normal", WebGLRenderTarget>
Returns GBufferRenderPass<"normal", WebGLRenderTarget>
Overrides PipelinePassPlugin._createPass
- Defined in src/plugins/pipeline/NormalBufferPlugin.ts:82

`Protected` _createTarget

_createTarget(recreate?): void
Parameters
- recreate: boolean = true
Returns void
- Defined in src/plugins/pipeline/NormalBufferPlugin.ts:53

`Protected` _disposeTarget

_disposeTarget(): void
Returns void
- Defined in src/plugins/pipeline/NormalBufferPlugin.ts:73

`Protected` _storeKey

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

dispose

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

exportState

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

fromJSON

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

importState

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

onAdded

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

onRemove

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

setDirty

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

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

Generated using TypeDoc