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

BokehEffect

Extends:

three~EventDispatcherEffect → BokehEffect

Indirect Implements:

this class was deprecated. Use DepthOfFieldEffect instead.

A depth of field (bokeh) effect.

Original shader code by Martins Upitis: http://artmartinsh.blogspot.com/2010/02/glsl-lens-blur-filter-with-bokeh.html

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new bokeh effect.

Inherited Summary

From class Effect
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.

public

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

public

Returns the effect attributes.

public

Returns the fragment shader.

public

Returns the vertex shader.

public

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

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.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect has changed in a way that 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 bokeh 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.focus Number
  • optional
  • default: 0.5

The focus distance ratio, ranging from 0.0 to 1.0.

options.dof Number
  • optional
  • default: 0.02

Depth of field. An area in front of and behind the focal point that still appears sharp.

options.aperture Number
  • optional
  • default: 0.015

Camera aperture scale. Bigger values for stronger blur and shallower depth of field.

options.maxBlur Number
  • optional
  • default: 1.0

The maximum blur strength.