Class DebugPanel

DebugPanel coordinates an HTML/CSS screen overlay debug dashboard. Generates tabbed views, captures rendering performance metrics, outlines active VRAM allocation sizes, registers key listeners (F3 by default) to toggle overlay visibility, and draws historical FPS bars on a Canvas element.

Index

Constructors

constructor

Methods

destroy hide setSceneStatsProvider show toggle update

Constructors

constructor

new DebugPanel(
    canvas: HTMLCanvasElement,
    perf: PerformanceTracker,
    vramTracker: VRAMTracker,
    options?: DebugPanelOptions,
): DebugPanel
Instantiates a new DebugPanel, assembling HTML overlay DOM elements.
Parameters
- canvas: HTMLCanvasElement
  Swapchain target canvas reference used to determine parent mount hierarchies.
- perf: PerformanceTracker
  Active PerformanceTracker.
- vramTracker: VRAMTracker
  Active VRAMTracker.
- options: DebugPanelOptions = {}
  UI styling options.
Returns DebugPanel
- Defined in debug/debug-panel.ts:82

Methods

destroy

destroy(): void
Tears down active key listeners and deletes container elements from the document tree.

Returns void
- Defined in debug/debug-panel.ts:165

hide

hide(): void
Forces the panel to hide.

Returns void
- Defined in debug/debug-panel.ts:157

setSceneStatsProvider

setSceneStatsProvider(
    fn: () => {
        lightCount: number;
        totalMeshes: number;
        totalNodes: number;
    },
): void
Configures callback providers querying active scene counts.
Parameters
- fn: () => { lightCount: number; totalMeshes: number; totalNodes: number }
  Query callback function.
Returns void
- Defined in debug/debug-panel.ts:103

show

show(): void
Forces the panel to display.

Returns void
- Defined in debug/debug-panel.ts:149

toggle

toggle(): void
Toggles visibility states.

Returns void
- Defined in debug/debug-panel.ts:141

update

update(): void
Triggers overlay repaints. Refresh rates are throttled based on active tab requirements to prevent DOM thrashes and performance bottlenecks.

Returns void
- Defined in debug/debug-panel.ts:113

Class DebugPanel

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DebugPanel

Methods

destroy

Returns void

hide

Returns void

setSceneStatsProvider

Parameters

Returns void

show

Returns void

toggle

Returns void

update

Returns void

Settings

On This Page