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

final abstract

class Mouse {

enum Button;

static void setPosition(Vector2i position);

static void setPosition(Vector2i position, const(Window) relativeTo);

static Vector2i getPosition();

static Vector2i getPosition(const(Window) relativeTo);

static bool isButtonPressed(Button button);

}

Members

Enums

Button enum Button: Undocumented in source.

Static functions

getPosition Vector2i getPosition(): Get the current position of the mouse in desktop coordinates.
getPosition Vector2i getPosition(const(Window) relativeTo): Get the current position of the mouse in window coordinates.
isButtonPressed bool isButtonPressed(Button button): Check if a mouse button is pressed.
setPosition void setPosition(Vector2i position): Set the current position of the mouse in desktop coordinates.
setPosition void setPosition(Vector2i position, const(Window) relativeTo): Set the current position of the mouse in window coordinates.

Mouse

Members

Enums

Static functions

Meta

Source