sf::Mouse Class Reference
Give access to the real-time state of the mouse. More...
#include <Mouse.hpp>
Public Types | |
| enum | Button { Left, Right, Middle, XButton1, XButton2, ButtonCount } |
| Mouse buttons. More... | |
| enum | Wheel { VerticalWheel, HorizontalWheel } |
| Mouse wheels. More... | |
Static Public Member Functions | |
| static bool | isButtonPressed (Button button) |
| Check if a mouse button is pressed. More... | |
| static Vector2i | getPosition () |
| Get the current position of the mouse in desktop coordinates. More... | |
| static Vector2i | getPosition (const Window &relativeTo) |
| Get the current position of the mouse in window coordinates. More... | |
| static void | setPosition (const Vector2i &position) |
| Set the current position of the mouse in desktop coordinates. More... | |
| static void | setPosition (const Vector2i &position, const Window &relativeTo) |
| Set the current position of the mouse in window coordinates. More... | |
Detailed Description
Give access to the real-time state of the mouse.
sf::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 instantiated.
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, sf::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).
Usage example:
{
// left click...
}
// get global mouse position
sf::Vector2i position = sf::Mouse::getPosition();
// set mouse position relative to a window
sf::Mouse::setPosition(sf::Vector2i(100, 200), window);
- See also
- sf::Joystick, sf::Keyboard, sf::Touch
Member Enumeration Documentation
◆ Button
| enum sf::Mouse::Button |
Mouse buttons.
◆ Wheel
| enum sf::Mouse::Wheel |
Member Function Documentation
◆ getPosition() [1/2]
|
static |
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
◆ getPosition() [2/2]
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.
- Parameters
-
relativeTo Reference window
- Returns
- Current position of the mouse
◆ isButtonPressed()
|
static |
Check if a mouse button is pressed.
- Parameters
-
button Button to check
- Returns
- True if the button is pressed, false otherwise
◆ setPosition() [1/2]
|
static |
Set the current position of the mouse in desktop coordinates.
This function sets the global position of the mouse cursor on the desktop.
- Parameters
-
position New position of the mouse
◆ setPosition() [2/2]
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.
- Parameters
-
position New position of the mouse relativeTo Reference window
The documentation for this class was generated from the following file: