CSFML 2.6.1

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
Mouse.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 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_H
26#define SFML_MOUSE_H
27
29// Headers
31#include <SFML/Window/Export.h>
32#include <SFML/Window/Types.h>
33#include <SFML/System/Vector2.h>
34
35
40 typedef enum
41{
42 sfMouseLeft,
43 sfMouseRight,
44 sfMouseMiddle,
45 sfMouseXButton1,
46 sfMouseXButton2,
47
48 sfMouseButtonCount
49} sfMouseButton;
50
55 typedef enum
56{
57 sfMouseVerticalWheel,
58 sfMouseHorizontalWheel
59} sfMouseWheel;
60
61
70 CSFML_WINDOW_API sfBool sfMouse_isButtonPressed(sfMouseButton button);
71
83 CSFML_WINDOW_API sfVector2i sfMouse_getPosition(const sfWindow* relativeTo);
84
95 CSFML_WINDOW_API void sfMouse_setPosition(sfVector2i position, const sfWindow* relativeTo);
96
108 CSFML_WINDOW_API sfVector2i sfMouse_getPositionWindowBase(const sfWindowBase* relativeTo);
109
120 CSFML_WINDOW_API void sfMouse_setPositionWindowBase(sfVector2i position, const sfWindowBase* relativeTo);
121
122
123#endif // SFML_MOUSE_H
sfBool
int sfBool
Definition Config.h:153
sfMouse_setPosition
void sfMouse_setPosition(sfVector2i position, const sfWindow *relativeTo)
Set the current position of the mouse.
sfMouseWheel
sfMouseWheel
Mouse wheels.
Definition Mouse.h:56
sfMouseVerticalWheel
@ sfMouseVerticalWheel
The vertical mouse wheel.
Definition Mouse.h:57
sfMouseHorizontalWheel
@ sfMouseHorizontalWheel
The horizontal mouse wheel.
Definition Mouse.h:58
sfMouse_getPositionWindowBase
sfVector2i sfMouse_getPositionWindowBase(const sfWindowBase *relativeTo)
Get the current position of the mouse relative to a window base.
sfMouse_getPosition
sfVector2i sfMouse_getPosition(const sfWindow *relativeTo)
Get the current position of the mouse.
sfMouse_isButtonPressed
sfBool sfMouse_isButtonPressed(sfMouseButton button)
Check if a mouse button is pressed.
sfMouseButton
sfMouseButton
Mouse buttons.
Definition Mouse.h:41
sfMouseXButton1
@ sfMouseXButton1
The first extra mouse button.
Definition Mouse.h:45
sfMouseXButton2
@ sfMouseXButton2
The second extra mouse button.
Definition Mouse.h:46
sfMouseRight
@ sfMouseRight
The right mouse button.
Definition Mouse.h:43
sfMouseButtonCount
@ sfMouseButtonCount
Keep last – the total number of mouse buttons.
Definition Mouse.h:48
sfMouseMiddle
@ sfMouseMiddle
The middle (wheel) mouse button.
Definition Mouse.h:44
sfMouseLeft
@ sfMouseLeft
The left mouse button.
Definition Mouse.h:42
sfMouse_setPositionWindowBase
void sfMouse_setPositionWindowBase(sfVector2i position, const sfWindowBase *relativeTo)
Set the current position of the mouse relative to a window base.
Vector2.h
Export.h
CSFML_WINDOW_API
#define CSFML_WINDOW_API
Definition Window/Export.h:43
Types.h
sfWindow
struct sfWindow sfWindow
Definition Window/Types.h:31
sfWindowBase
struct sfWindowBase sfWindowBase
Definition Window/Types.h:32
sfVector2i
2-component vector of integers
Definition Vector2.h:39