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.
28
29
30
31
#ifndef _SDL_mouse_h
#define _SDL_mouse_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
35
36
37
38
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
39
/* *INDENT-OFF* */
40
extern "C" {
41
/* *INDENT-ON* */
42
43
#endif
44
typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
45
46
/* Function prototypes */
49
50
51
* \brief Get the number of mouse input devices available.
*
* \sa SDL_SelectMouse()
52
53
54
*/
extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
56
57
58
59
60
* \brief Gets the name of a mouse with the given index.
*
* \param index is the index of the mouse, which name is to be returned.
*
* \return the name of the mouse with the specified index
61
62
63
*/
extern DECLSPEC char *SDLCALL SDL_GetMouseName(int index);
65
66
67
68
69
70
71
* \brief Set the index of the currently selected mouse.
*
* \return The index of the previously selected mouse.
*
* \note You can query the currently selected mouse by passing an index of -1.
*
* \sa SDL_GetNumMice()
72
73
74
75
*/
extern DECLSPEC int SDLCALL SDL_SelectMouse(int index);
/**
76
* \brief Get the window which currently has focus for the specified mouse.
78
extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocusWindow(int index);
81
82
83
84
85
86
87
88
89
90
91
92
93
94
* \brief Set relative mouse mode for the specified mouse.
*
* \param enabled Whether or not to enable relative mode
*
* \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()
96
97
extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(int index,
SDL_bool enabled);
100
101
102
* \brief Query whether relative mouse mode is enabled for the specified mouse.
*
* \sa SDL_SetRelativeMouseMode()
104
extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(int index);
107
108
109
110
111
112
* \brief Retrieve the current state of the specified 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 cursor position relative to the focus window for the currently
* selected mouse. You can pass NULL for either x or y.
113
*/
114
extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
117
* \brief Retrieve the state of the specified mouse.
119
120
121
* 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().
122
*/
123
124
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int index, int *x,
int *y);
127
128
* \brief Moves the currently selected mouse to the given position within the window.
*
129
* \param window The window to move the mouse into, or NULL for the current mouse focus
130
131
132
133
* \param x The x coordinate within the window
* \param y The y coordinate within the window
*
* \note This function generates a mouse motion event
134
*/
135
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
136
int x, int y);
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
* \brief Create a cursor for the currently selected mouse, using the
* specified bitmap data and mask (in MSB format).
*
* 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
if not. </td></tr>
* </table>
*
* \sa SDL_FreeCursor()
155
*/
156
157
158
159
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
const Uint8 * mask,
int w, int h, int hot_x,
int hot_y);
162
163
164
* \brief Set the active cursor for the currently selected mouse.
*
* \note The cursor must have been created for the selected mouse.
165
*/
166
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
169
* \brief Return the active cursor for the currently selected mouse.
170
*/
171
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
174
175
176
* \brief Frees a cursor created with SDL_CreateCursor().
*
* \sa SDL_CreateCursor()
177
*/
178
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
181
182
183
184
185
186
187
* \brief Toggle whether or not the cursor is shown for the currently selected
* mouse.
*
* \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.
188
*/
189
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
192
193
194
195
196
197
198
199
200
201
202
203
* \brief Gets the number of cursors a pointing device supports.
*
* Useful for tablet users. Useful only under Windows.
*
* \param index is the index of the pointing device, which number of cursors we
* want to receive.
*
* \return the number of cursors supported by the pointing device. On Windows
* if a device is a tablet it returns a number >=1. Normal mice always
* return 1.
*
* On Linux every device reports one cursor.
205
206
extern DECLSPEC int SDLCALL SDL_GetCursorsNumber(int index);
208
209
210
211
212
213
214
215
216
217
218
219
* \brief Returns the index of the current cursor used by a specific pointing
* device.
*
* Useful only under Windows.
*
* \param index is the index of the pointing device, which cursor index we want
* to receive.
*
* \return the index of the cursor currently used by a specific pointing
* device. Always 0 under Linux. On Windows if the device isn't a
* tablet it returns 0. If the device is the tablet it returns the
* cursor index. 0 - stylus, 1 - eraser, 2 - cursor.
221
222
extern DECLSPEC int SDLCALL SDL_GetCurrentCursor(int index);
223
224
225
226
227
228
/**
* Used as a mask when testing buttons in buttonstate.
* - Button 1: Left mouse button
* - Button 2: Middle mouse button
* - Button 3: Right mouse button
*/
229
#define SDL_BUTTON(X) (1 << ((X)-1))
230
231
232
#define SDL_BUTTON_LEFT 1
#define SDL_BUTTON_MIDDLE 2
#define SDL_BUTTON_RIGHT 3
233
234
#define SDL_BUTTON_X1 4
#define SDL_BUTTON_X2 5
235
236
237
#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)
238
239
#define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
#define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
240
241
242
243
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
244
/* *INDENT-OFF* */
245
}
246
/* *INDENT-ON* */
247
248
249
250
#endif
#include "close_code.h"
#endif /* _SDL_mouse_h */
251
252
/* vi: set ts=4 sw=4 expandtab: */