Skip to content
pixi-silk
GitHub repository
Function

layoutDebug

import { layoutDebug } from 'pixi-silk/ui/layout';
function layoutDebug(app: Application, options?: LayoutDebugOptions): LayoutDebug;

A debug overlay for SmartContainers and FlexContainers, off by default. It draws over the whole stage, in screen pixels:

  • SmartContainer: the design box, the reference resolution at the fit scale, the safe-area insets, the alignment anchor, the stretched axes, and a tag with the breakpoint and scale.
  • FlexContainer: the box, the content box, the padding, the gaps between items, and each child’s slot (blue) against its real bounds (white, red when it overflows the slot).

Hover a box for a readout of its name, size, scale and alignment. Toggle with key, or with the returned handle.

Parameters#

ParameterType
appApplication
optionsLayoutDebugOptions

Returns#

LayoutDebug