Wiki Page Content

Differences between revisions 11 and 12
Revision 11 as of 2015-03-26 21:03:54
Size: 1400
Comment: Removed green question, there is no error state.
Revision 12 as of 2015-03-26 21:05:13
Size: 1388
Comment: Removed formatting (Feedback from 2015-03-25).
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
||'''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^||
||'''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||

DRAFT

SDL_GetRelativeMouseState

Use this function to retrieve the relative state of the mouse.

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.

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.


CategoryAPI, CategoryMouse

None: SDL_GetRelativeMouseState (last edited 2016-11-28 21:42:23 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit