Simple and Fast Multimedia Library
Documentation for SFML 2.0
Initializing search
SFML
Home
Learn
Tutorials
Documentation
Download
Community
Development
Donate
Simple and Fast Multimedia Library
Home
Learn
Tutorials
Documentation
Documentation
SFML 3.1.0
SFML 3.0.2
SFML 3.0.1
SFML 3.0.0
SFML 2.6.2
SFML 2.6.1
SFML 2.6.0
SFML 2.5.1
SFML 2.5.0
SFML 2.4.2
SFML 2.4.1
SFML 2.4.0
SFML 2.3.2
SFML 2.3.1
SFML 2.3
SFML 2.2
SFML 2.1
SFML 2.0
SFML 1.6
Download
Community
Development
Warning
This page refers to an old version of SFML.
Click here to switch to the latest version.
Main Page
Topics
Namespaces
Classes
Files
File List
File Members
Loading...
Searching...
No Matches
SFML
include
SFML
Window
Mouse.hpp
Go to the documentation of this file.
1
2
//
3
// SFML - Simple and Fast Multimedia Library
4
// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
5
//
6
// This software is provided 'as-is', without any express or implied warranty.
7
// In no event will the authors be held liable for any damages arising from the use of this software.
8
//
9
// Permission is granted to anyone to use this software for any purpose,
10
// including commercial applications, and to alter it and redistribute it freely,
11
// subject to the following restrictions:
12
//
13
// 1. The origin of this software must not be misrepresented;
14
// you must not claim that you wrote the original software.
15
// If you use this software in a product, an acknowledgment
16
// in the product documentation would be appreciated but is not required.
17
//
18
// 2. Altered source versions must be plainly marked as such,
19
// and must not be misrepresented as being the original software.
20
//
21
// 3. This notice may not be removed or altered from any source distribution.
22
//
24
25
#ifndef SFML_MOUSE_HPP
26
#define SFML_MOUSE_HPP
27
29
// Headers
31
#include <
SFML/Window/Export.hpp
>
32
#include <
SFML/System/Vector2.hpp
>
33
34
35
namespace
sf
36
{
37
class
Window
;
38
43
class
SFML_WINDOW_API
Mouse
44
{
45
public :
46
51
enum
Button
52
{
53
Left
,
54
Right
,
55
Middle
,
56
XButton1
,
57
XButton2
,
58
59
ButtonCount
60
};
61
70
static
bool
isButtonPressed
(
Button
button);
71
81
static
Vector2i
getPosition
();
82
94
static
Vector2i
getPosition
(
const
Window
& relativeTo);
95
105
static
void
setPosition
(
const
Vector2i
& position);
106
117
static
void
setPosition
(
const
Vector2i
& position,
const
Window
& relativeTo);
118
};
119
120
}
// namespace sf
121
122
123
#endif
// SFML_MOUSE_HPP
124
125
Vector2.hpp
Export.hpp
SFML_WINDOW_API
#define SFML_WINDOW_API
Definition
Window/Export.hpp:43
sf::Mouse
Give access to the real-time state of the mouse.
Definition
Mouse.hpp:44
sf::Mouse::setPosition
static void setPosition(const Vector2i &position)
Set the current position of the mouse in desktop coordinates.
sf::Mouse::Button
Button
Mouse buttons.
Definition
Mouse.hpp:52
sf::Mouse::XButton2
@ XButton2
The second extra mouse button.
Definition
Mouse.hpp:57
sf::Mouse::Middle
@ Middle
The middle (wheel) mouse button.
Definition
Mouse.hpp:55
sf::Mouse::ButtonCount
@ ButtonCount
Keep last – the total number of mouse buttons.
Definition
Mouse.hpp:59
sf::Mouse::Left
@ Left
The left mouse button.
Definition
Mouse.hpp:53
sf::Mouse::XButton1
@ XButton1
The first extra mouse button.
Definition
Mouse.hpp:56
sf::Mouse::Right
@ Right
The right mouse button.
Definition
Mouse.hpp:54
sf::Mouse::getPosition
static Vector2i getPosition(const Window &relativeTo)
Get the current position of the mouse in window coordinates.
sf::Mouse::isButtonPressed
static bool isButtonPressed(Button button)
Check if a mouse button is pressed.
sf::Mouse::getPosition
static Vector2i getPosition()
Get the current position of the mouse in desktop coordinates.
sf::Mouse::setPosition
static void setPosition(const Vector2i &position, const Window &relativeTo)
Set the current position of the mouse in window coordinates.
sf::Window
Window that serves as a target for OpenGL rendering.
Definition
Window/Window.hpp:58
sf
Definition
Listener.hpp:36
sf::Vector2i
Vector2< int > Vector2i
Definition
Vector2.hpp:253
Back to top