Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

Index

Constructors

  • 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

_depthOfFieldBlurX: DepthOfFieldBlurPostProcess[]
internal

Internal, blurs from high to low

_effects: PostProcess[]
internal

Internal post processes in depth of field effect

_name: string

Name of the effect

internal

Accessors

  • 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.

    Parameters

    Returns void

  • get fStop(): number
  • set fStop(value: number): void
  • F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)

    Returns number

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

    Parameters

    • value: number

    Returns void

  • get focalLength(): number
  • set focalLength(value: number): void
  • The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)

    Returns number

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

    Parameters

    • value: number

    Returns void

  • get focusDistance(): number
  • set focusDistance(value: number): void
  • Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)

    Returns number

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

    Parameters

    • value: number

    Returns void

  • get isSupported(): boolean
  • Checks if all the post processes in the effect are supported.

    Returns boolean

  • get lensSize(): number
  • set lensSize(value: number): void
  • Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diameter of the resulting aperture can be computed by lensSize/fStop.

    Returns number

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

    Parameters

    • value: number

    Returns void

Methods

  • _attachCameras(cameras: Camera): void
  • _attachCameras(cameras: Camera[]): void
  • _detachCameras(cameras: Camera): void
  • _detachCameras(cameras: Camera[]): void
  • Disables the effect on the given cameras

    internal

    Parameters

    • cameras: Camera

      The camera to disable.

    Returns void

  • Disables the effect on the given cameras

    internal

    Parameters

    Returns void

  • Enables the effect on given cameras

    internal

    Parameters

    • cameras: Camera

      The camera to enable.

    Returns void

  • Enables the effect on given cameras

    internal

    Parameters

    Returns void

  • _isReady(): boolean
  • Internal

    internal

    Returns boolean

    if all the contained post processes are ready.

  • _update(): void
  • Updates the current state of the effect

    internal

    Returns void

  • _updateEffects(): void
  • internal

    Internal

    Returns void

  • 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

  • getClassName(): string
  • Get the current class name of the current effect

    Returns string

    "DepthOfFieldEffect"

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme