Class VignetteEffect

A Vignette effect.

Hierarchy (View Summary)

Effect
- VignetteEffect

Constructors

constructor

new VignetteEffect(
    options?: {
        blendFunction?: BlendFunction;
        darkness?: number;
        eskil?: boolean;
        offset?: number;
        technique?: VignetteTechnique;
    },
): VignetteEffect
Constructs a new Vignette effect.
Parameters
- Optionaloptions: {
      blendFunction?: BlendFunction;
      darkness?: number;
      eskil?: boolean;
      offset?: number;
      technique?: VignetteTechnique;
  }
  The options.
  - OptionalblendFunction?: BlendFunction
    The blend function of this effect.
  - Optionaldarkness?: number
    The Vignette darkness.
  - Optionaleskil?: boolean
    Deprecated. Use technique instead.
  - Optionaloffset?: number
    The Vignette offset.
  - Optionaltechnique?: VignetteTechnique
    The Vignette technique.
Returns VignetteEffect
Overrides Effect.constructor

Properties

`Readonly`blendMode

blendMode: BlendMode

The blend mode of this effect.

`Readonly`defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

`Readonly`extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name

name: string

The name of this effect.

`Protected`renderer

renderer: WebGLRenderer

The renderer.

Deprecated

`Readonly`uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

darkness

get darkness(): number
The Vignette darkness.

Returns number
set darkness(arg: number): void
Parameters
- arg: number
Returns void

eskil

get eskil(): boolean
Indicates whether Eskil's Vignette technique is enabled.

Returns boolean
Deprecated
Use technique instead.
set eskil(arg: boolean): void
Indicates whether Eskil's Vignette technique is enabled.
Parameters
- arg: boolean
Returns void
Deprecated
Use technique instead.

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace
Inherited from Effect.inputColorSpace
set inputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

mainCamera

set mainCamera(arg: Camera): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg: Scene): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

offset

get offset(): number
The Vignette offset.

Returns number
set offset(arg: number): void
Parameters
- arg: number
Returns void

outputColorSpace

get outputColorSpace(): ColorSpace
Experimental
The output color space.

Should only be changed if this effect converts the input colors to a different color space.

Returns ColorSpace
Inherited from Effect.outputColorSpace
set outputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

technique

get technique(): VignetteTechnique
The Vignette technique.

Returns VignetteTechnique
set technique(arg: VignetteTechnique): void
Parameters
- arg: VignetteTechnique
Returns void

Methods

addEventListener

addEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener
addEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, VignetteEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, VignetteEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener

dispatchEvent

dispatchEvent<T extends keyof Event<string, unknown>>(
event: BaseEvent<T> & Event<string, unknown>[T],
): void
Fire an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- event: BaseEvent<T> & Event<string, unknown>[T]
  The event that gets fired.
Returns void
Inherited from Effect.dispatchEvent

dispose

dispose(): void
Performs a shallow search for properties that define a dispose method and deletes them.

The EffectComposer calls this method when it is being destroyed.

Returns void
Inherited from Effect.dispose

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.getAttributes

getBlendMode

getBlendMode(): BlendMode
Returns the blend mode.

The result of this effect will be blended with the result of the previous effect using this blend mode.

Returns BlendMode
The blend mode.

Deprecated
Use blendMode instead.

Inherited from Effect.getBlendMode

getDarkness

getDarkness(): number
Returns the Vignette darkness.

Returns number
The darkness.

Deprecated
Use darkness instead.

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

getName

getName(): string
Returns the name of this effect.

Returns string
The name.

Deprecated
Use name instead.

Inherited from Effect.getName

getOffset

getOffset(): number
Returns the Vignette offset.

Returns number
The offset.

Deprecated
Use offset instead.

getTechnique

getTechnique(): VignetteTechnique
Returns the Vignette technique.

Returns VignetteTechnique
The technique.

Deprecated
Use technique instead.

getUniforms

getUniforms(): Map<string, Uniform<any>>
Returns the uniforms of this effect.

Returns Map<string, Uniform<any>>
The extensions.

Deprecated
Use uniforms instead.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

hasEventListener

hasEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener
hasEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, VignetteEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, VignetteEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener

initialize

initialize(
    renderer: WebGLRenderer,
    alpha: boolean,
    frameBufferType: number,
): void
Performs initialization tasks.

This method is called when the associated EffectPass is added to an EffectComposer.
Parameters
- renderer: WebGLRenderer
  The renderer.
- alpha: boolean
  Whether the renderer uses the alpha channel or not.
- frameBufferType: number
  The type of the main frame buffers.
Returns void
Example
```
if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }
```
Inherited from Effect.initialize

removeEventListener

removeEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<Event<string, unknown>[T], T, VignetteEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener
removeEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, VignetteEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}, T, VignetteEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener

`Protected`setAttributes

setAttributes(attributes: EffectAttribute): void
Protected
Sets the effect attributes.

Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.
Parameters
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

`Protected`setChanged

setChanged(): void
Protected
Informs the associated EffectPass that this effect requires a shader recompilation.

Should be called after changing macros or extensions and after adding/removing uniforms.

Returns void
Inherited from Effect.setChanged

setDarkness

setDarkness(value: number): void
Sets the Vignette darkness.
Parameters
- value: number
  The darkness.
Returns void
Deprecated
Use darkness instead.

setDepthTexture

setDepthTexture(
depthTexture: Texture,
depthPacking?: DepthPackingStrategies,
): void
Sets the depth texture.

You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.
Parameters
- depthTexture: Texture
  A depth texture.
- OptionaldepthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Effect.setDepthTexture

`Protected`setFragmentShader

setFragmentShader(fragmentShader: string): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

setOffset

setOffset(value: number): void
Sets the Vignette offset.
Parameters
- value: number
  The offset.
Returns void
Deprecated
Use offset instead.

setRenderer

setRenderer(renderer: WebGLRenderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Effect.setRenderer

setSize

setSize(width: number, height: number): void
Updates the size of this effect.

You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Inherited from Effect.setSize

setTechnique

setTechnique(value: VignetteTechnique): void
Sets the Vignette technique.
Parameters
- value: VignetteTechnique
  The technique.
Returns void
Deprecated
Use technique instead.

`Protected`setVertexShader

setVertexShader(vertexShader: string): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

update

update(
    renderer: WebGLRenderer,
    inputBuffer: WebGLRenderTarget,
    deltaTime?: number,
): void
Updates this effect by performing supporting operations.

This method is called by the EffectPass right before the main fullscreen render operation, even if the blend function is set to SKIP.

You may override this method if you need to update custom uniforms or render additional off-screen textures.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget
  A frame buffer that contains the result of the previous pass.
- OptionaldeltaTime: number
  The time between the last frame and the current one in seconds.
Returns void
Inherited from Effect.update

Class VignetteEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalblendFunction?: BlendFunction

Optionaldarkness?: number

Optionaleskil?: boolean

Optionaloffset?: number

Optionaltechnique?: VignetteTechnique

Returns VignetteEffect

Properties

ReadonlyblendMode

Readonlydefines

Readonlyextensions

name

Protectedrenderer

Deprecated

Readonlyuniforms

Accessors

darkness

Returns number

Parameters

Returns void

eskil

Returns boolean

Deprecated

Parameters

Returns void

Deprecated

inputColorSpace

Returns ColorSpace

Parameters

Returns void

mainCamera

Parameters

Returns void

mainScene

Parameters

Returns void

offset

Returns number

Parameters

Returns void

outputColorSpace

Returns ColorSpace

Parameters

Returns void

technique

Returns VignetteTechnique

Parameters

Returns void

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

getAttributes

Returns EffectAttribute

getBlendMode

Returns BlendMode

Deprecated

getDarkness

Returns number

Deprecated

getDefines

`Optional`blendFunction?: BlendFunction

`Optional`darkness?: number

`Optional`eskil?: boolean

`Optional`offset?: number

`Optional`technique?: VignetteTechnique

`Readonly`blendMode

`Readonly`defines

`Readonly`extensions

`Protected`renderer

`Readonly`uniforms

`Protected`setAttributes

`Protected`setChanged

`Protected`setFragmentShader

`Protected`setVertexShader