|
Size: 1492
Comment: Removed *.
|
Size: 1484
Comment: Removed old formatting.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 17: | Line 17: |
| ||'''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^|| |
||'''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|| |
| Line 32: | Line 32: |
| 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'''. | 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'''. |
DRAFT |
SDL_GetMouseState
Use this function to retrieve the current state of the mouse.
Contents
Syntax
Uint32 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 a 32 bit button bitmask of the current button state.
Code Examples
SDL_PumpEvents();
if (SDL_GetMouseState(NULL, NULL) & SDL_BUTTON(SDL_BUTTON_LEFT)) {
SDL_Log("Mouse Button 1 (left) is pressed.");
}
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.
Suggest splitting the first sentence into two. Should the subscripted portion be removed to reflect the lack of multi-mouse support?
