import {VignetteEffect} from 'postprocessing'

public class | source

VignetteEffect

Extends:

three~EventDispatcher → 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	darkness: Number The Vignette darkness.
public set	darkness
public get	eskil: Boolean this get was deprecated. Use technique instead. Indicates whether Eskil's Vignette technique is enabled.
public set	eskil: Boolean this set was deprecated. Use technique instead. Indicates whether Eskil's Vignette technique is enabled.
public get	offset: Number The Vignette offset.
public set	offset
public get	technique: VignetteTechnique The Vignette technique.
public set	technique

Method Summary

Public Methods
public	getDarkness(): Number this method was deprecated. Use darkness instead. Returns the Vignette darkness.
public	getOffset(): Number this method was deprecated. Use offset instead. Returns the Vignette offset.
public	getTechnique(): VignetteTechnique this method was deprecated. Use technique instead. Returns the Vignette technique.
public	setDarkness(value: Number) 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	setTechnique(value: VignetteTechnique) 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	blendMode: BlendMode The blend mode of this effect.
public	defines: Map<String, String> Preprocessor macro definitions.
public	extensions: Set<WebGLExtension> WebGL extensions that are required by this effect.
public	name: String The name of this effect.
public	uniforms: Map<String, Uniform> Shader uniforms.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
public	dispose() Performs a shallow search for properties that define a dispose method and deletes them.
public	getAttributes(): EffectAttribute Returns the effect attributes.
public	getBlendMode(): BlendMode this method was deprecated. Use blendMode instead. Returns the blend mode.
public	getDefines(): Map<String, String> this method was deprecated. Use defines instead. Returns the preprocessor macro definitions.
public	getExtensions(): Set<WebGLExtension> this method was deprecated. Use extensions instead. Returns the WebGL extensions that are required by this effect.
public	getFragmentShader(): String Returns the fragment shader.
public	getName(): String 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	getVertexShader(): String 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	setAttributes(attributes: EffectAttribute) Sets the effect attributes.
protected	setChanged() 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:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
value	Number		The darkness.

public setOffset(value: Number) source

this method was deprecated. Use offset instead.

Sets the Vignette offset.

Params:

Name	Type	Attribute	Description
value	Number		The offset.

public setTechnique(value: VignetteTechnique) source

this method was deprecated. Use technique instead.

Sets the Vignette technique.

Params:

Name	Type	Attribute	Description
value	VignetteTechnique		The technique.