home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_MouseMotionEvent.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.3 KB  |  76 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_MouseMotionEvent"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_MouseMotionEvent- Mouse motion event structure 
  13. <h2><a name='sect1' href='#toc1'>Structure Definition</a></h2>
  14. <p>
  15. <br>
  16. <pre>CWtypedef struct{
  17.   Uint8 type;
  18.   Uint8 state;
  19.   Uint16 x, y;
  20.   Sint16 xrel, yrel;
  21. } SDL_MouseMotionEvent;
  22. </pre><p>
  23.  
  24. <h2><a name='sect2' href='#toc2'>Structure Data</a></h2>
  25.  
  26. <dl>
  27.  
  28. <dt><b>type</b> </dt>
  29. <dd><b>SDL_MOUSEMOTION</b> </dd>
  30.  
  31. <dt><b>state</b> </dt>
  32. <dd>The current button state </dd>
  33.  
  34. <dt><b>x</b>, <b>y</b>
  35. </dt>
  36. <dd>The X/Y coordinates of the mouse </dd>
  37.  
  38. <dt><b>xrel</b>, <b>yrel</b> </dt>
  39. <dd>Relative motion in the X/Y
  40. direction </dd>
  41. </dl>
  42.  
  43. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  44. <p>
  45. <b>SDL_MouseMotionEvent</b> is a member of the <i><b>SDL_Event</b></i>
  46. union and is used when an event of type <b>SDL_MOUSEMOTION</b> is reported. <p>
  47. Simply
  48. put, a <b>SDL_MOUSEMOTION</b> type event occurs when a user moves the mouse within
  49. the application window or when <i><b>SDL_WarpMouse</b></i> is called. Both the absolute
  50. (<b>x</b> and <b>y</b>) and relative (<b>xrel</b> and <b>yrel</b>) coordinates are reported along with
  51. the current button states (<b>state</b>). The button state can be interpreted using
  52. the <b>SDL_BUTTON</b> macro (see <i><b>SDL_GetMouseState</b></i>). <p>
  53. If the cursor is hidden (<i><b>SDL_ShowCursor</b></i>(0))
  54. and the input is grabbed (<i><b>SDL_WM_GrabInput</b></i>(SDL_GRAB_ON)), then the mouse
  55. will give relative motion events even when the cursor reaches the edge
  56. fo the screen. This is currently only implemented on Windows and Linux/Unix-a-likes.
  57.  
  58. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  59. <p>
  60. <i><b>SDL_Event</b></i>, <i><b>SDL_MouseButtonEvent</b></i> 
  61. <!--
  62.   
  63.  <p>
  64.  
  65. <hr><p>
  66. <a name='toc'><b>Table of Contents</b></a><p>
  67. <ul>
  68. <li><a name='toc0' href='#sect0'>Name</a></li>
  69. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  70. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  71. <li><a name='toc3' href='#sect3'>Description</a></li>
  72. <li><a name='toc4' href='#sect4'>See Also</a></li>
  73. </ul>
  74. </body>
  75. </html>
  76.