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.getX

love.mouse.getX Returns the current x-position of the mouse. Function Synopsis

2017-03-21 15:49:35
love.mouse.setGrab

love.mouse.setGrab Removed in LÖVE 0.9.0 It has been renamed to

2017-03-21 15:49:42
love.mouse.isGrabbed

love.mouse.isGrabbed Checks if the mouse is grabbed. Function Synopsis

2017-03-21 15:49:38
love.mouse.setVisible

love.mouse.setVisible Sets the current visibility of the cursor. Function Synopsis

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

love.mouse.getSystemCursor Available since LÖVE 0.9.0 This function is not supported in earlier versions. Gets a

2017-03-21 15:49:34
love.mouse.getPosition

love.mouse.getPosition Returns the current position of the mouse. Function Synopsis

2017-03-21 15:49:32
love.mouse.hasCursor

love.mouse.hasCursor Available since LÖVE 0.10.0 This function is not supported in earlier versions. Gets whether cursor functionality is supported

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

love.mouse.isVisible Checks if the cursor is visible. Function Synopsis

2017-03-21 15:49:39
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