#pragma section-numbers off
#pragma disable-camelcase
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||

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

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
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||

/* <<Color2(col=green,text="Should this be an exception to the 'pointer rule'?")>> */

== Return Value ==
Returns a 32-bit button bitmask of the relative button state.

== Code Examples ==
{{{#!highlight cpp
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), 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'''.

== Related Functions ==
 .[[SDL_GetMouseState]]

----
[[CategoryAPI]], [[CategoryMouse]]