home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_JoyButtonEvent.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.1 KB  |  73 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_JoyButtonEvent"("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_JoyButtonEvent- Joystick button 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 which;
  19.   Uint8 button;
  20.   Uint8 state;
  21. } SDL_JoyButtonEvent;
  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_JOYBUTTONDOWN</b> or <b>SDL_JOYBUTTONUP</b> </dd>
  30.  
  31. <dt><b>which</b> </dt>
  32. <dd>Joystick
  33. device index </dd>
  34.  
  35. <dt><b>button</b> </dt>
  36. <dd>Joystick button index </dd>
  37.  
  38. <dt><b>state</b> </dt>
  39. <dd><b>SDL_PRESSED</b> or <b>SDL_RELEASED</b>
  40. </dd>
  41. </dl>
  42.  
  43. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  44. <p>
  45. <b>SDL_JoyButtonEvent</b> is a member of the <i><b>SDL_Event</b></i> union and is
  46. used when an event of type <b>SDL_JOYBUTTONDOWN</b> or <b>SDL_JOYBUTTONUP</b> is reported.
  47. <p>
  48. A <b>SDL_JOYBUTTONDOWN</b> or <b>SDL_JOYBUTTONUP</b> event occurs when ever a user presses
  49. or releases a button on a joystick. The field <b>which</b> is the index of the
  50. joystick that reported the event and <b>button</b> is the index of the button
  51. (for a more detailed explaination see the <i>Joystick section</i>). <b>state</b> is the
  52. current state or the button which is either <b>SDL_PRESSED</b> or <b>SDL_RELEASED</b>.
  53.  
  54. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  55. <p>
  56. <i><b>SDL_Event</b></i>, <i>Joystick Functions</i>, <i><b>SDL_JoystickEventState</b></i>, <i><b>SDL_JoystickGetButton</b></i>
  57.  
  58. <!--
  59.   
  60.  <p>
  61.  
  62. <hr><p>
  63. <a name='toc'><b>Table of Contents</b></a><p>
  64. <ul>
  65. <li><a name='toc0' href='#sect0'>Name</a></li>
  66. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  67. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  68. <li><a name='toc3' href='#sect3'>Description</a></li>
  69. <li><a name='toc4' href='#sect4'>See Also</a></li>
  70. </ul>
  71. </body>
  72. </html>
  73.