Class ThinDepthOfFieldEffect

constructor

• new ThinDepthOfFieldEffect(
      name: string,
      engine: Nullable<AbstractEngine>,
      blurLevel?: ThinDepthOfFieldEffectBlurLevel,
      depthNotNormalized?: boolean,
      blockCompilation?: boolean,
  ): ThinDepthOfFieldEffect

  Creates a new instance of

  Parameters

  • name: string

    The name of the depth of field render effect

  • engine: Nullable<AbstractEngine>

    The engine which the render effect will be applied. (default: current engine)

  • blurLevel: ThinDepthOfFieldEffectBlurLevel = ThinDepthOfFieldEffectBlurLevel.Low

    The quality of the effect. (default: DepthOfFieldEffectBlurLevel.Low)

  • depthNotNormalized: boolean = false

    If the (view) depth used in circle of confusion post-process is normalized (0.0 to 1.0 from near to far) or not (0 to camera max distance) (default: false)

  • blockCompilation: boolean = false

    If shaders should not be compiled when the effect is created (default: false)

  Returns ThinDepthOfFieldEffect

  See

  ThinDepthOfFieldEffect

ReadonlyblurLevel

focalLength

• get focalLength(): number

  Returns number

• set focalLength(value: number): void

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

  Parameters

  • value: number

  Returns void

focusDistance

• get focusDistance(): number

  Returns number

• set focusDistance(value: number): void

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

  Parameters

  • value: number

  Returns void

fStop

• get fStop(): number

  Returns 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)

  Parameters

  • value: number

  Returns void

lensSize

• get lensSize(): number

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

  Parameters

  • value: number

  Returns void

isReady

• isReady(): boolean

  Checks if the effect is ready to be used

  Returns boolean

  if the effect is ready