Class DepthOfFieldEffect

constructor

• new DepthOfFieldEffect(camera?, options?): 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

ReadonlyblendMode

ReadonlyblurPass

Readonlydefines

Readonlyextensions

name

target

Readonlyuniforms

bokehScale

• get bokehScale(): number

• The current bokeh scale.

  Returns number
• set bokehScale(arg): 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
• set inputColorSpace(arg): void
• Protected Experimental

  Parameters

  • arg: ColorSpace

  Returns void

mainCamera

• set mainCamera(arg): void

• Sets the main camera.

  Parameters

  • arg: Camera

  Returns void

mainScene

• set mainScene(arg): void

• Sets the main scene.

  Parameters

  • arg: Scene

  Returns void

maskFunction

• get maskFunction(): MaskFunction

• The mask function. Default is MULTIPLY_RGB.

  Returns MaskFunction
• set maskFunction(arg): 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
• set outputColorSpace(arg): void
• Protected Experimental

  Parameters

  • arg: ColorSpace

  Returns void

resolution

• get resolution(): Resolution

• The resolution of this effect.

  Returns Resolution

addEventListener

• addEventListener<T>(type, listener): 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

calculateFocusDistance

• calculateFocusDistance(target): 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>(event): 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

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

getAttributes

• getAttributes(): EffectAttribute

• Returns the effect attributes.

  Returns EffectAttribute

  The attributes.

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.

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.

getExtensions

• getExtensions(): Set<WebGLExtension>

• Returns the WebGL extensions that are required by this effect.

  Returns Set<WebGLExtension>

  The extensions.

  Deprecated

  Use extensions instead.

getFragmentShader

• getFragmentShader(): string

• Returns the fragment shader.

  Returns string

  The fragment shader.

getName

• getName(): string

• Returns the name of this effect.

  Returns string

  The name.

  Deprecated

  Use name instead.

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.

getVertexShader

• getVertexShader(): string

• Returns the vertex shader.

  Returns string

  The vertex shader.

hasEventListener

• hasEventListener<T>(type, listener): 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

initialize

• initialize(renderer, alpha, frameBufferType): 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

removeEventListener

• removeEventListener<T>(type, listener): 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

setBokehScale

• setBokehScale(value): void

• Sets the bokeh scale.

  Parameters

  • value: number

    The scale.

  Returns void

  Deprecated

  Use bokehScale instead.

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): 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

setRenderer

• setRenderer(renderer): void

• Sets the renderer.

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

  Deprecated

setSize

• setSize(width, height): void

• Updates the size of internal render targets.

  Parameters

  • width: number

    The width.
  • height: number

    The height.

  Returns void

setTarget

• setTarget(value): void

• Sets the auto focus target.

  Parameters

  • value: Vector3

    The target.

  Returns void

  Deprecated

  Use target instead.

update

• update(renderer, inputBuffer, deltaTime?): void

• Updates this effect.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • inputBuffer: WebGLRenderTarget<Texture>

    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