DebugOverlayHandle

pixi-reels

pixi-reels / index / DebugOverlayHandle

Interface: DebugOverlayHandle

Defined in: debug/debugOverlay.ts:142

Handle returned by debugOverlay. Owns its display objects.

Extends#

• Disposable

Properties#

Methods#

describe()#

describe(): DebugOverlaySnapshot;

Defined in: debug/debugOverlay.ts:153

Plain-JSON description of what the axis / feed / thresholds layers represent, per reel. PixiJS renders to a canvas, which CLAUDE.md notes AI agents and CI cannot see; this is the same information in a form they (and expect) can read. No PixiJS types, safe to JSON.stringify.

Returns#

DebugOverlaySnapshot

destroy()#

destroy(): void;

Defined in: debug/debugOverlay.ts:155

Remove the overlay from the reel set and dispose every allocation.

Returns#

void

Overrides#

Disposable.destroy

redraw()#

redraw(): void;

Defined in: debug/debugOverlay.ts:146

Force a full redraw (static + live layers).

Returns#

void

setLayers()#

setLayers(layers: "all" | DebugOverlayLayer[]): void;

Defined in: debug/debugOverlay.ts:144

Swap the active layer set and redraw. Accepts a list or 'all'.

Parameters#

Returns#

void