Class DepthOfFieldEffect

A depth of field effect.

Based on a graphics study by Adrian Courrèges and an article by Steve Avery: https://www.adriancourreges.com/blog/2016/09/09/doom-2016-graphics-study/ https://pixelmischiefblog.wordpress.com/2016/11/25/bokeh-depth-of-field/

Hierarchy (View Summary)

Effect
- DepthOfFieldEffect

Constructors

constructor

new DepthOfFieldEffect(
    camera?: Camera,
    options?: {
        blendFunction?: BlendFunction;
        bokehScale?: number;
        focalLength?: number;
        focusDistance?: number;
        focusRange?: number;
        height?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        width?: number;
        worldFocusDistance?: number;
        worldFocusRange?: number;
    },
): DepthOfFieldEffect
Constructs a new depth of field effect.
Parameters
- Optionalcamera: Camera
  The main camera.
- Optionaloptions: {
      blendFunction?: BlendFunction;
      bokehScale?: number;
      focalLength?: number;
      focusDistance?: number;
      focusRange?: number;
      height?: number;
      resolutionScale?: number;
      resolutionX?: number;
      resolutionY?: number;
      width?: number;
      worldFocusDistance?: number;
      worldFocusRange?: number;
  }
  The options.
  - OptionalblendFunction?: BlendFunction
    The blend function of this effect.
  - OptionalbokehScale?: number
    The scale of the bokeh blur.
  - OptionalfocalLength?: number
    The focal length. Range is [0.0, 1.0].
  - OptionalfocusDistance?: number
    The normalized focus distance. Range is [0.0, 1.0].
  - OptionalfocusRange?: number
    The focus range. Range is [0.0, 1.0].
  - Optionalheight?: number
    Deprecated. Use resolutionY instead.
  - OptionalresolutionScale?: number
    The resolution scale.
  - OptionalresolutionX?: number
    The horizontal resolution.
  - OptionalresolutionY?: number
    The vertical resolution.
  - Optionalwidth?: number
    Deprecated. Use resolutionX instead.
  - OptionalworldFocusDistance?: number
    The focus distance in world units.
  - OptionalworldFocusRange?: number
    The focus distance in world units.
Returns DepthOfFieldEffect
Overrides Effect.constructor

Properties

`Readonly`blendMode

blendMode: BlendMode

The blend mode of this effect.

`Readonly`blurPass

blurPass: KawaseBlurPass

This pass blurs the foreground CoC buffer to soften edges.

`Readonly`defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

`Readonly`extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name

name: string

The name of this effect.

`Protected`renderer

renderer: WebGLRenderer

The renderer.

Deprecated

target

target: Vector3

A target position that should be kept in focus. Set to null to disable auto focus.

`Readonly`uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

bokehScale

get bokehScale(): number
The current bokeh scale.

Returns number
set bokehScale(arg: number): void
Parameters
- arg: number
Returns void

circleOfConfusionMaterial

get circleOfConfusionMaterial(): CircleOfConfusionMaterial
The circle of confusion material.

Returns CircleOfConfusionMaterial
Deprecated
Use cocMaterial instead.

cocMaterial

get cocMaterial(): CircleOfConfusionMaterial
The circle of confusion material.

Returns CircleOfConfusionMaterial

cocTexture

get cocTexture(): Texture
The circle of confusion texture.

Returns Texture

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace
Inherited from Effect.inputColorSpace
set inputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

mainCamera

set mainCamera(arg: Camera): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg: Scene): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

maskFunction

get maskFunction(): MaskFunction
The mask function. Default is MULTIPLY_RGB.

Returns MaskFunction
set maskFunction(arg: MaskFunction): void
Parameters
- arg: MaskFunction
Returns void

outputColorSpace

get outputColorSpace(): ColorSpace
Experimental
The output color space.

Should only be changed if this effect converts the input colors to a different color space.

Returns ColorSpace
Inherited from Effect.outputColorSpace
set outputColorSpace(arg: ColorSpace): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

resolution

get resolution(): Resolution
The resolution of this effect.

Returns Resolution

Methods

addEventListener

addEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener
addEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, DepthOfFieldEffect>,
): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, DepthOfFieldEffect>
  The function that gets called when the event is fired.
Returns void
Inherited from Effect.addEventListener

calculateFocusDistance

calculateFocusDistance(target: Vector3): number
Calculates the focus distance from the camera to the given position.
Parameters
- target: Vector3
  The target.
Returns number
The normalized focus distance.

dispatchEvent

dispatchEvent<T extends keyof Event<string, unknown>>(
event: BaseEvent<T> & Event<string, unknown>[T],
): void
Fire an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- event: BaseEvent<T> & Event<string, unknown>[T]
  The event that gets fired.
Returns void
Inherited from Effect.dispatchEvent

dispose

dispose(): void
Performs a shallow search for properties that define a dispose method and deletes them.

The EffectComposer calls this method when it is being destroyed.

Returns void
Inherited from Effect.dispose

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.getAttributes

getBlendMode

getBlendMode(): BlendMode
Returns the blend mode.

The result of this effect will be blended with the result of the previous effect using this blend mode.

Returns BlendMode
The blend mode.

Deprecated
Use blendMode instead.

Inherited from Effect.getBlendMode

getBlurPass

getBlurPass(): KawaseBlurPass
Returns the pass that blurs the foreground CoC buffer to soften edges.

Returns KawaseBlurPass
The blur pass.

Deprecated
Use blurPass instead.

getBokehScale

getBokehScale(): number
Returns the current bokeh scale.

