import {RealisticBokehEffect} from 'postprocessing/src/effects/RealisticBokehEffect.js'
RealisticBokehEffect
Extends:
Indirect Implements:
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 |
Indicates whether the Depth of Field should be calculated manually. |
|
public set |
Enables or disables manual Depth of Field. |
|
public get |
Indicates whether the blur shape should be pentagonal. |
|
public set |
Enables or disables pentagonal blur. |
|
public get |
The amount of blur iterations. |
|
public set |
Sets the amount of blur iterations. |
|
public get |
The amount of blur samples per ring. |
|
public set |
Sets the amount of blur samples per ring. |
|
public get |
Indicates whether the focal point will be highlighted. |
|
public set |
Enables or disables focal point highlighting. |
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 |
Shader uniforms. |
|
public |
The vertex shader. |
|
public |
dispose() 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 |
Updates the size of this effect. |
|
public |
Updates the effect by performing supporting operations. |
Public Constructors
public constructor(options: Object) source
Constructs a new bokeh effect.
Override:
Effect#constructorParams:
Name | Type | Attribute | Description |
options | Object |
|
The options. |
options.blendFunction | BlendFunction |
|
The blend function of this effect. |
options.focus | Number |
|
The focus distance in world units. |
options.focalLength | Number |
|
The focal length of the main camera. |
options.luminanceThreshold | Number |
|
A luminance threshold. |
options.luminanceGain | Number |
|
A luminance gain factor. |
options.bias | Number |
|
A blur bias. |
options.fringe | Number |
|
A blur offset. |
options.maxBlur | Number |
|
The maximum blur strength. |
options.rings | Boolean |
|
The number of blur iterations. |
options.samples | Boolean |
|
The amount of samples taken per ring. |
options.showFocus | Boolean |
|
Whether the focal point should be highlighted. Useful for debugging. |
options.manualDoF | Boolean |
|
Enables manual control over the depth of field. |
options.pentagon | Boolean |
|
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: Boolean source
Enables or disables manual Depth of Field.
You'll need to call EffectPass#recompile after changing this value.
public set pentagon: Boolean source
Enables or disables pentagonal blur.
You'll need to call EffectPass#recompile after changing this value.
public set rings: Number source
Sets the amount of blur iterations.
You'll need to call EffectPass#recompile after changing this value.
public set samples: Number source
Sets the amount of blur samples per ring.
You'll need to call EffectPass#recompile after changing this value.
public set showFocus: Boolean source
Enables or disables focal point highlighting.
You'll need to call EffectPass#recompile after changing this value.