API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classDebugLayer

@codexo/exojs/debug / debug / stable

Abstract base for a single diagnostic overlay layer. Subclasses produce a visual (outlines, text panels, sparklines, etc.) that DebugOverlay composites each frame when visible is `true`. Concrete layers are tree-shakeable via the `@codexo/exojs/debug` subpath and are not loaded unless explicitly imported.

2
props
3
methods
0
events
Import
import { DebugLayer } from '@codexo/exojs/debug'

Abstract base for a single diagnostic overlay layer. Subclasses produce a visual (outlines, text panels, sparklines, etc.) that DebugOverlay composites each frame when visible is `true`.

Concrete layers are tree-shakeable via the `@codexo/exojs/debug` subpath and are not loaded unless explicitly imported.

Constructors1
new(_app: ApplicationTop-level engine instance. Owns the canvas, render backend, scene-stack controller, the core systems (input, interaction, audio, coroutines, tweens, animations…): DebugLayer
Methods3
destroy(): void
Release any scene-graph nodes or resources owned by this layer. Called by DebugOverlay.destroy. The base implementation is a no-op; subclasses override to tear down their Container subtrees.
render(backend: RenderBackend): void
Render the layer's content using the backend. The DebugOverlay manages the active view based on this layer's viewMode; restore is handled by the overlay. Called only when visible.
update(delta: SecondsA length of time in seconds. The unit every duration in the public API is expressed in - frame deltas, the fixed step, elapsed totals, timer limits. It is a `n…): void
Update internal state from this frame's data. Called only when visible.
Properties2
visible: boolean
viewMode: DebugLayerViewModeDetermines the coordinate space a DebugLayer renders into. `'screen'` uses the overlay's pixel-space view; `'world'` uses the scene's current world-space view…
Whether this layer renders in the scene's world-space view or in a screen-space (canvas-pixel) view. Defaults to 'screen'. Subclasses override to return 'world' when rendering at actual scene positions.
Source
src/debug/DebugLayer.ts