Mercurial > sdl-ios-xcode
annotate include/SDL_mouse.h @ 1674:7688a73b25b1 SDL-1.3
Finishing up keyboard code revamp, at least for now...
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sun, 11 Jun 2006 05:27:10 +0000 |
| parents | 624e1412fbba |
| children | 5daa04d862f1 |
| 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 | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
23 /** |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
24 * \file SDL_mouse.h |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
25 * |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
26 * Include file for SDL mouse event handling |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
27 */ |
| 0 | 28 |
| 29 #ifndef _SDL_mouse_h | |
| 30 #define _SDL_mouse_h | |
| 31 | |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 #include "SDL_video.h" |
| 35 | |
| 36 #include "begin_code.h" | |
| 37 /* Set up for C function definitions, even when using C++ */ | |
| 38 #ifdef __cplusplus | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
39 /* *INDENT-OFF* */ |
| 0 | 40 extern "C" { |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
41 /* *INDENT-ON* */ |
| 0 | 42 #endif |
| 43 | |
| 1670 | 44 typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */ |
| 0 | 45 |
| 46 /* Function prototypes */ | |
| 1670 | 47 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
48 /** |
|
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
49 * \fn int SDL_GetNumMice(void) |
| 1670 | 50 * |
| 51 * \brief Get the number of mouse input devices available. | |
| 52 * | |
| 53 * \sa SDL_SelectMouse() | |
| 54 */ | |
| 55 extern DECLSPEC int SDLCALL SDL_GetNumMice(void); | |
| 56 | |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
57 /** |
|
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
58 * \fn int SDL_SelectMouse(int index) |
| 1670 | 59 * |
| 60 * \brief Set the index of the currently selected mouse. | |
| 61 * | |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
62 * \return The index of the previously selected mouse. |
| 1670 | 63 * |
| 64 * \note You can query the currently selected mouse by passing an index of -1. | |
| 65 * | |
| 66 * \sa SDL_GetNumMice() | |
| 67 */ | |
| 68 extern DECLSPEC int SDLCALL SDL_SelectMouse(int index); | |
| 69 | |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
70 /** |
|
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
71 * \fn SDL_WindowID SDL_GetMouseFocusWindow(void) |
| 1670 | 72 * |
| 73 * \brief Get the window which currently has focus for the currently selected mouse. | |
| 74 */ | |
| 75 extern DECLSPEC SDL_WindowID SDLCALL SDL_GetMouseFocusWindow(void); | |
| 76 | |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
77 /** |
| 1670 | 78 * \fn Uint8 SDL_GetMouseState(int *x, int *y) |
| 79 * | |
| 80 * \brief Retrieve the current state of the mouse. | |
| 81 * | |
| 0 | 82 * The current button state is returned as a button bitmask, which can |
| 83 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the | |
| 1670 | 84 * mouse cursor position relative to the focus window for the currently |
| 85 * selected mouse. You can pass NULL for either x or y. | |
| 0 | 86 */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
87 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y); |
| 0 | 88 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
89 /** |
| 1670 | 90 * \fn Uint8 SDL_GetRelativeMouseState(int *x, int *y) |
| 91 * | |
| 92 * \brief Retrieve the current state of the mouse. | |
| 93 * | |
| 0 | 94 * The current button state is returned as a button bitmask, which can |
| 95 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the | |
| 96 * mouse deltas since the last call to SDL_GetRelativeMouseState(). | |
| 97 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
98 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y); |
| 0 | 99 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
100 /** |
| 1670 | 101 * \fn void SDL_WarpMouseInWindow(SDL_WindowID windowID, int x, int y) |
| 102 * | |
| 103 * \brief Moves the currently selected mouse to the given position within the window. | |
| 104 * | |
| 105 * \param windowID The window to move the mouse into, or 0 for the current mouse focus | |
| 106 * \param x The x coordinate within the window | |
| 107 * \param y The y coordinate within the window | |
| 108 * | |
| 109 * \note This function generates a mouse motion event | |
| 0 | 110 */ |
| 1670 | 111 extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_WindowID windowID, |
| 112 int x, int y); | |
| 0 | 113 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
114 /** |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
115 * \fn SDL_Cursor *SDL_CreateCursor (const Uint8 * data, const Uint8 * mask, int w, int h, int hot_x, int hot_y) |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
116 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
117 * \brief Create a cursor for the currently selected mouse, using the |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
118 * specified bitmap data and mask (in MSB format). |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
119 * |
| 0 | 120 * The cursor width must be a multiple of 8 bits. |
| 121 * | |
| 122 * The cursor is created in black and white according to the following: | |
| 123 * data mask resulting pixel on screen | |
| 124 * 0 1 White | |
| 125 * 1 1 Black | |
| 126 * 0 0 Transparent | |
| 127 * 1 0 Inverted color if possible, black if not. | |
| 128 * | |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
129 * \sa SDL_FreeCursor() |
| 0 | 130 */ |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
131 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor(const Uint8 * data, |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
132 const Uint8 * mask, |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
133 int w, int h, int hot_x, |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
134 int hot_y); |
| 0 | 135 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
136 /** |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
137 * \fn void SDL_SetCursor(SDL_Cursor * cursor) |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
138 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
139 * \brief Set the active cursor for the currently selected mouse. |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
140 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
141 * \note The cursor must have been created for the selected mouse. |
| 0 | 142 */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
143 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor); |
| 0 | 144 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
145 /** |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
146 * \fn SDL_Cursor *SDL_GetCursor(void) |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
147 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
148 * \brief Return the active cursor for the currently selected mouse. |
| 0 | 149 */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
150 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void); |
| 0 | 151 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
152 /** |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
153 * \fn void SDL_FreeCursor(SDL_Cursor * cursor) |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
154 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
155 * \brief Frees a cursor created with SDL_CreateCursor(). |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
156 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
157 * \sa SDL_CreateCursor() |
| 0 | 158 */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
159 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor); |
| 0 | 160 |
|
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1671
diff
changeset
|
161 /** |
|
1671
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
162 * \fn int SDL_ShowCursor(int toggle) |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
163 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
164 * \brief Toggle whether or not the cursor is shown for the currently selected mouse. |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
165 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
166 * \param toggle 1 to show the cursor, 0 to hide it, -1 to query the current state. |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
167 * |
|
89f7510fe17a
Moved the cursor handling into the mouse code.
Sam Lantinga <slouken@libsdl.org>
parents:
1670
diff
changeset
|
168 * \return 1 if the cursor is shown, or 0 if the cursor is hidden. |
| 0 | 169 */ |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
170 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle); |
| 0 | 171 |
| 172 /* Used as a mask when testing buttons in buttonstate | |
| 173 Button 1: Left mouse button | |
| 174 Button 2: Middle mouse button | |
| 175 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
|
176 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
|
177 Button 5: Mouse wheel down (may also be a real button) |
| 0 | 178 */ |
|
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
|
179 #define SDL_BUTTON(X) (1 << ((X)-1)) |
| 0 | 180 #define SDL_BUTTON_LEFT 1 |
| 181 #define SDL_BUTTON_MIDDLE 2 | |
| 182 #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
|
183 #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
|
184 #define SDL_BUTTON_WHEELDOWN 5 |
| 0 | 185 #define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT) |
| 186 #define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE) | |
| 187 #define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT) | |
| 188 | |
| 189 | |
| 190 /* Ends C function definitions when using C++ */ | |
| 191 #ifdef __cplusplus | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
192 /* *INDENT-OFF* */ |
| 0 | 193 } |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
194 /* *INDENT-ON* */ |
| 0 | 195 #endif |
| 196 #include "close_code.h" | |
| 197 | |
| 198 #endif /* _SDL_mouse_h */ | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
199 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
200 /* vi: set ts=4 sw=4 expandtab: */ |