Mercurial > sdl-ios-xcode

comparison include/SDL_mouse.h @ 1668:4da1ee79c9af SDL-1.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more tweaking indent options
author Sam Lantinga <slouken@libsdl.org>
date Mon, 29 May 2006 04:04:35 +0000
parents 782fd950bd46
children eef792d31de8
comparison
equal deleted inserted replaced
1667:1fddae038bc8 1668:4da1ee79c9af
57 * Retrieve the current state of the mouse. 57 * Retrieve the current state of the mouse.
58 * The current button state is returned as a button bitmask, which can 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 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. 60 * current mouse cursor position. You can pass NULL for either x or y.
61 */ 61 */
62 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState (int *x, int *y); 62 extern DECLSPEC Uint8 SDLCALL SDL_GetMouseState(int *x, int *y);
63 63
64 /* 64 /*
65 * Retrieve the current state of the mouse. 65 * Retrieve the current state of the mouse.
66 * The current button state is returned as a button bitmask, which can 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 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(). 68 * mouse deltas since the last call to SDL_GetRelativeMouseState().
69 */ 69 */
70 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState (int *x, int *y); 70 extern DECLSPEC Uint8 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
71 71
72 /* 72 /*
73 * Set the position of the mouse cursor (generates a mouse motion event) 73 * Set the position of the mouse cursor (generates a mouse motion event)
74 */ 74 */
75 extern DECLSPEC void SDLCALL SDL_WarpMouse (Uint16 x, Uint16 y); 75 extern DECLSPEC void SDLCALL SDL_WarpMouse(Uint16 x, Uint16 y);
76 76
77 /* 77 /*
78 * Create a cursor using the specified data and mask (in MSB format). 78 * Create a cursor using the specified data and mask (in MSB format).
79 * The cursor width must be a multiple of 8 bits. 79 * The cursor width must be a multiple of 8 bits.
80 * 80 *
93 /* 93 /*
94 * Set the currently active cursor to the specified one. 94 * Set the currently active cursor to the specified one.
95 * If the cursor is currently visible, the change will be immediately 95 * If the cursor is currently visible, the change will be immediately
96 * represented on the display. 96 * represented on the display.
97 */ 97 */
98 extern DECLSPEC void SDLCALL SDL_SetCursor (SDL_Cursor * cursor); 98 extern DECLSPEC void SDLCALL SDL_SetCursor(SDL_Cursor * cursor);
99 99
100 /* 100 /*
101 * Returns the currently active cursor. 101 * Returns the currently active cursor.
102 */ 102 */
103 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor (void); 103 extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
104 104
105 /* 105 /*
106 * Deallocates a cursor created with SDL_CreateCursor(). 106 * Deallocates a cursor created with SDL_CreateCursor().
107 */ 107 */
108 extern DECLSPEC void SDLCALL SDL_FreeCursor (SDL_Cursor * cursor); 108 extern DECLSPEC void SDLCALL SDL_FreeCursor(SDL_Cursor * cursor);
109 109
110 /* 110 /*
111 * Toggle whether or not the cursor is shown on the screen. 111 * Toggle whether or not the cursor is shown on the screen.
112 * The cursor start off displayed, but can be turned off. 112 * The cursor start off displayed, but can be turned off.
113 * SDL_ShowCursor() returns 1 if the cursor was being displayed 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 114 * before the call, or 0 if it was not. You can query the current
115 * state by passing a 'toggle' value of -1. 115 * state by passing a 'toggle' value of -1.
116 */ 116 */
117 extern DECLSPEC int SDLCALL SDL_ShowCursor (int toggle); 117 extern DECLSPEC int SDLCALL SDL_ShowCursor(int toggle);
118 118
119 /* Used as a mask when testing buttons in buttonstate 119 /* Used as a mask when testing buttons in buttonstate
120 Button 1: Left mouse button 120 Button 1: Left mouse button
121 Button 2: Middle mouse button 121 Button 2: Middle mouse button
122 Button 3: Right mouse button 122 Button 3: Right mouse button