Mercurial > sdl-ios-xcode
view docs/html/sdlgetrelativemousestate.html @ 3796:b19680c84cdf SDL-ryan-multiple-audio-device
Bunch of 1.3 audio cleanups to remove FIXMEs, get driver specific crap out of
the core and into the drivers where it belongs, and push generic
responsibilities out of the drivers and into the core where they belong.
author | Ryan C. Gordon <icculus@icculus.org> |
---|---|
date | Wed, 04 Oct 2006 19:54:23 +0000 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_GetRelativeMouseState</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Event Functions." HREF="eventfunctions.html"><LINK REL="PREVIOUS" TITLE="SDL_GetMouseState" HREF="sdlgetmousestate.html"><LINK REL="NEXT" TITLE="SDL_GetAppState" HREF="sdlgetappstate.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdlgetmousestate.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlgetappstate.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLGETRELATIVEMOUSESTATE" ></A >SDL_GetRelativeMouseState</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN5902" ></A ><H2 >Name</H2 >SDL_GetRelativeMouseState -- Retrieve the current state of the mouse</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN5905" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN5906" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >Uint8 <B CLASS="FSFUNC" >SDL_GetRelativeMouseState</B ></CODE >(int *x, int *y);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5912" ></A ><H2 >Description</H2 ><P >The current button state is returned as a button bitmask, which can be tested using the <TT CLASS="LITERAL" >SDL_BUTTON(X)</TT > macros, and <TT CLASS="PARAMETER" ><I >x</I ></TT > and <TT CLASS="PARAMETER" ><I >y</I ></TT > are set to the change in the mouse position since the last call to <TT CLASS="FUNCTION" >SDL_GetRelativeMouseState</TT > or since event initialization. You can pass <TT CLASS="LITERAL" >NULL</TT > for either <TT CLASS="PARAMETER" ><I >x</I ></TT > or <TT CLASS="PARAMETER" ><I >y</I ></TT >.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN5922" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlgetmousestate.html" ><TT CLASS="FUNCTION" >SDL_GetMouseState</TT ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlgetmousestate.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlgetappstate.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_GetMouseState</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="eventfunctions.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_GetAppState</TD ></TR ></TABLE ></DIV ></BODY ></HTML >