My Project
SDL_mouse.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  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
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
28 #ifndef _SDL_mouse_h
29 #define _SDL_mouse_h
30 
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_video.h"
34 
35 #include "begin_code.h"
36 /* Set up for C function definitions, even when using C++ */
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
42 
46 typedef enum
47 {
60  SDL_NUM_SYSTEM_CURSORS
62 
66 typedef enum
67 {
71 
72 /* Function prototypes */
73 
77 extern DECLSPEC SDL_Window * SDLCALL SDL_GetMouseFocus(void);
78 
87 extern DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y);
88 
112 extern DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(int *x, int *y);
113 
121 extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
122 
132 extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
133  int x, int y);
134 
144 extern DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y);
145 
162 extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
163 
193 extern DECLSPEC int SDLCALL SDL_CaptureMouse(SDL_bool enabled);
194 
200 extern DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void);
201 
220 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data,
221  const Uint8 * mask,
222  int w, int h, int hot_x,
223  int hot_y);
224 
230 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface,
231  int hot_x,
232  int hot_y);
233 
239 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id);
240 
244 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
245 
249 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
250 
254 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void);
255 
263 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
264 
273 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
274 
281 #define SDL_BUTTON(X) (1 << ((X)-1))
282 #define SDL_BUTTON_LEFT 1
283 #define SDL_BUTTON_MIDDLE 2
284 #define SDL_BUTTON_RIGHT 3
285 #define SDL_BUTTON_X1 4
286 #define SDL_BUTTON_X2 5
287 #define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT)
288 #define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE)
289 #define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT)
290 #define SDL_BUTTON_X1MASK SDL_BUTTON(SDL_BUTTON_X1)
291 #define SDL_BUTTON_X2MASK SDL_BUTTON(SDL_BUTTON_X2)
292 
293 
294 /* Ends C function definitions when using C++ */
295 #ifdef __cplusplus
296 }
297 #endif
298 #include "close_code.h"
299 
300 #endif /* _SDL_mouse_h */
301 
302 /* vi: set ts=4 sw=4 expandtab: */
Definition: SDL_mouse.h:54
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:143
Definition: SDL_mouse.h:49
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:90
DECLSPEC int SDLCALL SDL_CaptureMouse(SDL_bool enabled)
Capture the mouse, to track input outside an SDL window.
Definition: SDL_mouse.h:48
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:159
DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 *data, const Uint8 *mask, int w, int h, int hot_x, int hot_y)
Create a cursor, using the specified bitmap data and mask (in MSB format).
DECLSPEC SDL_Cursor *SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor id)
Create a system cursor.
Definition: SDL_mouse.h:50
DECLSPEC SDL_bool SDLCALL SDL_GetRelativeMouseMode(void)
Query whether relative mouse mode is enabled.
Definition: SDL_mouse.h:59
DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window *window, int x, int y)
Moves the mouse to the given position within the window.
Definition: SDL_mouse.h:51
DECLSPEC Uint32 SDLCALL SDL_GetMouseState(int *x, int *y)
Retrieve the current state of the mouse.
Definition: SDL_mouse.h:53
DECLSPEC SDL_Window *SDLCALL SDL_GetMouseFocus(void)
Get the window which currently has mouse focus.
DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y)
Retrieve the relative state of the mouse.
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
DECLSPEC int SDLCALL SDL_ShowCursor(int toggle)
Toggle whether or not the cursor is shown.
Definition: SDL_mouse.h:68
Definition: SDL_mouse.h:52
DECLSPEC Uint32 SDLCALL SDL_GetGlobalMouseState(int *x, int *y)
Get the current state of the mouse, in relation to the desktop.
SDL_SystemCursor
Cursor types for SDL_CreateSystemCursor().
Definition: SDL_mouse.h:46
Definition: SDL_mouse.h:57
DECLSPEC SDL_Cursor *SDLCALL SDL_GetDefaultCursor(void)
Return the default cursor.
DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor *cursor)
Frees a cursor created with SDL_CreateCursor() or similar functions.
Definition: SDL_mouse.h:58
DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y)
Moves the mouse to the given position in global screen space.
DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor *cursor)
Set the active cursor.
DECLSPEC SDL_Cursor *SDLCALL SDL_CreateColorCursor(SDL_Surface *surface, int hot_x, int hot_y)
Create a color cursor.
Definition: SDL_mouse.h:56
SDL_MouseWheelDirection
Scroll direction types for the Scroll event.
Definition: SDL_mouse.h:66
DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled)
Set relative mouse mode.
Definition: SDL_mouse.h:55
Definition: SDL_mouse.h:69
DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void)
Return the active cursor.