love.mouse

Provides an interface to the user's mouse.

Types

CursorRepresents a hardware cursor.Added since 0.9.0

Functions

love.mouse.getCursorGets the current Cursor.Added since 0.9.0
love.mouse.getPositionReturns the current position of the mouse.
love.mouse.getSystemCursorGets a Cursor object representing a system-native hardware cursor.Added since 0.9.0
love.mouse.getXReturns the current x-position of the mouse.
love.mouse.getYReturns the current y-position of the mouse.
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.Added since 0.9.0
love.mouse.setCursorSets the current mouse cursor.Added since 0.9.0
love.mouse.setGrabGrabs the mouse and confines it to the window. Removed in 0.9.0
love.mouse.setGrabbedGrabs the mouse and confines it to the window.Added since 0.9.0
love.mouse.setPositionSets the current position of the mouse.
love.mouse.setVisibleSets the current visibility of the cursor.
love.mouse.setXSets the current X position of the mouse.Added since 0.9.0
love.mouse.setYSets the current Y position of the mouse.Added since 0.9.0

Enums

CursorTypeTypes of hardware cursors.Added since 0.9.0
MouseConstantMouse buttons.

See Also


Other Languages

Personal tools