Skip to content

IsOnScreen

Read onscreen from the current render or game view.

IsOnScreen(position)

Inputs: position is a screen { x, y } value.

Output: true when a screen position is inside the display.

Errors and unavailable states: A capture-only pass returns false. A non-table position can raise a Lua indexing error; missing or non-numeric coordinates read as 0.

See Rendering overview for coordinate and color conventions.