1681-engine / ui / worldToScreen

Function: worldToScreen()

function worldToScreen(
   layer, 
   wx, 
   wy, 
   out, 
   cssScale?
): object;

Defined in: src/ui/dom/worldToScreen.ts:13

Where a world point is on the overlay, in CSS pixels: through the world layer's own transform (so the camera's zoom, scroll and shake are all in it), times how much CSS stretches the canvas (cssScale, 1 normally). Writes into out: called for every placed element every frame.

Parameters

Parameter	Type	Default value
layer	LayerTransform	undefined
wx	number	undefined
wy	number	undefined
out	{ x: number; y: number; }	undefined
out.x	number	undefined
out.y	number	undefined
cssScale	number	1

Returns

object

x

x: number;

y

y: number;