Returns number
The scale.

Deprecated
Use bokehScale instead.

getCircleOfConfusionMaterial

getCircleOfConfusionMaterial(): CircleOfConfusionMaterial
Returns the circle of confusion material.

Returns CircleOfConfusionMaterial
The material.

Deprecated
Use cocMaterial instead.

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

getName

getName(): string
Returns the name of this effect.

Returns string
The name.

Deprecated
Use name instead.

Inherited from Effect.getName

getResolution

getResolution(): Resolution
Returns the resolution settings.

Returns Resolution
The resolution.

Deprecated
Use resolution instead.

getTarget

getTarget(): Vector3
Returns the current auto focus target.

Returns Vector3
The target.

Deprecated
Use target instead.

getUniforms

getUniforms(): Map<string, Uniform<any>>
Returns the uniforms of this effect.

Returns Map<string, Uniform<any>>
The extensions.

Deprecated
Use uniforms instead.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

hasEventListener

hasEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener
hasEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, DepthOfFieldEffect>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}, T, DepthOfFieldEffect>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Effect.hasEventListener

initialize

initialize(
    renderer: WebGLRenderer,
    alpha: boolean,
    frameBufferType: number,
): void
Performs initialization tasks.
Parameters
- renderer: WebGLRenderer
  The renderer.
- alpha: boolean
  Whether the renderer uses the alpha channel or not.
- frameBufferType: number
  The type of the main frame buffers.
Returns void
Overrides Effect.initialize

removeEventListener

removeEventListener<T extends keyof Event<string, unknown>>(
type: T,
listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Event<string, unknown>
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<Event<string, unknown>[T], T, DepthOfFieldEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener
removeEventListener<T extends string>(
type: T,
listener: EventListener<{}, T, DepthOfFieldEffect>,
): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}, T, DepthOfFieldEffect>
  The listener function that gets removed.
Returns void
Inherited from Effect.removeEventListener

`Protected`setAttributes

setAttributes(attributes: EffectAttribute): void
Protected
Sets the effect attributes.

Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.
Parameters
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

setBokehScale

setBokehScale(value: number): void
Sets the bokeh scale.
Parameters
- value: number
  The scale.
Returns void
Deprecated
Use bokehScale instead.

`Protected`setChanged

setChanged(): void
Protected
Informs the associated EffectPass that this effect requires a shader recompilation.

Should be called after changing macros or extensions and after adding/removing uniforms.

Returns void
Inherited from Effect.setChanged

setDepthTexture

setDepthTexture(
depthTexture: Texture,
depthPacking?: DepthPackingStrategies,
): void
Sets the depth texture.

You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.
Parameters
- depthTexture: Texture
  A depth texture.
- OptionaldepthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Effect.setDepthTexture

`Protected`setFragmentShader

setFragmentShader(fragmentShader: string): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

setRenderer

setRenderer(renderer: WebGLRenderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Effect.setRenderer

setSize

setSize(width: number, height: number): void
Updates the size of internal render targets.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Overrides Effect.setSize

setTarget

setTarget(value: Vector3): void
Sets the auto focus target.
Parameters
- value: Vector3
  The target.
Returns void
Deprecated
Use target instead.

`Protected`setVertexShader

setVertexShader(vertexShader: string): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

update

update(
    renderer: WebGLRenderer,
    inputBuffer: WebGLRenderTarget,
    deltaTime?: number,
): void
Updates this effect.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget
  A frame buffer that contains the result of the previous pass.
- OptionaldeltaTime: number
  The time between the last frame and the current one in seconds.
Returns void
Overrides Effect.update

Class DepthOfFieldEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalblendFunction?: BlendFunction

OptionalbokehScale?: number

OptionalfocalLength?: number

OptionalfocusDistance?: number

OptionalfocusRange?: number

Optionalheight?: number

OptionalresolutionScale?: number

OptionalresolutionX?: number

OptionalresolutionY?: number

Optionalwidth?: number

OptionalworldFocusDistance?: number

OptionalworldFocusRange?: number

Returns DepthOfFieldEffect

Properties

ReadonlyblendMode

ReadonlyblurPass

Readonlydefines

Readonlyextensions

name

Protectedrenderer

Deprecated

target

Readonlyuniforms

Accessors

bokehScale

Returns number

Parameters

Returns void

circleOfConfusionMaterial

Returns CircleOfConfusionMaterial

Deprecated

cocMaterial

Returns CircleOfConfusionMaterial

cocTexture

Returns Texture

inputColorSpace

Returns ColorSpace

Parameters

Returns void

mainCamera

Parameters

Returns void

mainScene

Parameters

Returns void

maskFunction

Returns MaskFunction

Parameters

Returns void

outputColorSpace

Returns ColorSpace

Parameters

Returns void

resolution

Returns Resolution

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

calculateFocusDistance

Parameters

Returns number

dispatchEvent

Type Parameters

Parameters

Returns void

`Optional`blendFunction?: BlendFunction

`Optional`bokehScale?: number

`Optional`focalLength?: number

`Optional`focusDistance?: number

`Optional`focusRange?: number

`Optional`height?: number

`Optional`resolutionScale?: number

`Optional`resolutionX?: number

`Optional`resolutionY?: number

`Optional`width?: number

`Optional`worldFocusDistance?: number

`Optional`worldFocusRange?: number

`Readonly`blendMode

`Readonly`blurPass

`Readonly`defines

`Readonly`extensions

`Protected`renderer

`Readonly`uniforms

`Protected`setAttributes

`Protected`setChanged

`Protected`setFragmentShader