DepthReducer

This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture

Hierarchy

Index

Constructors

constructor

Find examples in Playground

Properties

onAfterReductionPerformed

Find examples in Playground
onAfterReductionPerformed: Observable<object>

Observable triggered when the computation has been performed

Accessors

activated

Find examples in Playground
  • get activated(): boolean

depthRenderer

Find examples in Playground
  • Gets the depth renderer used for the computation. Note that the result is null if you provide your own renderer when calling setDepthRenderer.

    Returns Nullable<DepthRenderer>

refreshRate

Find examples in Playground
  • get refreshRate(): number
  • set refreshRate(value: number): any
  • Defines the refresh rate of the computation. Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...

    Returns number

  • Defines the refresh rate of the computation. Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...

    Parameters

    • value: number

    Returns any

sourceTexture

Find examples in Playground

Methods

activate

Find examples in Playground
  • activate(): void
  • Activates the reduction computation. When activated, the observers registered in onAfterReductionPerformed are called after the compuation is performed

    Returns void

deactivate

Find examples in Playground
  • deactivate(): void

dispose

Find examples in Playground
  • dispose(disposeAll?: boolean): void
  • Disposes the depth reducer

    Parameters

    • Optional disposeAll: boolean

      true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.

    Returns void

setDepthRenderer

Find examples in Playground
  • setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void
  • Sets the depth renderer to use to generate the depth map

    Parameters

    • Optional depthRenderer: Nullable<DepthRenderer>

      The depth renderer to use. If not provided, a new one will be created automatically

    • Optional type: number

      The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)

    • Optional forceFullscreenViewport: boolean

      Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)

    Returns void

Generated using TypeDoc