API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classDebugOverlay
Canvas-native debug overlay. Instantiate AFTER Application is constructed: import { DebugOverlay } from '@codexo/exojs/debug'; const debug = new DebugOverlay(app); debug.layers.performance.visible = true; // or press F1 The overlay subscribes to `app.onFrame` and renders its visible layers. World-space layers render first (under text panels) in the scene view; screen-space layers then render in the overlay's pixel-space view. Keybindings (while canvas has focus): F1 — toggle Performance layer F2 — toggle BoundingBoxes layer F3 — toggle HitTest layer F4 — toggle PointerStack layer NOTE: F-keys only fire while the canvas has focus (engine convention). The master `visible` switch suppresses all layer rendering when false without changing individual layer visibility flags.
import { DebugOverlay } from '@codexo/exojs/debug' Canvas-native debug overlay. Instantiate AFTER Application is constructed:
import { DebugOverlay } from '@codexo/exojs/debug'; const debug = new DebugOverlay(app); debug.layers.performance.visible = true; // or press F1
The overlay subscribes to `app.onFrame` and renders its visible layers. World-space layers render first (under text panels) in the scene view; screen-space layers then render in the overlay's pixel-space view.
Keybindings (while canvas has focus): F1 — toggle Performance layer F2 — toggle BoundingBoxes layer F3 — toggle HitTest layer F4 — toggle PointerStack layer
NOTE: F-keys only fire while the canvas has focus (engine convention).
The master `visible` switch suppresses all layer rendering when false without changing individual layer visibility flags.
new(app: Application): DebugOverlay destroy(): void layers: DebugLayers visible: boolean