|
Size: 1194
Comment: create page, add content (Rev 5540)
|
Size: 1436
Comment: update content - pointers, structs
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to retrieve the state of the specified mouse. | Use this function to retrieve the relative state of the mouse. |
| Line 12: | Line 12: |
| Uint8 SDL_GetRelativeMouseState(int index, int* x, |
Uint8 SDL_GetRelativeMouseState(int* x, |
| Line 18: | Line 17: |
| ||'''index'''||the index of the specified mouse|| ||'''x'''||a pointer filled with the relative x coordinate of the mouse|| ||'''y'''||a pointer filled with the relative y coordinate of the mouse|| |
||'''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^|| <<Color2(green,Should this be an exception to the 'pointer rule'?)>> |
| Line 23: | Line 23: |
| 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?)>> |
| Line 31: | 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 deltas since the last call to [[SDL_GetRelativeMouseState]](). | 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'''.* |
| Line 34: | Line 34: |
| .[[SDL_GetMouseState]] ??? Because it's essentially the same a different way | .[[SDL_GetMouseState]] * |
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 |
green
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.*
