|
Size: 1284
Comment: update content - changeset 4465
|
Size: 1462
Comment: update content (old wiki)
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| Returns an 8 bit button bitmask of the current button state. ??? | Returns an 8 bit button bitmask of the current button state. |
| Line 25: | Line 25: |
| You can add your code example here | SDL_PumpEvents(); if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1)) printf("Mouse Button 1(left) is pressed.\n"); |
| Line 29: | Line 31: |
| The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and '''x''' and '''y''' are set to the mouse cursor position relative to the focus window for the current,,ly selected,, mouse. You can pass NULL for either '''x''' or '''y'''. | The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros *(where X is generally 1 for the left, 2 for middle, 3 for the right button)*, and '''x''' and '''y''' are set to the mouse cursor position relative to the focus window for the current,,ly selected,, mouse. You can pass NULL for either '''x''' or '''y'''. |
| Line 31: | Line 33: |
| <<Color2(green,Should the first sentence be split into two? Should the subscripted portion be removed to reflect the lack of multi-mouse support?)>> | <<Color2(green,Suggest splitting the first sentence into two. Should the subscripted portion be removed to reflect the lack of multi-mouse support?)>> |
| Line 34: | Line 36: |
| .[[SDL_GetRelativeMouseState]] ??? | .[[SDL_GetRelativeMouseState]] * .[[SDL_PumpEvents]] * |
DRAFT |
SDL_GetMouseState
Use this function to retrieve the current state of the mouse.
Contents
Syntax
Uint8 SDL_GetMouseState(int* x,
int* y)
Function Parameters
x |
the x coordinate of the mouse cursor position relative to the focus window |
y |
the y coordinate of the mouse cursor position relative to the focus window |
Return Value
Returns an 8 bit button bitmask of the current button state.
Code Examples
SDL_PumpEvents();
if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1))
printf("Mouse Button 1(left) is pressed.\n");
Remarks
The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros *(where X is generally 1 for the left, 2 for middle, 3 for the right button)*, and x and y are set to the mouse cursor position relative to the focus window for the currently selected mouse. You can pass NULL for either x or y.
green
