DRAFT

SDL_GetRelativeMouseState

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

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

Should this be an exception to the 'pointer rule'?

Return Value

Returns an 8 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.*


CategoryAPI, CategoryMouse

SDL_GetRelativeMouseState (last edited 2010-10-11 21:27:24 by SheenaSmith)

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