|
Size: 1307
Comment: update content (old wiki)
|
Size: 1356
Comment: minor change
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| Returns an 8 bit button bitmask of the relative button state. ??? | Returns an 8 bit button bitmask of the relative button state. ??? <<Color2(green,Does this have an error state?)>> |
DRAFT |
SDL_GetRelativeMouseState
Use this function to retrieve the relative state of the mouse.
Contents
Syntax
Uint8 SDL_GetRelativeMouseState(int* x,
int* y)
Function Parameters
x |
a pointer filled with the last recorded x coordinate of the mouse |
y |
a pointer filled with the last recorded y coordinate of the mouse |
Return Value
Returns an 8 bit button bitmask of the relative button state. ??? green
Code Examples
You can add your code example here
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)(green
)*, and x and y are set to the mouse deltas since the last call to SDL_GetRelativeMouseState() *or since event initialization. You can pass NULL for either x or y.*
