Class VignettePlugin

Vignette Plugin

Adds an extension to ScreenPass material for applying vignette effect on the final buffer before rendering to screen. The power of the vignette can be controlled with the power property. The color of the vignette can be controlled with the color(previously bgcolor) property.

Hierarchy (View Summary)

AScreenPassExtensionPlugin
- VignettePlugin

Constructors

constructor

new VignettePlugin(enabled?: boolean): VignettePlugin
Parameters
- enabled: boolean = true
Returns VignettePlugin
Overrides AScreenPassExtensionPlugin.constructor
- Defined in src/plugins/postprocessing/VignettePlugin.ts:72

Properties

`Optional`__setDirty

__setDirty?: () => void

`Protected`_dirty

_dirty: boolean = false

`Protected`_shaderPatch

_shaderPatch: string = 'diffuseColor = Vignette(diffuseColor);'

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

color

color: Color = ...

constructor

constructor: typeof AScreenPassExtensionPlugin & typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean

`Readonly`extraUniforms

extraUniforms: { bgcolor: { value: Color }; power: { value: 1 } } = ...

power

power: number = 0.5

priority

priority: number = -50

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<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "Vignette" = 'Vignette'

Accessors

bgcolor

get bgcolor(): Color
Returns Color
Deprecated
- Defined in src/plugins/postprocessing/VignettePlugin.ts:60
set bgcolor(v: Color): void
Parameters
- v: Color
Returns void
Deprecated
- Defined in src/plugins/postprocessing/VignettePlugin.ts:67

dirty

get dirty(): boolean
Returns boolean
Inherited from AScreenPassExtensionPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AScreenPassExtensionPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

uniformsNeedUpdate

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

computeCacheKey

computeCacheKey(_: IMaterial): "0" | "1"
Parameters
- _: IMaterial
Returns "0" | "1"
Inherited from AScreenPassExtensionPlugin.computeCacheKey
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:56

disable

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

dispose

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

enable

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

exportState

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

fromJSON

fromJSON(
data: any,
meta?: any,
): null | VignettePlugin | Promise<null | VignettePlugin>
Parameters
- data: any
- Optionalmeta: any
Returns null | VignettePlugin | Promise<null | VignettePlugin>
Inherited from AScreenPassExtensionPlugin.fromJSON
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:67

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
Inherited from AScreenPassExtensionPlugin.getUiConfig
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:52

importState

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

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 added to the material. This is only checked when the extension is registered.

The extension is assumed to be compatible if this function is not defined
Parameters
- _: IMaterial
Returns boolean
Inherited from AScreenPassExtensionPlugin.isCompatible
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:58

parsFragmentSnippet

parsFragmentSnippet(): string
Returns string
- Defined in src/plugins/postprocessing/VignettePlugin.ts:45

setDirty

setDirty(): void
Returns void
Inherited from AScreenPassExtensionPlugin.setDirty
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:62

shaderExtender

shaderExtender(
    shader: WebGLProgramParametersWithUniforms,
    _: IMaterial,
    _1: WebGLRenderer,
): void
Custom callback to extend/modify/replace shader code and other shader properties
Parameters
- shader: WebGLProgramParametersWithUniforms
- _: IMaterial
- _1: WebGLRenderer
Returns void
Inherited from AScreenPassExtensionPlugin.shaderExtender
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:42

toJSON

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

updateGBufferFlags

updateGBufferFlags(_: Vector4, _1: GBufferUpdaterContext): void
Parameters
- _: Vector4
- _1: GBufferUpdaterContext
Returns void
Inherited from AScreenPassExtensionPlugin.updateGBufferFlags
- Defined in src/plugins/postprocessing/AScreenPassExtensionPlugin.ts:103

Class VignettePlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VignettePlugin

Properties

Optional__setDirty

Protected_dirty

Protected_shaderPatch

Protected Optional_viewer

Protected_viewerListeners

color

constructor

enabled

ReadonlyextraUniforms

power

priority

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

bgcolor

Returns Color

Deprecated

Parameters

Returns void

Deprecated

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 | VignettePlugin | Promise<null | VignettePlugin>

getUiConfig

Returns any

importState

Parameters

Returns Promise<void>

isCompatible

Parameters

Returns boolean

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

parsFragmentSnippet

`Optional`__setDirty

`Protected`_dirty

`Protected`_shaderPatch

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`extraUniforms

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey