1681-engine / ui / onScreen

Function: onScreen()

function onScreen(
   x, 
   y, 
   width, 
   height, 
   margin?
): boolean;

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

Whether a point is on a width × height screen, or within margin of it (an element's own size past the point).

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
width	number	undefined
height	number	undefined
margin	number	0

Returns

boolean