1681-engine / index / DebugOverlay

Class: DebugOverlay

Defined in: src/debug/DebugOverlay.ts:48

A developer overlay toggled by a key: FPS with a frame-time graph, draw calls and textures, the entity count, a list of entities and their components, collision boxes, and the last errors the frame guard caught.

Hidden, it costs nothing per frame: nothing is drawn or listened to but the key and the engine's error event (so faults from before it was opened are still listed). Shown, it rides the engine's frame event.

Constructors

Constructor

new DebugOverlay(engine, options?): DebugOverlay;

Defined in: src/debug/DebugOverlay.ts:71

Parameters

Parameter	Type
engine	Engine
options	DebugOverlayOptions

Returns

DebugOverlay

Properties

errors

readonly errors: ErrorLog;

Defined in: src/debug/DebugOverlay.ts:49

Accessors

visible

Get Signature

get visible(): boolean;

Defined in: src/debug/DebugOverlay.ts:97

Returns

boolean

Methods

destroy()

destroy(): void;

Defined in: src/debug/DebugOverlay.ts:131

Returns

void

---

hide()

hide(): void;

Defined in: src/debug/DebugOverlay.ts:119

Returns

void

---

show()

show(): void;

Defined in: src/debug/DebugOverlay.ts:106

Returns

void

---

toggle()

toggle(): void;

Defined in: src/debug/DebugOverlay.ts:101

Returns

void