natiny.input.get_mouse_x

Lua
natiny.input.get_mouse_x() -> x

Returns the mouse cursor's X coordinate relative to the window's left edge.

Returns

Type Description
number Mouse cursor X coordinate in drawing units

Example

Lua
local x = natiny.input.get_mouse_x()

Notes

  • On desktop, input state is global across windows. The coordinate is relative to the window that produced the most recent cursor event. On web it is relative to the single canvas.
  • The result uses the same units as 2D drawing: window pixels in natiny.window.SCALE_MODE_PIXELS, and display-scaled drawing units in SCALE_MODE_STRETCH and SCALE_MODE_HIDPI.