1681-engine / ui / DomOverlayOptions

Interface: DomOverlayOptions

Defined in: src/ui/dom/DomOverlay.ts:1

Properties

className?

optional className?: string;

Defined in: src/ui/dom/DomOverlay.ts:3

Added to the root element (for the game's CSS).

---

logicalSize?

optional logicalSize?: () => object;

Defined in: src/ui/dom/DomOverlay.ts:10

The canvas's size in screen pixels (() => app.screen): when CSS stretches the canvas past it (a small fixed canvas scaled up), cssScale is how much, and world placement follows it. Default: no stretch.

Returns

object

height

height: number;

width

width: number;

---

zIndex?

optional zIndex?: number;

Defined in: src/ui/dom/DomOverlay.ts:5

Stacking order over the canvas (default 1).