This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_mouse.h
2
3
Simple DirectMedia Layer
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
5
6
7
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
9
10
11
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
13
14
15
16
17
18
19
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
*/
23
24
25
* \file SDL_mouse.h
*
* Include file for SDL mouse event handling.
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
*
* 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
43
44
45
46
#ifndef _SDL_mouse_h
#define _SDL_mouse_h
47
#include "SDL_stdinc.h"
48
#include "SDL_error.h"
49
50
51
52
53
#include "SDL_video.h"
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
54
/* *INDENT-OFF* */
55
extern "C" {
56
/* *INDENT-ON* */
57
58
#endif
59
typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
62
/* Function prototypes */
65
* \brief Get the window which currently has mouse focus.
67
extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
70
* \brief Retrieve the current state of the mouse.
72
73
74
75
* 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.
77
extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
80
81
82
83
84
* \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().
86
extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
89
90
91
92
93
94
95
* \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
97
98
extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
int x, int y);
101
* \brief Set relative mouse mode.
102
103
*
* \param enabled Whether or not to enable relative mode
105
106
107
108
109
110
111
112
113
114
* \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()
116
extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
119
* \brief Query whether relative mouse mode is enabled.
120
121
*
* \sa SDL_SetRelativeMouseMode()
123
extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
126
127
* \brief Create a cursor, using the specified bitmap data and
* mask (in MSB format).
128
129
130
131
132
133
134
135
136
137
*
* 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
138
* if not. </td></tr>
139
140
141
* </table>
*
* \sa SDL_FreeCursor()
142
*/
143
144
145
146
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
const Uint8 * mask,
int w, int h, int hot_x,
int hot_y);
148
149
150
151
152
153
154
155
156
/**
* \brief Create a color cursor.
*
* \sa SDL_FreeCursor()
*/
extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
int hot_x,
int hot_y);
158
* \brief Set the active cursor.
159
*/
160
extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
163
* \brief Return the active cursor.
164
*/
165
extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
168
169
170
* \brief Frees a cursor created with SDL_CreateCursor().
*
* \sa SDL_CreateCursor()
171
*/
172
extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
175
* \brief Toggle whether or not the cursor is shown.
176
177
178
179
180
*
* \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.
181
*/
182
extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
184
185
186
187
188
189
/**
* Used as a mask when testing buttons in buttonstate.
* - Button 1: Left mouse button
* - Button 2: Middle mouse button
* - Button 3: Right mouse button
*/
190
#define SDL_BUTTON(X) (1 << ((X)-1))
191
192
193
#define SDL_BUTTON_LEFT 1
#define SDL_BUTTON_MIDDLE 2
#define SDL_BUTTON_RIGHT 3
194
195
#define SDL_BUTTON_X1 4
#define SDL_BUTTON_X2 5
196
197
198
#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)
199
200
#define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
#define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
201
202
203
204
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
205
/* *INDENT-OFF* */
206
}
207
/* *INDENT-ON* */
208
209
210
211
#endif
#include "close_code.h"
#endif /* _SDL_mouse_h */
212
213
/* vi: set ts=4 sw=4 expandtab: */