Interface: IRenderer

Thin scene-graph + per-camera draw. Knows nothing about what's drawn at each node — drawables live behind capability interfaces (ISpriteRenderer etc.); render systems acquire the capabilities they need or no-op if absent. Engine calls RenderCamera once per active camera per frame; no cameras = nothing drawn.

Coordinate contract (Unity / Cocos convention) — every backend implements it as given and does any axis conversion internally; systems never flip anything:

• World and node-local space are +y UP. Positive rotation is counter-clockwise.
• Anchors (sprite / text / video) are fractions of the rect from its bottom-left: anchorY 0 = bottom edge, 1 = top edge. The node origin sits at the anchor point.
• Hit areas, mask shapes, graphics shapes and debug drawing use those same y-up coords.
• Screen-space values — canvas pixels, viewport rects, pointer events — stay top-left origin, +y down, like the DOM. A y-down backend (Pixi) flips its view once and counter-flips image-like drawables; a backend that is natively y-up has nothing to convert.

Methods

AttachResource()

AttachResource(nodeId, handle): void;

Parameters

Parameter	Type
nodeId	number
handle	number

Returns

void

---

BeginFrame()

BeginFrame(): void;

Returns

void

---

CreateNode()

CreateNode(id): void;

Parameters

Parameter	Type
id	number

Returns

void

---

DestroyNode()

DestroyNode(id): void;

Parameters

Parameter	Type
id	number

Returns

void

---

DetachResource()

DetachResource(nodeId, handle): void;

Parameters

Parameter	Type
nodeId	number
handle	number

Returns

void

---

EndFrame()

EndFrame(): void;

Returns

void

---

GetCanvas()

GetCanvas(): HTMLCanvasElement;

Returns

HTMLCanvasElement

---

GetCapability()

GetCapability<T>(capability): T | null;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
capability	RendererCapability<T>

Returns

T | null

---

HitTestNode()?

optional HitTestNode(screenX, screenY): number | null;

The topmost interactive node at a canvas pixel (as the last rendered frame drew it), or null. Optional — Game.input.IsPointerOverUI uses it.

Parameters

Parameter	Type
screenX	number
screenY	number

Returns

number | null

---

Init()

Init(rendererData): Promise<boolean>;

Parameters

Parameter	Type
rendererData	RendererData

Returns

Promise<boolean>

---

IsInitialized()

IsInitialized(): boolean;

Returns

boolean

---

OnNodeInteraction()

OnNodeInteraction(callback): () => void;

Parameters

Parameter	Type
callback	(event) => void

Returns

() => void

---

RenderCamera()

RenderCamera(config): void;

Per pass: viewport → clear → view+projection → layer culling → draw. Restore visibility so the next pass starts clean. With config.targetTexture the pass draws into that loaded render texture, leaving out drawables that show the same texture (no feedback loop).

Parameters

Parameter	Type
config	CameraConfig

Returns

void

---

Resize()

Resize(
   width, 
   height, 
   resolution?
): void;

Resize the underlying drawable surface. Cameras and Fit-mode canvas scaling pick up the new dimensions on the next frame. Resolution (devicePixelRatio for crispness) is optional.

Parameters

Parameter	Type
width	number
height	number
resolution?	number

Returns

void

---

SetNodeAlpha()

SetNodeAlpha(id, alpha): void;

0..1, applied after visibility — alpha=0 is still hit-testable. Default 1.

Parameters

Parameter	Type
id	number
alpha	number

Returns

void

---

SetNodeHitArea()

SetNodeHitArea(id, rect): void;

node-local rect; null reverts to bounds-derived hit testing.

Parameters

Parameter	Type
id	number
rect	| { height: number; width: number; x: number; y: number; } | null

Returns

void

---

SetNodeInteractive()

SetNodeInteractive(id, interactive): void;

Default new nodes are non-interactive.

Parameters

Parameter	Type
id	number
interactive	boolean

Returns

void

---

SetNodeLayer()

SetNodeLayer(id, layer): void;

Parameters

Parameter	Type
id	number
layer	number

Returns

void

---

SetNodeMask()

SetNodeMask(
   targetNodeId, 
   maskSourceNodeId, 
   inverted?
): void;

Clips targetNodeId by the FIRST resource on maskSourceNodeId. Graphics → stencil mask; Sprite → alpha mask. inverted flips interior/exterior. Pixi Canvas backend ignores inversion on stencil masks (warns).

Parameters

Parameter	Type
targetNodeId	number
maskSourceNodeId	number | null
inverted?	boolean

Returns

void

---

SetNodeOrder()

SetNodeOrder(id, order): void;

Draw-order index within the renderer's flat stage. Lower draws first (behind). HierarchySystem assigns these from a DFS of the logical tree so children render above their parent's prior siblings. Only pushed when the hierarchy changes.

Parameters

Parameter	Type
id	number
order	number

Returns

void

---

SetNodeParent()

SetNodeParent(id, parentId): void;

Parameters

Parameter	Type
id	number
parentId	number | null

Returns

void

---

SetNodePivot()

SetNodePivot(
   id, 
   pivotX, 
   pivotY
): void;

Pivot offset in node-local pixels. Backends without a node-pivot concept can no-op.

Parameters

Parameter	Type
id	number
pivotX	number
pivotY	number

Returns

void

---

SetNodeTransform()

SetNodeTransform(
   id, 
   x, 
   y, 
   rotation, 
   scaleX, 
   scaleY
): void;

Parameters

Parameter	Type
id	number
x	number
y	number
rotation	number
scaleX	number
scaleY	number

Returns

void

---

SetNodeVisibility()

SetNodeVisibility(id, visible): void;

Parameters

Parameter	Type
id	number
visible	boolean

Returns

void

---

SetResourceVisible()

SetResourceVisible(handle, visible): void;

Shows / hides one drawable without touching its node (the entity's other drawables, children and transform are unaffected). Render systems use it for disabled components.

Parameters

Parameter	Type
handle	number
visible	boolean

Returns

void

---

Shutdown()

Shutdown(): Promise<void>;

Returns

Promise<void>