RendererAdapter
Defined in: RendererAdapter.ts:13
Cross-package contract for “something that owns a canvas and can map canvas-relative CSS pixels into virtual-space pixels”.
Implemented by @yagejs/renderer’s RendererPlugin and consumed by
@yagejs/input for pointer-event targeting and coordinate mapping under
responsive fit. Foreign renderers can implement this interface and register
under RendererAdapterKey to integrate with the input plugin without
importing @yagejs/renderer.
Properties
Section titled “Properties”canvas
Section titled “canvas”
readonlycanvas:HTMLCanvasElement
Defined in: RendererAdapter.ts:14
Methods
Section titled “Methods”canvasToVirtual()?
Section titled “canvasToVirtual()?”
optionalcanvasToVirtual(x,y):object
Defined in: RendererAdapter.ts:20
Convert CSS pixels relative to the canvas into virtual-space pixels. Optional — when absent, consumers fall back to raw CSS pixels (correct only when canvas CSS size equals virtual size).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”object
x:
number
y:
number
hitTestUI()?
Section titled “hitTestUI()?”
optionalhitTestUI(x,y):boolean
Defined in: RendererAdapter.ts:33
Hit-test at virtual-space coordinates and return true when the topmost
interactive container under (x, y) is parented (directly or through any
ancestor) to a container marked via markPointerConsumeContainer.
Optional — when absent, the input plugin’s UI auto-consume fallback is a
no-op.
Implemented by @yagejs/renderer over Pixi’s EventBoundary. The input
plugin calls this on pointerdown drains to auto-claim presses that land
on UI surfaces (UIPanel backgrounds, decorative UIText, etc.) without
requiring per-component handler boilerplate.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”boolean