|
Size: 1436
Comment: update content - pointers, structs
|
Size: 1471
Comment: Updated usage of Color2 macro.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 12: | Line 12: |
| Uint8 SDL_GetRelativeMouseState(int* x, int* y) |
Uint32 SDL_GetRelativeMouseState(int* x, int* y) |
| Line 20: | Line 20: |
| <<Color2(green,Should this be an exception to the 'pointer rule'?)>> | <<Color2(col=green,text="Should this be an exception to the 'pointer rule'?")>> |
| Line 23: | Line 23: |
| Returns an 8 bit button bitmask of the relative button state. ??? <<Color2(green,Does this have an error state?)>> | Returns a 32 bit button bitmask of the relative button state. ??? <<Color2(col=green,text="Does this have an error state?")>> |
| Line 31: | Line 31: |
| 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)(<<Color2(green,parens is from SDL_GetMouseState because remark is otherwise the same)>>)*, 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'''.* | 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)(<<Color2(col=green,text="parens is from SDL_GetMouseState because remark is otherwise the same")>>)*, 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'''.* |
DRAFT |
SDL_GetRelativeMouseState
Use this function to retrieve the relative state of the mouse.
Contents
Syntax
Uint32 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 |
Should this be an exception to the 'pointer rule'?
Return Value
Returns a 32 bit button bitmask of the relative button state. ??? Does this have an error state?
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)(parens is from SDL_GetMouseState because remark is otherwise the same
)*, 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.*
