1<HTML 2><HEAD 3><TITLE 4>SDL_GetRelativeMouseState</TITLE 5><META 6NAME="GENERATOR" 7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ 8"><LINK 9REL="HOME" 10TITLE="SDL Library Documentation" 11HREF="index.html"><LINK 12REL="UP" 13TITLE="Event Functions." 14HREF="eventfunctions.html"><LINK 15REL="PREVIOUS" 16TITLE="SDL_GetMouseState" 17HREF="sdlgetmousestate.html"><LINK 18REL="NEXT" 19TITLE="SDL_GetAppState" 20HREF="sdlgetappstate.html"></HEAD 21><BODY 22CLASS="REFENTRY" 23BGCOLOR="#FFF8DC" 24TEXT="#000000" 25LINK="#0000ee" 26VLINK="#551a8b" 27ALINK="#ff0000" 28><DIV 29CLASS="NAVHEADER" 30><TABLE 31SUMMARY="Header navigation table" 32WIDTH="100%" 33BORDER="0" 34CELLPADDING="0" 35CELLSPACING="0" 36><TR 37><TH 38COLSPAN="3" 39ALIGN="center" 40>SDL Library Documentation</TH 41></TR 42><TR 43><TD 44WIDTH="10%" 45ALIGN="left" 46VALIGN="bottom" 47><A 48HREF="sdlgetmousestate.html" 49ACCESSKEY="P" 50>Prev</A 51></TD 52><TD 53WIDTH="80%" 54ALIGN="center" 55VALIGN="bottom" 56></TD 57><TD 58WIDTH="10%" 59ALIGN="right" 60VALIGN="bottom" 61><A 62HREF="sdlgetappstate.html" 63ACCESSKEY="N" 64>Next</A 65></TD 66></TR 67></TABLE 68><HR 69ALIGN="LEFT" 70WIDTH="100%"></DIV 71><H1 72><A 73NAME="SDLGETRELATIVEMOUSESTATE" 74></A 75>SDL_GetRelativeMouseState</H1 76><DIV 77CLASS="REFNAMEDIV" 78><A 79NAME="AEN5902" 80></A 81><H2 82>Name</H2 83>SDL_GetRelativeMouseState -- Retrieve the current state of the mouse</DIV 84><DIV 85CLASS="REFSYNOPSISDIV" 86><A 87NAME="AEN5905" 88></A 89><H2 90>Synopsis</H2 91><DIV 92CLASS="FUNCSYNOPSIS" 93><A 94NAME="AEN5906" 95></A 96><P 97></P 98><PRE 99CLASS="FUNCSYNOPSISINFO" 100>#include "SDL.h"</PRE 101><P 102><CODE 103><CODE 104CLASS="FUNCDEF" 105>Uint8 <B 106CLASS="FSFUNC" 107>SDL_GetRelativeMouseState</B 108></CODE 109>(int *x, int *y);</CODE 110></P 111><P 112></P 113></DIV 114></DIV 115><DIV 116CLASS="REFSECT1" 117><A 118NAME="AEN5912" 119></A 120><H2 121>Description</H2 122><P 123>The current button state is returned as a button bitmask, which can 124be tested using the <TT 125CLASS="LITERAL" 126>SDL_BUTTON(X)</TT 127> macros, and <TT 128CLASS="PARAMETER" 129><I 130>x</I 131></TT 132> and <TT 133CLASS="PARAMETER" 134><I 135>y</I 136></TT 137> are set to the change in the mouse position since the last call to <TT 138CLASS="FUNCTION" 139>SDL_GetRelativeMouseState</TT 140> or since event initialization. You can pass <TT 141CLASS="LITERAL" 142>NULL</TT 143> for either <TT 144CLASS="PARAMETER" 145><I 146>x</I 147></TT 148> or <TT 149CLASS="PARAMETER" 150><I 151>y</I 152></TT 153>.</P 154></DIV 155><DIV 156CLASS="REFSECT1" 157><A 158NAME="AEN5922" 159></A 160><H2 161>See Also</H2 162><P 163><A 164HREF="sdlgetmousestate.html" 165><TT 166CLASS="FUNCTION" 167>SDL_GetMouseState</TT 168></A 169></P 170></DIV 171><DIV 172CLASS="NAVFOOTER" 173><HR 174ALIGN="LEFT" 175WIDTH="100%"><TABLE 176SUMMARY="Footer navigation table" 177WIDTH="100%" 178BORDER="0" 179CELLPADDING="0" 180CELLSPACING="0" 181><TR 182><TD 183WIDTH="33%" 184ALIGN="left" 185VALIGN="top" 186><A 187HREF="sdlgetmousestate.html" 188ACCESSKEY="P" 189>Prev</A 190></TD 191><TD 192WIDTH="34%" 193ALIGN="center" 194VALIGN="top" 195><A 196HREF="index.html" 197ACCESSKEY="H" 198>Home</A 199></TD 200><TD 201WIDTH="33%" 202ALIGN="right" 203VALIGN="top" 204><A 205HREF="sdlgetappstate.html" 206ACCESSKEY="N" 207>Next</A 208></TD 209></TR 210><TR 211><TD 212WIDTH="33%" 213ALIGN="left" 214VALIGN="top" 215>SDL_GetMouseState</TD 216><TD 217WIDTH="34%" 218ALIGN="center" 219VALIGN="top" 220><A 221HREF="eventfunctions.html" 222ACCESSKEY="U" 223>Up</A 224></TD 225><TD 226WIDTH="33%" 227ALIGN="right" 228VALIGN="top" 229>SDL_GetAppState</TD 230></TR 231></TABLE 232></DIV 233></BODY 234></HTML 235>