Home Reference Source
import {VignetteEffect} from 'postprocessing'
public class | source

VignetteEffect

Extends:

three~EventDispatcherEffect → VignetteEffect

Indirect Implements:

A Vignette effect.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new Vignette effect.

Member Summary

Public Members
public get

The Vignette darkness.

public set
public get
this get was deprecated. Use technique instead.

Indicates whether Eskil's Vignette technique is enabled.

public set
this set was deprecated. Use technique instead.

Indicates whether Eskil's Vignette technique is enabled.

public get

The Vignette offset.

public set
public get

The Vignette technique.

public set

Method Summary

Public Methods
public
this method was deprecated. Use darkness instead.

Returns the Vignette darkness.

public
this method was deprecated. Use offset instead.

Returns the Vignette offset.

public
this method was deprecated. Use technique instead.

Returns the Vignette technique.

public
this method was deprecated. Use darkness instead.

Sets the Vignette darkness.

public

setOffset(value: Number)

this method was deprecated. Use offset instead.

Sets the Vignette offset.

public
this method was deprecated. Use technique instead.

Sets the Vignette technique.

Inherited Summary

From class Effect
public get

inputColorSpace: ColorSpace

this get is experimental.

The input color space.

public set

mainCamera: Camera

Sets the main camera.

public set

mainScene: Scene

Sets the main scene.

public get

outputColorSpace: ColorSpace

this get is experimental.

The output color space.

protected set

inputColorSpace: ColorSpace

this set is experimental.
protected set

outputColorSpace: ColorSpace

this set is experimental.
public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

protected

renderer: WebGLRenderer

this member was deprecated.

The renderer.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

Returns the effect attributes.

public
this method was deprecated. Use blendMode instead.

Returns the blend mode.

public
this method was deprecated. Use defines instead.

Returns the preprocessor macro definitions.

public
this method was deprecated. Use extensions instead.

Returns the WebGL extensions that are required by this effect.

public

Returns the fragment shader.

public
this method was deprecated. Use name instead.

Returns the name of this effect.

public

getUniforms(): Map<String, Uniform>

this method was deprecated. Use uniforms instead.

Returns the uniforms of this effect.

public

Returns the vertex shader.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies)

Sets the depth texture.

public

setRenderer(renderer: WebGLRenderer)

this method was deprecated.

Sets the renderer.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates this effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect requires a shader recompilation.

protected

setFragmentShader(fragmentShader: String)

Sets the fragment shader.

protected

setVertexShader(vertexShader: String)

Sets the vertex shader.

Public Constructors

public constructor(options: Object) source

Constructs a new Vignette effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional

The blend function of this effect.

options.technique VignetteTechnique
  • optional
  • default: VignetteTechnique.DEFAULT

The Vignette technique.

options.eskil Boolean
  • optional
  • default: false

Deprecated. Use technique instead.

options.offset Number
  • optional
  • default: 0.5

The Vignette offset.

options.darkness Number
  • optional
  • default: 0.5

The Vignette darkness.

Public Members

public get darkness: Number source

The Vignette darkness.

public set darkness source

public get eskil: Boolean source

this get was deprecated. Use technique instead.

Indicates whether Eskil's Vignette technique is enabled.

public set eskil: Boolean source

this set was deprecated. Use technique instead.

Indicates whether Eskil's Vignette technique is enabled.

public get offset: Number source

The Vignette offset.

public set offset source

public get technique: VignetteTechnique source

The Vignette technique.

public set technique source

Public Methods

public getDarkness(): Number source

this method was deprecated. Use darkness instead.

Returns the Vignette darkness.

Return:

Number

The darkness.

public getOffset(): Number source

this method was deprecated. Use offset instead.

Returns the Vignette offset.

Return:

Number

The offset.

public getTechnique(): VignetteTechnique source

this method was deprecated. Use technique instead.

Returns the Vignette technique.

Return:

VignetteTechnique

The technique.

public setDarkness(value: Number) source

this method was deprecated. Use darkness instead.

Sets the Vignette darkness.

Params:

NameTypeAttributeDescription
value Number

The darkness.

public setOffset(value: Number) source

this method was deprecated. Use offset instead.

Sets the Vignette offset.

Params:

NameTypeAttributeDescription
value Number

The offset.

public setTechnique(value: VignetteTechnique) source

this method was deprecated. Use technique instead.

Sets the Vignette technique.

Params:

NameTypeAttributeDescription
value VignetteTechnique

The technique.