pixi-reels

DebugOverlayOptions

pixi-reels


pixi-reels / index / DebugOverlayOptions

Interface: DebugOverlayOptions

Defined in: debug/debugOverlay.ts:92

Properties#

PropertyTypeDescriptionDefined in
layers?"all" | DebugOverlayLayer[]Which layers to draw. An explicit list, or 'all' for every C3 layer. Defaults to 'all'.debug/debugOverlay.ts:97
live?booleanWhen true, the live layers (bounds / blocks / pins / hud) redraw every tick. When false (default) the overlay draws once and only updates on redraw() / setLayers() and reshape events.debug/debugOverlay.ts:103
ticker?TickerTicker driving the live redraw when live: true. Defaults to Ticker.shared. Pass the reel set’s own ticker (e.g. app.ticker, or a FakeTicker in tests) to keep the overlay in lock-step with it. Ignored when live is falsy.debug/debugOverlay.ts:110