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

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

Index

Constructors

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

`Protected` _viewerListeners

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

Type declaration

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

`Readonly` bufferType

bufferType: TextureDataType

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

`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:106
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:110

pass

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

Methods

`Protected` _beforeRender

_beforeRender(_?, _1?, _2?): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
- Optional _1: ICamera<ICameraEvent, ICameraEventTypes>
- Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>
Returns boolean
Inherited from PipelinePassPlugin._beforeRender
- Defined in src/plugins/base/PipelinePassPlugin.ts:27

`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` _onViewerEvent

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

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

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

importState

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

isDisabled

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

onAdded

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

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

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

Class NormalBufferPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

bufferType: TextureDataType = HalfFloatType

enabled: boolean = true

Returns NormalBufferPlugin

Properties

Protected _dirty

Protected Optional _pass

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Readonly bufferType

constructor

enabled

Readonly material

Readonly passId

Optional target

Optional texture

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

pass

Returns undefined | T

Methods

Protected _beforeRender

Parameters

Optional _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

Optional _1: ICamera<ICameraEvent, ICameraEventTypes>

Optional _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

Returns boolean

Protected _createPass

Returns GBufferRenderPass<"normal", WebGLRenderTarget>

Protected _createTarget

Parameters

recreate: boolean = true

Returns void

Protected _disposeTarget

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig & { pass?: any; }

Optional meta: SerializationMetaType

Returns null | NormalBufferPlugin | Promise<null | NormalBufferPlugin>

importState

`Protected` _dirty

`Protected` `Optional` _pass

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Readonly` bufferType

`Readonly` material

`Readonly` passId

`Optional` target

`Optional` texture

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _beforeRender

`Optional` _: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>

`Optional` _1: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` _2: IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>

`Protected` _createPass

`Protected` _createTarget

`Protected` _disposeTarget

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

data: ISerializedConfig & {
pass?: any;
}

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType

Returns ISerializedConfig & {
pass?: any;
}