love.mouse

Provides an interface to the user's mouse.

Types

Cursor Represents a hardware cursor. 0.9.0

Functions

love.mouse.getCursor Gets the current Cursor. 0.9.0
love.mouse.getPosition Returns the current position of the mouse. 0.3.2
love.mouse.getRelativeMode Gets whether relative mode is enabled for the mouse. 0.9.2
love.mouse.getSystemCursor Gets a Cursor object representing a system-native hardware cursor. 0.9.0
love.mouse.getX Returns the current x-position of the mouse.
love.mouse.getY Returns the current y-position of the mouse.
love.mouse.hasCursor Gets whether cursor functionality is supported. 0.10.0
love.mouse.isDown Checks whether a certain button is down.
love.mouse.isGrabbed Checks if the mouse is grabbed.
love.mouse.isVisible Checks if the cursor is visible.
love.mouse.newCursor Creates a new hardware Cursor object from an image. 0.9.0
love.mouse.setCursor Sets the current mouse cursor. 0.9.0
love.mouse.setGrab Grabs the mouse and confines it to the window. 0.9.0
love.mouse.setGrabbed Grabs the mouse and confines it to the window. 0.9.0
love.mouse.setPosition Sets the current position of the mouse.
love.mouse.setRelativeMode Sets whether relative mode is enabled for the mouse. 0.9.2
love.mouse.setVisible Sets the current visibility of the cursor.
love.mouse.setX Sets the current X position of the mouse. 0.9.0
love.mouse.setY Sets the current Y position of the mouse. 0.9.0

Enums

CursorType Types of hardware cursors. 0.9.0
MouseConstant Mouse buttons. 0.10.0

See Also


love.mouse.setCursor

love.mouse.setCursor Available since LÖVE 0.9.0 This function is not supported in earlier versions. Sets the current mouse cursor.

2017-03-21 15:49:41
love.mouse.getCursor

love.mouse.getCursor Available since LÖVE 0.9.0 This function is not supported in earlier versions. Gets the current Cursor.

2017-03-21 15:49:31
love.mouse.newCursor

love.mouse.newCursor Available since LÖVE 0.9.0 This function is not supported in earlier versions. Creates a new hardware

2017-03-21 15:49:40
love.mouse.getY

love.mouse.getY Returns the current y-position of the mouse. Function Synopsis

2017-03-21 15:49:36
love.mouse.setX

love.mouse.setX Available since LÖVE 0.9.0 This function is not supported in earlier versions. Sets the current X position of the mouse. The

2017-03-21 15:49:46
love.mouse.isDown

love.mouse.isDown Checks whether a certain mouse button is down. This function does not detect mouse wheel scrolling; you must use the

2017-03-21 15:49:37
love.mouse.getRelativeMode

love.mouse.getRelativeMode Available since LÖVE 0.9.2 This function is not supported in earlier versions. Gets whether relative mode is enabled

2017-03-21 15:49:33
love.mouse.setGrabbed

love.mouse.setGrabbed Available since LÖVE 0.9.0 It has been renamed from

2017-03-21 15:49:43
love.mouse.setRelativeMode

love.mouse.setRelativeMode Available since LÖVE 0.9.2 This function is not supported in earlier versions. Sets whether relative mode is enabled

2017-03-21 15:49:45