ScreenOverlayData

Defined in: ui/core/screen-overlay.ts:30

File

core-ui.ts

Brief

The stable UI surface promoted into the top-level esengine namespace (text, UINode box visuals, interaction, layout, theme).

This is the curated public UI API. The complete UI module surface — which also includes low-level text/atlas internals and engine-internal composition glue (e.g. EntityStateMap, ensureComponent) — lives in ./ui and is imported module-directly by the SDK code that needs it. Those internals are intentionally NOT re-exported here, so the public esengine namespace stays a stable, intentional surface.

Re-exported wholesale by core.ts.

Properties

active

active: boolean

Defined in: ui/core/screen-overlay.ts:32

False when nothing has a screen yet — no surface, no layout.

layerMask

layerMask: number

Defined in: ui/core/screen-overlay.ts:57

Sorting layers this frame shows, as a bitmask — frame-level VISIBILITY POLICY, assembled from the rendering cameras’ masks and nothing else about them. It does not make the overlay theirs: the projection, the viewport and the order stay the screen’s. With no camera it is every layer.

pointerX

pointerX: number

Defined in: ui/core/screen-overlay.ts:49

The pointer, in LAYOUT pixels — the domain a screen element’s transform is in, so a drag can subtract the two. Inverted through projection and nothing else: a UI system reading the camera’s world mouse instead draws in the right place and answers a click somewhere else.