Mercurial > sdl-ios-xcode
annotate include/SDL_mouse.h @ 1356:67114343400d
*** empty log message ***
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 10 Feb 2006 03:19:02 +0000 |
parents | 450721ad5436 |
children | c71e05b4dc2e |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
5 This library is free software; you can redistribute it and/or | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
0 | 7 License as published by the Free Software Foundation; either |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
10 This library is distributed in the hope that it will be useful, | |
11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
13 Lesser General Public License for more details. |
0 | 14 |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1046
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
19 Sam Lantinga | |
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
0 | 21 */ |
22 | |
23 /* Include file for SDL mouse event handling */ | |
24 | |
25 #ifndef _SDL_mouse_h | |
26 #define _SDL_mouse_h | |
27 | |
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
28 #include "SDL_stdinc.h" |
0 | 29 #include "SDL_video.h" |
30 | |
31 #include "begin_code.h" | |
32 /* Set up for C function definitions, even when using C++ */ | |
33 #ifdef __cplusplus | |
34 extern "C" { | |
35 #endif | |
36 | |
37 typedef struct WMcursor WMcursor; /* Implementation dependent */ | |
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
38 typedef struct SDL_Cursor { |
0 | 39 SDL_Rect area; /* The area of the mouse cursor */ |
40 Sint16 hot_x, hot_y; /* The "tip" of the cursor */ | |
41 Uint8 *data; /* B/W cursor data */ | |
42 Uint8 *mask; /* B/W cursor mask */ | |
43 Uint8 *save[2]; /* Place to save cursor area */ | |
44 WMcursor *wm_cursor; /* Window-manager cursor */ | |
45 } SDL_Cursor; | |
46 | |
47 /* Function prototypes */ | |
48 /* | |
49 * Retrieve the current state of the mouse. | |
50 * The current button state is returned as a button bitmask, which can | |
51 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the | |
52 * current mouse cursor position. You can pass NULL for either x or y. | |
53 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
54 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y); |
0 | 55 |
56 /* | |
57 * Retrieve the current state of the mouse. | |
58 * The current button state is returned as a button bitmask, which can | |
59 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the | |
60 * mouse deltas since the last call to SDL_GetRelativeMouseState(). | |
61 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
62 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y); |
0 | 63 |
64 /* | |
65 * Set the position of the mouse cursor (generates a mouse motion event) | |
66 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
67 extern DECLSPEC void SDLCALL SDL_WarpMouse(Uint16 x, Uint16 y); |
0 | 68 |
69 /* | |
70 * Create a cursor using the specified data and mask (in MSB format). | |
71 * The cursor width must be a multiple of 8 bits. | |
72 * | |
73 * The cursor is created in black and white according to the following: | |
74 * data mask resulting pixel on screen | |
75 * 0 1 White | |
76 * 1 1 Black | |
77 * 0 0 Transparent | |
78 * 1 0 Inverted color if possible, black if not. | |
79 * | |
80 * Cursors created with this function must be freed with SDL_FreeCursor(). | |
81 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
82 extern DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor |
0 | 83 (Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y); |
84 | |
85 /* | |
86 * Set the currently active cursor to the specified one. | |
87 * If the cursor is currently visible, the change will be immediately | |
88 * represented on the display. | |
89 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
90 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor *cursor); |
0 | 91 |
92 /* | |
93 * Returns the currently active cursor. | |
94 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
95 extern DECLSPEC SDL_Cursor * SDLCALL SDL_GetCursor(void); |
0 | 96 |
97 /* | |
98 * Deallocates a cursor created with SDL_CreateCursor(). | |
99 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
100 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor *cursor); |
0 | 101 |
102 /* | |
103 * Toggle whether or not the cursor is shown on the screen. | |
104 * The cursor start off displayed, but can be turned off. | |
105 * SDL_ShowCursor() returns 1 if the cursor was being displayed | |
106 * before the call, or 0 if it was not. You can query the current | |
107 * state by passing a 'toggle' value of -1. | |
108 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
109 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle); |
0 | 110 |
111 /* Used as a mask when testing buttons in buttonstate | |
112 Button 1: Left mouse button | |
113 Button 2: Middle mouse button | |
114 Button 3: Right mouse button | |
451
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
115 Button 4: Mouse wheel up (may also be a real button) |
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
116 Button 5: Mouse wheel down (may also be a real button) |
0 | 117 */ |
1330
450721ad5436
It's now possible to build SDL without any C runtime at all on Windows,
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
118 #define SDL_BUTTON(X) (1 << ((X)-1)) |
0 | 119 #define SDL_BUTTON_LEFT 1 |
120 #define SDL_BUTTON_MIDDLE 2 | |
121 #define SDL_BUTTON_RIGHT 3 | |
451
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
122 #define SDL_BUTTON_WHEELUP 4 |
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
123 #define SDL_BUTTON_WHEELDOWN 5 |
0 | 124 #define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT) |
125 #define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE) | |
126 #define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT) | |
127 | |
128 | |
129 /* Ends C function definitions when using C++ */ | |
130 #ifdef __cplusplus | |
131 } | |
132 #endif | |
133 #include "close_code.h" | |
134 | |
135 #endif /* _SDL_mouse_h */ |