Mercurial > sdl-ios-xcode

diff docs/html/sdlmousemotionevent.html @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/html/sdlmousemotionevent.html	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,357 @@
+<HTML
+><HEAD
+><TITLE
+>SDL_MouseMotionEvent</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+"><LINK
+REL="HOME"
+TITLE="SDL Library Documentation"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="SDL Event Structures."
+HREF="eventstructures.html"><LINK
+REL="PREVIOUS"
+TITLE="SDL_KeyboardEvent"
+HREF="sdlkeyboardevent.html"><LINK
+REL="NEXT"
+TITLE="SDL_MouseButtonEvent"
+HREF="sdlmousebuttonevent.html"></HEAD
+><BODY
+CLASS="REFENTRY"
+BGCOLOR="#FFF8DC"
+TEXT="#000000"
+LINK="#0000ee"
+VLINK="#551a8b"
+ALINK="#ff0000"
+><DIV
+CLASS="NAVHEADER"
+><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="sdlkeyboardevent.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="sdlmousebuttonevent.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><H1
+><A
+NAME="SDLMOUSEMOTIONEVENT"
+>SDL_MouseMotionEvent</A
+></H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN3571"
+></A
+><H2
+>Name</H2
+>SDL_MouseMotionEvent&nbsp;--&nbsp;Mouse motion event structure</DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN3574"
+></A
+><H2
+>Structure Definition</H2
+><PRE
+CLASS="PROGRAMLISTING"
+>typedef struct{
+  Uint8 type;
+  Uint8 state;
+  Uint16 x, y;
+  Sint16 xrel, yrel;
+} SDL_MouseMotionEvent;</PRE
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN3577"
+></A
+><H2
+>Structure Data</H2
+><DIV
+CLASS="INFORMALTABLE"
+><A
+NAME="AEN3579"
+></A
+><P
+></P
+><TABLE
+BORDER="0"
+CLASS="CALSTABLE"
+><TBODY
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="STRUCTFIELD"
+><I
+>type</I
+></TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="LITERAL"
+>SDL_MOUSEMOTION</TT
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="STRUCTFIELD"
+><I
+>state</I
+></TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>The current button state</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="STRUCTFIELD"
+><I
+>x</I
+></TT
+>, <TT
+CLASS="STRUCTFIELD"
+><I
+>y</I
+></TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>The X/Y coordinates of the mouse</TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+><TT
+CLASS="STRUCTFIELD"
+><I
+>xrel</I
+></TT
+>, <TT
+CLASS="STRUCTFIELD"
+><I
+>yrel</I
+></TT
+></TD
+><TD
+ALIGN="LEFT"
+VALIGN="TOP"
+>Relative motion in the X/Y direction</TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN3601"
+></A
+><H2
+>Description</H2
+><P
+><SPAN
+CLASS="STRUCTNAME"
+>SDL_MouseMotionEvent</SPAN
+> is a member of the <A
+HREF="sdlevent.html"
+><SPAN
+CLASS="STRUCTNAME"
+>SDL_Event</SPAN
+></A
+> union and is used when an event of type <TT
+CLASS="LITERAL"
+>SDL_MOUSEMOTION</TT
+> is reported.</P
+><P
+>Simply put, a <TT
+CLASS="LITERAL"
+>SDL_MOUSEMOTION</TT
+> type event occurs when a user moves the mouse within the application window or when <A
+HREF="sdlwarpmouse.html"
+><TT
+CLASS="FUNCTION"
+>SDL_WarpMouse</TT
+></A
+> is called. Both the absolute (<TT
+CLASS="STRUCTFIELD"
+><I
+>x</I
+></TT
+> and <TT
+CLASS="STRUCTFIELD"
+><I
+>y</I
+></TT
+>) and relative (<TT
+CLASS="STRUCTFIELD"
+><I
+>xrel</I
+></TT
+> and <TT
+CLASS="STRUCTFIELD"
+><I
+>yrel</I
+></TT
+>) coordinates are reported along with the current button states (<TT
+CLASS="STRUCTFIELD"
+><I
+>state</I
+></TT
+>). The button state can be interpreted using the <TT
+CLASS="LITERAL"
+>SDL_BUTTON</TT
+> macro (see <A
+HREF="sdlgetmousestate.html"
+><TT
+CLASS="FUNCTION"
+>SDL_GetMouseState</TT
+></A
+>).</P
+><P
+>If the cursor is hidden (<A
+HREF="sdlshowcursor.html"
+><TT
+CLASS="FUNCTION"
+>SDL_ShowCursor</TT
+>(0)</A
+>) and the input is grabbed (<A
+HREF="sdlwmgrabinput.html"
+><TT
+CLASS="FUNCTION"
+>SDL_WM_GrabInput</TT
+>(SDL_GRAB_ON)</A
+>), then the mouse will give relative motion events even when the cursor reaches the edge fo the screen. This is currently only implemented on Windows and Linux/Unix-a-likes.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN3625"
+></A
+><H2
+>See Also</H2
+><P
+><A
+HREF="sdlevent.html"
+><SPAN
+CLASS="STRUCTNAME"
+>SDL_Event</SPAN
+></A
+>,
+<A
+HREF="sdlmousebuttonevent.html"
+><SPAN
+CLASS="STRUCTNAME"
+>SDL_MouseButtonEvent</SPAN
+></A
+></P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="sdlkeyboardevent.html"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="sdlmousebuttonevent.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>SDL_KeyboardEvent</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="eventstructures.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>SDL_MouseButtonEvent</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file