DepthOfFieldEffect

The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • Creates a new instance DepthOfFieldEffect

    Parameters

    • scene: Scene

      The scene the effect belongs to.

    • depthTexture: Nullable<RenderTargetTexture>

      The depth texture of the scene to compute the circle of confusion.This must be set in order for this to function but may be set after initialization if needed.

    • Optional blurLevel: DepthOfFieldEffectBlurLevel
    • Optional pipelineTextureType: number

      The type of texture to be used when performing the post processing.

    • Optional blockCompilation: boolean

      If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)

    Returns DepthOfFieldEffect

Properties

depthTexture

Find examples in Playground
depthTexture: RenderTargetTexture

Depth texture to be used to compute the circle of confusion. This must be set here or in the constructor in order for the post process to function.

fStop

Find examples in Playground
fStop: number

F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)

focalLength

Find examples in Playground
focalLength: number

The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)

focusDistance

Find examples in Playground
focusDistance: number

Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)

isSupported

Find examples in Playground
isSupported: boolean

Checks if all the post processes in the effect are supported.

lensSize

Find examples in Playground
lensSize: number

Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diamater of the resulting aperture can be computed by lensSize/fStop.

Methods

disposeEffects

Find examples in Playground
  • disposeEffects(camera: Camera): void
  • Disposes each of the internal effects for a given camera.

    Parameters

    • camera: Camera

      The camera to dispose the effect on.

    Returns void

getPostProcesses

Find examples in Playground

Generated using TypeDoc