Class BloomPlugin

Bloom Plugin

Adds HDR Bloom post-processing effect to the scene

Hierarchy

PipelinePassPlugin<BloomPluginPass<BloomPassId>, BloomPassId>
- BloomPlugin

Implements

GBufferUpdater

Constructors

constructor

new BloomPlugin(enabled?: boolean): BloomPlugin
Parameters
- enabled: boolean = true
Returns BloomPlugin
Overrides PipelinePassPlugin<BloomPluginPass<BloomPassId>, BloomPassId>.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:61

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_pass

_pass?: BloomPluginPass<"bloom">

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof GBufferPlugin[] = ...

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

`Readonly`passId

passId: "bloom" = passId

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Readonly`OldPluginType

OldPluginType: "BloomPlugin" = 'BloomPlugin'

`Static` `Readonly`PluginType

PluginType: "Bloom" = 'Bloom'

Accessors

dirty

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

pass

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

Methods

`Protected`_beforeRender

_beforeRender(
    _?: IScene<ISceneEventMap>,
    _1?: ICamera<ICameraEventMap>,
    _2?: IRenderManager<IRenderManagerEventMap>,
): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- Optional_: IScene<ISceneEventMap>
- Optional_1: ICamera<ICameraEventMap>
- Optional_2: IRenderManager<IRenderManagerEventMap>
Returns boolean
Inherited from PipelinePassPlugin._beforeRender
- Defined in src/plugins/base/PipelinePassPlugin.ts:34

`Protected`_createPass

_createPass(): BloomPluginPass<"bloom">
Returns BloomPluginPass<"bloom">
Overrides PipelinePassPlugin._createPass
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:56

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:70

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:86

setDirty

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

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig & { pass?: any }
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig & { pass?: any }
Inherited from PipelinePassPlugin.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:66

updateGBufferFlags

updateGBufferFlags(data: Vector4, c: GBufferUpdaterContext): void
Parameters
- data: Vector4
- c: GBufferUpdaterContext
Returns void
Implementation of GBufferUpdater.updateGBufferFlags
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:95

`Static`AddBloomData

AddBloomData(
    material: IMaterial,
    params?: { enable?: boolean },
    setDirty?: boolean,
): { enable?: boolean } | null | undefined
Parameters
- material: IMaterial
- Optionalparams: { enable?: boolean }
- setDirty: boolean = true
Returns { enable?: boolean } | null | undefined
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/BloomPlugin.ts:112

Class BloomPlugin

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BloomPlugin

Properties

Protected_dirty

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

isViewerPluginSync

ReadonlymaterialExtension

ReadonlypassId

uiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

pass

Returns T | undefined

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns BloomPluginPass<"bloom">

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns BloomPlugin | Promise<BloomPlugin | null> | null

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig & { pass?: any }

updateGBufferFlags

Parameters

Returns void

StaticAddBloomData

Parameters

Returns { enable?: boolean } | null | undefined

`Protected`_dirty

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`materialExtension

`Readonly`passId

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_beforeRender

`Protected`_createPass

`Protected`_onViewerEvent

`Protected`_storeKey

`Static`AddBloomData