This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_mouse.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2010 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
24
25
26
* \file SDL_mouse.h
*
* Include file for SDL mouse event handling.
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
*
* Please note that this ONLY discusses "mice" with the notion of the
* desktop GUI. You (usually) have one system cursor, and the OS hides
* the hardware details from you. If you plug in 10 mice, all ten move that
* one cursor. For many applications and games, this is perfect, and this
* API has served hundreds of SDL programs well since its birth.
*
* It's not the whole picture, though. If you want more lowlevel control,
* SDL offers a different API, that gives you visibility into each input
* device, multi-touch interfaces, etc.
*
* Those two APIs are incompatible, and you usually should not use both
* at the same time. But for legacy purposes, this API refers to a "mouse"
* when it actually means the system pointer and not a physical mouse.
*
* The other API is in SDL_input.h
44
45
46
47
#ifndef _SDL_mouse_h
#define _SDL_mouse_h
48
#include "SDL_stdinc.h"
49
#include "SDL_error.h"
50
51
52
53
54
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
55
/* *INDENT-OFF* */
56
extern "C" {
57
/* *INDENT-ON* */
58
59
#endif
60
typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
63
/* Function prototypes */
66
* \brief Get the window which currently has mouse focus.
68
extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
71
* \brief Retrieve the current state of the mouse.
73
74
75
76
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
* mouse cursor position relative to the focus window for the currently
* selected mouse. You can pass NULL for either x or y.
78
extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
81
82
83
84
85
* \brief Retrieve the relative state of the mouse.
*
* The current button state is returned as a button bitmask, which can
* be tested using the SDL_BUTTON(X) macros, and x and y are set to the
* mouse deltas since the last call to SDL_GetRelativeMouseState().
87
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
90
91
92
93
94
95
96
* \brief Moves the mouse to the given position within the window.
*
* \param window The window to move the mouse into, or NULL for the current mouse focus
* \param x The x coordinate within the window
* \param y The y coordinate within the window
*
* \note This function generates a mouse motion event
98
99
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
int x, int y);
102
* \brief Set relative mouse mode.
103
104
*
* \param enabled Whether or not to enable relative mode
106
107
108
109
110
111
112
113
114
115
* \return 0 on success, or -1 if relative mode is not supported.
*
* While the mouse is in relative mode, the cursor is hidden, and the
* driver will try to report continuous motion in the current window.
* Only relative motion events will be delivered, the mouse position
* will not change.
*
* \note This function will flush any pending mouse motion.
*
* \sa SDL_GetRelativeMouseMode()
117
extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
120
* \brief Query whether relative mouse mode is enabled.
121
122
*
* \sa SDL_SetRelativeMouseMode()
124
extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
127
128
* \brief Create a cursor, using the specified bitmap data and
* mask (in MSB format).
129
130
131
132
133
134
135
136
137
138
*
* The cursor width must be a multiple of 8 bits.
*
* The cursor is created in black and white according to the following:
* <table>
* <tr><td> data </td><td> mask </td><td> resulting pixel on screen </td></tr>
* <tr><td> 0 </td><td> 1 </td><td> White </td></tr>
* <tr><td> 1 </td><td> 1 </td><td> Black </td></tr>
* <tr><td> 0 </td><td> 0 </td><td> Transparent </td></tr>
* <tr><td> 1 </td><td> 0 </td><td> Inverted color if possible, black
139
* if not. </td></tr>
140
141
142
* </table>
*
* \sa SDL_FreeCursor()
143
*/
144
145
146
147
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
const Uint8 * mask,
int w, int h, int hot_x,
int hot_y);
150
* \brief Set the active cursor.
151
*/
152
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
155
* \brief Return the active cursor.
156
*/
157
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
160
161
162
* \brief Frees a cursor created with SDL_CreateCursor().
*
* \sa SDL_CreateCursor()
163
*/
164
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
167
* \brief Toggle whether or not the cursor is shown.
168
169
170
171
172
*
* \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current
* state.
*
* \return 1 if the cursor is shown, or 0 if the cursor is hidden.
173
*/
174
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
176
177
178
179
180
181
/**
* Used as a mask when testing buttons in buttonstate.
* - Button 1: Left mouse button
* - Button 2: Middle mouse button
* - Button 3: Right mouse button
*/
182
#define SDL_BUTTON(X) (1 << ((X)-1))
183
184
185
#define SDL_BUTTON_LEFT 1
#define SDL_BUTTON_MIDDLE 2
#define SDL_BUTTON_RIGHT 3
186
187
#define SDL_BUTTON_X1 4
#define SDL_BUTTON_X2 5
188
189
190
#define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT)
#define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE)
#define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT)
191
192
#define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
#define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
193
194
195
196
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
197
/* *INDENT-OFF* */
198
}
199
/* *INDENT-ON* */
200
201
202
203
#endif
#include "close_code.h"
#endif /* _SDL_mouse_h */
204
205
/* vi: set ts=4 sw=4 expandtab: */