import {RealisticBokehEffect} from 'postprocessing'

public class | source

RealisticBokehEffect

Extends:

three~EventDispatcher → Effect → RealisticBokehEffect

Indirect Implements:

this class was deprecated. Use DepthOfFieldEffect instead.

Depth of Field shader v2.4.

Yields more realistic results but is also more demanding.

Original shader code by Martins Upitis: http://blenderartists.org/forum/showthread.php?237488-GLSL-depth-of-field-with-bokeh-v2-4-(update)

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new bokeh effect.

Member Summary

Public Members
public get	manualDoF: Boolean Indicates whether the Depth of Field should be calculated manually.
public set	manualDoF
public get	pentagon: Boolean Indicates whether the blur shape should be pentagonal.
public set	pentagon
public get	rings: Number The amount of blur iterations.
public set	rings
public get	samples: Number The amount of blur samples per ring.
public set	samples
public get	showFocus: Boolean Indicates whether the focal point will be highlighted.
public set	showFocus

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 bokeh 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.focus	Number	optional default: 1.0	The focus distance in world units.
options.focalLength	Number	optional default: 24.0	The focal length of the main camera.
options.fStop	Number	optional default: 0.9	The ratio of the lens focal length to the diameter of the entrance pupil (aperture).
options.luminanceThreshold	Number	optional default: 0.5	A luminance threshold.
options.luminanceGain	Number	optional default: 2.0	A luminance gain factor.
options.bias	Number	optional default: 0.5	A blur bias.
options.fringe	Number	optional default: 0.7	A blur offset.
options.maxBlur	Number	optional default: 1.0	The maximum blur strength.
options.rings	Boolean	optional default: 3	The number of blur iterations.
options.samples	Boolean	optional default: 2	The amount of samples taken per ring.
options.showFocus	Boolean	optional default: false	Whether the focal point should be highlighted. Useful for debugging.
options.manualDoF	Boolean	optional default: false	Enables manual control over the depth of field.
options.pentagon	Boolean	optional default: false	Enables pentagonal blur shapes. Requires a high number of rings and samples.

Public Members

public get manualDoF: Boolean source

Indicates whether the Depth of Field should be calculated manually.

If enabled, the Depth of Field can be adjusted via the dof uniform.

public set manualDoF source

public get pentagon: Boolean source

Indicates whether the blur shape should be pentagonal.

public set pentagon source

public get rings: Number source

The amount of blur iterations.

public set rings source

public get samples: Number source

The amount of blur samples per ring.

public set samples source

public get showFocus: Boolean source

Indicates whether the focal point will be highlighted.