love.mouse

Provides an interface to the user's mouse.

Types

Cursor Represents a hardware cursor. Added since 0.9.0

Functions

love.mouse.getCursor Gets the current Cursor. Added since 0.9.0
love.mouse.getPosition Returns the current position of the mouse. Added since 0.3.2
love.mouse.getRelativeMode Gets whether relative mode is enabled for the mouse. Added since 0.9.2
love.mouse.getSystemCursor Gets a Cursor object representing a system-native hardware cursor. Added since 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. Added since 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. Added since 0.9.0
love.mouse.setCursor Sets the current mouse cursor. Added since 0.9.0
love.mouse.setGrab Grabs the mouse and confines it to the window. Removed in 0.9.0
love.mouse.setGrabbed Grabs the mouse and confines it to the window. Added since 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. Added since 0.9.2
love.mouse.setVisible Sets the current visibility of the cursor.
love.mouse.setX Sets the current X position of the mouse. Added since 0.9.0
love.mouse.setY Sets the current Y position of the mouse. Added since 0.9.0

Enums

CursorType Types of hardware cursors. Added since 0.9.0
MouseConstant Mouse buttons. Removed in 0.10.0

See Also


Other Languages