Class AScreenPassExtensionPlugin<T>`Abstract`

Base Screen Pass Extension Plugin

Extend the class to add an extension to ScreenPass material. See TonemapPlugin and VignettePlugin for examples.

Type Parameters

T extends string

Hierarchy (View Summary)

AViewerPluginSync<T>
- AScreenPassExtensionPlugin

Implements

Constructors

constructor

new AScreenPassExtensionPlugin<T extends string>(
shaderPatch?: string,
): AScreenPassExtensionPlugin<T>
Type Parameters
- T extends string
Parameters
- shaderPatch: string = ''
Returns AScreenPassExtensionPlugin<T>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:27

Properties

`Optional`__setDirty

__setDirty?: () => void

`Protected`_dirty

_dirty: boolean = false

`Protected`_shaderPatch

_shaderPatch: string = ''

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AScreenPassExtensionPlugin & typeof AViewerPluginSync & typeof AViewerPlugin

`Abstract`enabled

enabled: boolean

priority

priority: number = -100

The priority of the material extension when applied to the material in ScreenPass set to very low priority, so applied at the end

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

uniformsNeedUpdate

set uniformsNeedUpdate(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:23

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

computeCacheKey

computeCacheKey(_: IMaterial): "0" | "1"
Parameters
- _: IMaterial
Returns "0" | "1"
Implementation of MaterialExtension.computeCacheKey
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:55

disable

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

dispose

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

enable

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

exportState

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

fromJSON

fromJSON(
    data: any,
    meta?: any,
):
    | null
    | AScreenPassExtensionPlugin<T>
    | Promise<null | AScreenPassExtensionPlugin<T>>
Parameters
- data: any
- Optionalmeta: any
Returns
    | null
    | AScreenPassExtensionPlugin<T>
    | Promise<null | AScreenPassExtensionPlugin<T>>
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:66

getUiConfig

getUiConfig(): any
Function to return the UI config for this material extension. This is called once when the material extension is registered.

Returns any
Implementation of MaterialExtension.getUiConfig
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:51

importState

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

isCompatible

isCompatible(_: IMaterial): boolean
Function to check if this material extension is compatible with the given material. If not compatible, the material extension will not be applied. This is only checked when the extension is registered.
Parameters
- _: IMaterial
Returns boolean
Implementation of MaterialExtension.isCompatible
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:57

isDisabled

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

shaderExtender

shaderExtender(shader: Shader, _: IMaterial, _1: WebGLRenderer): void
Custom callback to extend/modify/replace shader code and other shader properties
Parameters
- shader: Shader
- _: IMaterial
- _1: WebGLRenderer
Returns void
Implementation of MaterialExtension.shaderExtender
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:41

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

updateGBufferFlags

updateGBufferFlags(_: Vector4, _1: GBufferUpdaterContext): void
Parameters
- _: Vector4
- _1: GBufferUpdaterContext
Returns void
Implementation of GBufferUpdater.updateGBufferFlags
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:102

Class AScreenPassExtensionPlugin<T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AScreenPassExtensionPlugin<T>

Properties

Optional__setDirty

Protected_dirty

Protected_shaderPatch

Protected Optional_viewer

Protected_viewerListeners

constructor

Abstractenabled

priority

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

uniformsNeedUpdate

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

computeCacheKey

Parameters

Returns "0" | "1"

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns | null | AScreenPassExtensionPlugin<T> | Promise<null | AScreenPassExtensionPlugin<T>>

getUiConfig

Returns any

importState

Parameters

Returns Promise<void>

isCompatible

Parameters

Returns boolean

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

shaderExtender

Parameters

Returns void

toJSON

Parameters

Class AScreenPassExtensionPlugin<T>`Abstract`

`Optional`__setDirty

`Protected`_dirty

`Protected`_shaderPatch

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Abstract`enabled

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| null
| AScreenPassExtensionPlugin<T>
| Promise<null | AScreenPassExtensionPlugin<T>>