love.mouse

Provides an interface to the user's mouse.

Functions

love.mouse.getCursorGets the current Cursor.
love.mouse.getGlobalPositionGets the global position of the mouse on the screen.
love.mouse.getPositionReturns the current position of the mouse.
love.mouse.getRelativeModeGets whether relative mode is enabled for the mouse.
love.mouse.getSystemCursorGets a Cursor object representing a system-native hardware cursor.
love.mouse.getXReturns the current x-position of the mouse.
love.mouse.getYReturns the current y-position of the mouse.
love.mouse.hasCursorGets whether cursor functionality is supported.
love.mouse.isCursorSupportedGets whether cursor functionality is supported.
love.mouse.isDownChecks whether a certain button is down.
love.mouse.isGrabbedChecks if the mouse is grabbed.
love.mouse.isVisibleChecks if the cursor is visible.
love.mouse.newCursorCreates a new hardware Cursor object from an image.
love.mouse.setCursorSets the current mouse cursor.
love.mouse.setGrabGrabs the mouse and confines it to the window.
love.mouse.setGrabbedGrabs the mouse and confines it to the window.
love.mouse.setPositionSets the current position of the mouse.
love.mouse.setRelativeModeSets whether relative mode is enabled for the mouse.
love.mouse.setVisibleSets the current visibility of the cursor.
love.mouse.setXSets the current X position of the mouse.
love.mouse.setYSets the current Y position of the mouse.

Enums

CursorTypeTypes of hardware cursors.
MouseConstantMouse buttons.

See Also