Home Reference Source
import {VignetteEffect} from 'postprocessing/src/effects/VignetteEffect.js'
public class | source

VignetteEffect

Extends:

Effect → 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

Indicates whether Eskil's vignette technique is enabled.

public set

Enables or disables Eskil's vignette technique.

You'll need to call EffectPass#recompile after changing this value.

Inherited Summary

From class Effect
public

The effect attributes.

public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The fragment shader.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

The vertex shader.

public

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

public

initialize(renderer: WebGLRenderer, alpha: Boolean)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

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

Updates the effect by performing supporting operations.

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
  • default: BlendFunction.NORMAL

The blend function of this effect.

options.eskil Boolean
  • optional
  • default: false

Enables Eskil's vignette technique.

options.offset Number
  • optional
  • default: 0.5

The vignette offset.

options.darkness Number
  • optional
  • default: 0.5

The vignette darkness.

Public Members

public get eskil: Boolean source

Indicates whether Eskil's vignette technique is enabled.

public set eskil: Boolean source

Enables or disables Eskil's vignette technique.

You'll need to call EffectPass#recompile after changing this value.