Interface: ScreenSpaceCanvasFields

Defined in: ui/components/canvas-component.ts:15

AddCanvasComponentOptions/CanvasEcsComponent fields specific to a renderMode: 'screenSpace' canvas (the default) - resolved every frame by createUiLayoutEcsSystem from the render destination's live size, per scaleMode. Rejected at compile time on a 'worldSpace' canvas, which has no "destination size" to scale against.

Properties

referenceResolution?

optional referenceResolution?: Vector2

Defined in: ui/components/canvas-component.ts:22

The resolution UI is authored against, in reference pixels. Defaults to 1920x1080.

---

renderMode?

optional renderMode?: "screenSpace"

Defined in: ui/components/canvas-component.ts:16

---

scaleMode?

optional scaleMode?: UiScaleMode

Defined in: ui/components/canvas-component.ts:25

How the canvas's root rect responds to the destination's live size.