Class Tracing

Log tracing functionality, allowing for tracing of the internal functionality of the engine. Note that the trace logging only takes place in the debug build of the engine and is stripped out in other builds.

The debug build ships in the npm package: import from 'playcanvas/debug' instead of 'playcanvas' to enable trace channels, assertions and validation warnings. A 'playcanvas/profiler' build is also available for per-frame timings.

Index

Properties

Methods

Properties

`Static`stack

stack: boolean = false

Enable call stack logging for trace calls. Defaults to false.

Methods

`Static`get

get(channel: string): boolean
Test if the trace channel is enabled.
Parameters
- channel: string
  Name of the trace channel.
Returns boolean
- True if the trace channel is enabled.
- Defined in core/tracing.js:72

`Static`set

set(channel: string, enabled?: boolean): void
Enable or disable a trace channel.
Parameters
- channel: string
  Name of the trace channel. Can be:
  
  TRACEID_RENDER_FRAME
  
  TRACEID_RENDER_FRAME_TIME
  
  TRACEID_RENDER_PASS
  
  TRACEID_RENDER_PASS_DETAIL
  
  TRACEID_RENDER_ACTION
  
  TRACEID_RENDER_TARGET_ALLOC
  
  TRACEID_TEXTURE_ALLOC
  
  TRACEID_SHADER_ALLOC
  
  TRACEID_SHADER_COMPILE
  
  TRACEID_VRAM_TEXTURE
  
  TRACEID_VRAM_VB
  
  TRACEID_VRAM_IB
  
  TRACEID_RENDERPIPELINE_ALLOC
  
  TRACEID_COMPUTEPIPELINE_ALLOC
  
  TRACEID_PIPELINELAYOUT_ALLOC
  
  TRACEID_TEXTURES
  
  TRACEID_BUFFERS
  
  TRACEID_ASSETS
  
  TRACEID_GPU_TIMINGS
- enabled: boolean = true
  New enabled state for the channel.
Returns void
- Defined in core/tracing.js:55