View on GitHub

DSFML

dsfml.window.mouse

A module containing the Mouse class.

abstract class Mouse;
Give access to the real-time state of the mouse.

Mouse provides an interface to the state of the mouse.

It only contains static functions (a single mouse is assumed), so it's not meant to be instanciated.

This class allows users to query the mouse state at any time and directly, without having to deal with a window and its events. Compared to the MouseMoved, MouseButtonPressed and MouseButtonReleased events, Mouse can retrieve the state of the cursor and the buttons at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of the mouse, even if it is moved, pressed or released when your window is out of focus and no event is triggered.

The setPosition and getPosition functions can be used to change or retrieve the current position of the mouse pointer. There are two versions: one that operates in global coordinates (relative to the desktop) and one that operates in window coordinates (relative to a specific window).

static void setPosition(Vector2i position);
Set the current position of the mouse in desktop coordinates.

This function sets the global position of the mouse cursor on the desktop.





Params:
Vector2i position New position of the mouse.

static void setPosition(Vector2i position, const(Window) relativeTo);
Set the current position of the mouse in window coordinates.

This function sets the current position of the mouse cursor, relative to the given window.





Params:
Vector2i position New position of the mouse.
const(Window) relativeTo Reference window.

static Vector2i getPosition();
Get the current position of the mouse in desktop coordinates.

This function returns the global position of the mouse cursor on the desktop.





Returns:
Current position of the mouse.

static Vector2i getPosition(const(Window) relativeTo);
Get the current position of the mouse in window coordinates.

This function returns the current position of the mouse cursor, relative to the given window.





Params:
const(Window) relativeTo Reference window.

Returns:
Current position of the mouse.

static bool isButtonPressed(Button button);
Check if a mouse button is pressed.

Params:
Button button Button to check.

Returns:
True if the button is pressed, false otherwise.