DepthRenderer

This represents a depth renderer in Babylon. A depth renderer will render to it's depth map every frame which can be displayed or used in post processing

Hierarchy

  • DepthRenderer

Index

Constructors

Methods

Constructors

constructor

  • Instantiates a depth renderer

    Parameters

    • scene: Scene

      The scene the renderer belongs to

    • Optional type: number

      The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)

    • Optional camera: Nullable<Camera>

      The camera to be used to render the depth map (default: scene's active camera)

    Returns DepthRenderer

Methods

dispose

  • dispose(): void

  • Disposes of the depth renderer.

    Returns void

getDepthMap

  • Gets the texture which the depth map will be written to.

    Returns RenderTargetTexture

    The depth map texture

isReady

  • isReady(subMesh: SubMesh, useInstances: boolean): boolean

  • Creates the depth rendering effect and checks if the effect is ready.

    Parameters

    • subMesh: SubMesh

      The submesh to be used to render the depth map of

    • useInstances: boolean

      If multiple world instances should be used

    Returns boolean

    if the depth renderer is ready to render the depth map

Generated using TypeDoc