##### Views

- Page
- Discussion
- View source
- History

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

## See Also

- love
- love.mousepressed
- love.mousereleased

## Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://www.love2d.org/wiki/love.mouse"
Category: Modules

##### Personal tools

- Log in

##### Search

##### Toolbox

- What links here
- Related changes
- Special pages
- Printable version
- Permanent link
- Browse properties