Class BloomPlugin

Bloom Plugin

Adds HDR Bloom post-processing effect to the scene

Hierarchy

PipelinePassPlugin<BloomPluginPass<BloomPassId>, BloomPassId, "">
- BloomPlugin

Implements

GBufferUpdater

Index

Constructors

Properties

_pass? dependencies materialExtension passId uiConfig OldPluginType PluginType

Methods

_createPass onAdded onRemove updateGBufferFlags AddBloomData

Constructors

constructor

new BloomPlugin(): BloomPlugin
Returns BloomPlugin
Inherited from PipelinePassPlugin<BloomPluginPass<BloomPassId>, BloomPassId, ''>.constructor

Properties

`Protected` `Optional`_pass

_pass?: BloomPluginPass<"bloom">

dependencies

dependencies: typeof GBufferPlugin[] = ...

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

`Readonly`passId

passId: "bloom" = passId

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Readonly`OldPluginType

OldPluginType: "BloomPlugin" = 'BloomPlugin'

`Static` `Readonly`PluginType

PluginType: "Bloom" = 'Bloom'

Methods

`Protected`_createPass

_createPass(): BloomPluginPass<"bloom">
Returns BloomPluginPass<"bloom">
Overrides PipelinePassPlugin._createPass

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove

updateGBufferFlags

updateGBufferFlags(data: Vector4, c: GBufferUpdaterContext): void
Parameters
- data: Vector4
- c: GBufferUpdaterContext
Returns void
Implementation of GBufferUpdater.updateGBufferFlags

`Static`AddBloomData

AddBloomData(
    material: IMaterial,
    params?: { enable?: boolean },
    setDirty?: boolean,
): undefined | null | { enable?: boolean }
Parameters
- material: IMaterial
- Optionalparams: { enable?: boolean }
- setDirty: boolean = true
Returns undefined | null | { enable?: boolean }