SFML - Simple and Fast Multimedia Library

SFML 2.6.1

- Main Page
- Related Pages
- Topics
- Namespaces
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
Mouse.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
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
35namespace sf
36{
37class WindowBase;
38
43 class SFML_WINDOW_API Mouse
44{
45public:
46
51 enum Button
52 {
53 Left,
54 Right,
55 Middle,
56 XButton1,
57 XButton2,
58
59 ButtonCount
60 };
61
66 enum Wheel
67 {
68 VerticalWheel,
69 HorizontalWheel
70 };
71
83 static bool isButtonPressed(Button button);
84
94 static Vector2i getPosition();
95
107 static Vector2i getPosition(const WindowBase& relativeTo);
108
118 static void setPosition(const Vector2i& position);
119
130 static void setPosition(const Vector2i& position, const WindowBase& relativeTo);
131};
132
133} // namespace sf
134
135
136#endif // SFML_MOUSE_HPP
137
138
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::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::Wheel
Wheel
Mouse wheels.
Definition Mouse.hpp:67
sf::Mouse::VerticalWheel
@ VerticalWheel
The vertical mouse wheel.
Definition Mouse.hpp:68
sf::Mouse::setPosition
static void setPosition(const Vector2i &position, const WindowBase &relativeTo)
Set 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::getPosition
static Vector2i getPosition(const WindowBase &relativeTo)
Get the current position of the mouse in window coordinates.
sf::Vector2
Utility template class for manipulating 2-dimensional vectors.
Definition Vector2.hpp:38
sf::WindowBase
Window that serves as a base for other windows.
Definition WindowBase.hpp:57