CSFML 3.0.0
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-2026 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#pragma once
26
28// Headers
30#include <CSFML/Window/Export.h>
31
32#include <CSFML/System/Vector2.h>
33#include <CSFML/Window/Types.h>
34
35
40 typedef enum
41{
42 sfMouseLeft,
43 sfMouseRight,
44 sfMouseMiddle,
45 sfMouseButtonExtra1,
46 sfMouseButtonExtra2,
47} sfMouseButton;
48
49 enum
50{
51 sfMouseButtonCount = sfMouseButtonExtra2 + 1
52};
53
58 typedef enum
59{
60 sfMouseVerticalWheel,
61 sfMouseHorizontalWheel
62} sfMouseWheel;
63
64
73 CSFML_WINDOW_API bool sfMouse_isButtonPressed(sfMouseButton button);
74
86 CSFML_WINDOW_API sfVector2i sfMouse_getPosition(const sfWindow* relativeTo);
87
98 CSFML_WINDOW_API void sfMouse_setPosition(sfVector2i position, const sfWindow* relativeTo);
99
111 CSFML_WINDOW_API sfVector2i sfMouse_getPositionWindowBase(const sfWindowBase* relativeTo);
112
123 CSFML_WINDOW_API void sfMouse_setPositionWindowBase(sfVector2i position, const sfWindowBase* relativeTo);
sfMouse_isButtonPressed
bool sfMouse_isButtonPressed(sfMouseButton button)
Check if a mouse button is pressed.
sfMouse_setPosition
void sfMouse_setPosition(sfVector2i position, const sfWindow *relativeTo)
Set the current position of the mouse.
sfMouseWheel
sfMouseWheel
Mouse wheels.
Definition Mouse.h:59
sfMouseVerticalWheel
@ sfMouseVerticalWheel
The vertical mouse wheel.
Definition Mouse.h:60
sfMouseHorizontalWheel
@ sfMouseHorizontalWheel
The horizontal mouse wheel.
Definition Mouse.h:61
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.
sfMouseButton
sfMouseButton
Mouse buttons.
Definition Mouse.h:41
sfMouseButtonExtra2
@ sfMouseButtonExtra2
The second extra mouse button.
Definition Mouse.h:46
sfMouseRight
@ sfMouseRight
The right mouse button.
Definition Mouse.h:43
sfMouseMiddle
@ sfMouseMiddle
The middle (wheel) mouse button.
Definition Mouse.h:44
sfMouseButtonExtra1
@ sfMouseButtonExtra1
The first extra mouse button.
Definition Mouse.h:45
sfMouseLeft
@ sfMouseLeft
The left mouse button.
Definition Mouse.h:42
sfMouseButtonCount
@ sfMouseButtonCount
The total number of mouse buttons.
Definition Mouse.h:51
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:42
Types.h
sfWindow
struct sfWindow sfWindow
Definition Window/Types.h:30
sfWindowBase
struct sfWindowBase sfWindowBase
Definition Window/Types.h:31
sfVector2i
2-component vector of integers
Definition Vector2.h:38