Mercurial > sdl-ios-xcode
annotate include/SDL_mouse.h @ 1668:4da1ee79c9af SDL-1.3
more tweaking indent options
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 29 May 2006 04:04:35 +0000 |
| parents | 782fd950bd46 |
| children | eef792d31de8 |
| 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 | |
|
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
|
44 typedef struct WMcursor WMcursor; /* Implementation dependent */ |
|
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
|
45 typedef struct SDL_Cursor |
|
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
|
46 { |
|
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
|
47 SDL_Rect area; /* The area of the mouse cursor */ |
|
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
|
48 Sint16 hot_x, hot_y; /* The "tip" of the cursor */ |
|
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
|
49 Uint8 *data; /* B/W cursor data */ |
|
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
|
50 Uint8 *mask; /* B/W cursor mask */ |
|
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
|
51 Uint8 *save[2]; /* Place to save cursor area */ |
|
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
|
52 WMcursor *wm_cursor; /* Window-manager cursor */ |
| 0 | 53 } SDL_Cursor; |
| 54 | |
| 55 /* Function prototypes */ | |
| 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 * current mouse cursor position. You can pass NULL for either x or y. | |
| 61 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
62 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y); |
| 0 | 63 |
| 64 /* | |
| 65 * Retrieve the current state of the mouse. | |
| 66 * The current button state is returned as a button bitmask, which can | |
| 67 * be tested using the SDL_BUTTON(X) macros, and x and y are set to the | |
| 68 * mouse deltas since the last call to SDL_GetRelativeMouseState(). | |
| 69 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
70 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y); |
| 0 | 71 |
| 72 /* | |
| 73 * Set the position of the mouse cursor (generates a mouse motion event) | |
| 74 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
75 extern DECLSPEC void SDLCALL SDL_WarpMouse(Uint16 x, Uint16 y); |
| 0 | 76 |
| 77 /* | |
| 78 * Create a cursor using the specified data and mask (in MSB format). | |
| 79 * The cursor width must be a multiple of 8 bits. | |
| 80 * | |
| 81 * The cursor is created in black and white according to the following: | |
| 82 * data mask resulting pixel on screen | |
| 83 * 0 1 White | |
| 84 * 1 1 Black | |
| 85 * 0 0 Transparent | |
| 86 * 1 0 Inverted color if possible, black if not. | |
| 87 * | |
| 88 * Cursors created with this function must be freed with SDL_FreeCursor(). | |
| 89 */ | |
|
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
|
90 extern DECLSPEC SDL_Cursor *SDLCALL SDL_CreateCursor |
|
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
|
91 (Uint8 * data, Uint8 * mask, int w, int h, int hot_x, int hot_y); |
| 0 | 92 |
| 93 /* | |
| 94 * Set the currently active cursor to the specified one. | |
| 95 * If the cursor is currently visible, the change will be immediately | |
| 96 * represented on the display. | |
| 97 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
98 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor); |
| 0 | 99 |
| 100 /* | |
| 101 * Returns the currently active cursor. | |
| 102 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
103 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void); |
| 0 | 104 |
| 105 /* | |
| 106 * Deallocates a cursor created with SDL_CreateCursor(). | |
| 107 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
108 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor); |
| 0 | 109 |
| 110 /* | |
| 111 * Toggle whether or not the cursor is shown on the screen. | |
| 112 * The cursor start off displayed, but can be turned off. | |
| 113 * SDL_ShowCursor() returns 1 if the cursor was being displayed | |
| 114 * before the call, or 0 if it was not. You can query the current | |
| 115 * state by passing a 'toggle' value of -1. | |
| 116 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
117 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle); |
| 0 | 118 |
| 119 /* Used as a mask when testing buttons in buttonstate | |
| 120 Button 1: Left mouse button | |
| 121 Button 2: Middle mouse button | |
| 122 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
|
123 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
|
124 Button 5: Mouse wheel down (may also be a real button) |
| 0 | 125 */ |
|
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
|
126 #define SDL_BUTTON(X) (1 << ((X)-1)) |
| 0 | 127 #define SDL_BUTTON_LEFT 1 |
| 128 #define SDL_BUTTON_MIDDLE 2 | |
| 129 #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
|
130 #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
|
131 #define SDL_BUTTON_WHEELDOWN 5 |
| 0 | 132 #define SDL_BUTTON_LMASK SDL_BUTTON(SDL_BUTTON_LEFT) |
| 133 #define SDL_BUTTON_MMASK SDL_BUTTON(SDL_BUTTON_MIDDLE) | |
| 134 #define SDL_BUTTON_RMASK SDL_BUTTON(SDL_BUTTON_RIGHT) | |
| 135 | |
| 136 | |
| 137 /* Ends C function definitions when using C++ */ | |
| 138 #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
|
139 /* *INDENT-OFF* */ |
| 0 | 140 } |
|
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
|
141 /* *INDENT-ON* */ |
| 0 | 142 #endif |
| 143 #include "close_code.h" | |
| 144 | |
| 145 #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
|
146 |
|
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
|
147 /* vi: set ts=4 sw=4 expandtab: */ |