Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SceneInstrumentation

This class can be used to get instrumentation data from a Babylon engine

see

https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation

Hierarchy

  • SceneInstrumentation

Implements

Index

Constructors

constructor

Properties

sceneSearch playground for scene

scene: Scene

Defines the scene to instrument

Accessors

activeMeshesEvaluationTimeCounter

  • Gets the perf counter used for active meshes evaluation time

    Returns PerfCounter

animationsTimeCounter

  • Gets the perf counter used for animations time

    Returns PerfCounter

cameraRenderTimeCounter

  • Gets the perf counter used for camera render time capture

    Returns PerfCounter

captureActiveMeshesEvaluationTime

  • get captureActiveMeshesEvaluationTime(): boolean
  • set captureActiveMeshesEvaluationTime(value: boolean): any
  • Gets the active meshes evaluation time capture status

    Returns boolean

  • Enable or disable the active meshes evaluation time capture

    Parameters

    • value: boolean

    Returns any

captureAnimationsTime

  • get captureAnimationsTime(): boolean
  • set captureAnimationsTime(value: boolean): any
  • Gets the animations time capture status

    Returns boolean

  • Enable or disable the animations time capture

    Parameters

    • value: boolean

    Returns any

captureCameraRenderTime

  • get captureCameraRenderTime(): boolean
  • set captureCameraRenderTime(value: boolean): any
  • Gets the camera render time capture status

    Returns boolean

  • Enable or disable the camera render time capture

    Parameters

    • value: boolean

    Returns any

captureFrameTime

  • get captureFrameTime(): boolean
  • set captureFrameTime(value: boolean): any
  • Gets the frame time capture status

    Returns boolean

  • Enable or disable the frame time capture

    Parameters

    • value: boolean

    Returns any

captureInterFrameTime

  • get captureInterFrameTime(): boolean
  • set captureInterFrameTime(value: boolean): any
  • Gets the inter-frames time capture status

    Returns boolean

  • Enable or disable the inter-frames time capture

    Parameters

    • value: boolean

    Returns any

captureParticlesRenderTime

  • get captureParticlesRenderTime(): boolean
  • set captureParticlesRenderTime(value: boolean): any
  • Gets the particles render time capture status

    Returns boolean

  • Enable or disable the particles render time capture

    Parameters

    • value: boolean

    Returns any

capturePhysicsTime

  • get capturePhysicsTime(): boolean
  • set capturePhysicsTime(value: boolean): any
  • Gets the physics time capture status

    Returns boolean

  • Enable or disable the physics time capture

    Parameters

    • value: boolean

    Returns any

captureRenderTargetsRenderTime

  • get captureRenderTargetsRenderTime(): boolean
  • set captureRenderTargetsRenderTime(value: boolean): any
  • Gets the render targets render time capture status

    Returns boolean

  • Enable or disable the render targets render time capture

    Parameters

    • value: boolean

    Returns any

captureRenderTime

  • get captureRenderTime(): boolean
  • set captureRenderTime(value: boolean): any
  • Gets the render time capture status

    Returns boolean

  • Enable or disable the render time capture

    Parameters

    • value: boolean

    Returns any

captureSpritesRenderTime

  • get captureSpritesRenderTime(): boolean
  • set captureSpritesRenderTime(value: boolean): any
  • Gets the sprites render time capture status

    Returns boolean

  • Enable or disable the sprites render time capture

    Parameters

    • value: boolean

    Returns any

drawCallsCounter

  • Gets the perf counter used for draw calls

    Returns PerfCounter

frameTimeCounter

  • Gets the perf counter used for frame time capture

    Returns PerfCounter

interFrameTimeCounter

  • Gets the perf counter used for inter-frames time capture

    Returns PerfCounter

particlesRenderTimeCounter

  • Gets the perf counter used for particles render time

    Returns PerfCounter

physicsTimeCounter

  • Gets the perf counter used for physics time

    Returns PerfCounter

renderTargetsRenderTimeCounter

  • Gets the perf counter used for render targets render time

    Returns PerfCounter

renderTimeCounter

  • Gets the perf counter used for render time capture

    Returns PerfCounter

spritesRenderTimeCounter

  • Gets the perf counter used for sprites render time

    Returns PerfCounter

Methods

disposeSearch playground for dispose

  • dispose(): void
  • Dispose and release associated resources.

    Returns void

Legend

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