Documentation of SFML 2.0

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

Static Public Member Functions

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

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 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, 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
// set mouse position relative to a window
See Also
sf::Joystick, sf::Keyboard

Definition at line 43 of file Mouse.hpp.

Member Enumeration Documentation

Mouse buttons.

Enumerator:
Left 

The left mouse button.

Right 

The right mouse button.

Middle 

The middle (wheel) mouse button.

XButton1 

The first extra mouse button.

XButton2 

The second extra mouse button.

ButtonCount 

Keep last – the total number of mouse buttons.

Definition at line 51 of file Mouse.hpp.

Member Function Documentation

static Vector2i sf::Mouse::getPosition ( )
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
static Vector2i sf::Mouse::getPosition ( const Window relativeTo)
static

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
relativeToReference window
Returns
Current position of the mouse
static bool sf::Mouse::isButtonPressed ( Button  button)
static

Check if a mouse button is pressed.

Parameters
buttonButton to check
Returns
True if the button is pressed, false otherwise
static void sf::Mouse::setPosition ( const Vector2i position)
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
positionNew position of the mouse
static void sf::Mouse::setPosition ( const Vector2i position,
const Window relativeTo 
)
static

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
positionNew position of the mouse
relativeToReference window

The documentation for this class was generated from the following file: