home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_JoyHatEvent.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.5 KB  |  109 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_JoyHatEvent"("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_JoyHatEvent- Joystick hat position change event structure 
  13. <h2><a name='sect1' href='#toc1'>Structure
  14. Definition</a></h2>
  15. <p>
  16. <br>
  17. <pre>CWtypedef struct{
  18.   Uint8 type;
  19.   Uint8 which;
  20.   Uint8 hat;
  21.   Uint8 value;
  22. } SDL_JoyHatEvent;
  23. </pre><p>
  24.  
  25. <h2><a name='sect2' href='#toc2'>Structure Data</a></h2>
  26.  
  27. <dl>
  28.  
  29. <dt><b>type</b> </dt>
  30. <dd><b>SDL_JOY</b> </dd>
  31.  
  32. <dt><b>which</b> </dt>
  33. <dd>Joystick device index </dd>
  34.  
  35. <dt><b>hat</b> </dt>
  36. <dd>Joystick hat
  37. index </dd>
  38.  
  39. <dt><b>value</b> </dt>
  40. <dd>Hat position </dd>
  41. </dl>
  42.  
  43. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  44. <p>
  45. <b>SDL_JoyHatEvent</b> is a member of the
  46. <i><b>SDL_Event</b></i> union and is used when an event of type <b>SDL_JOYHATMOTION</b> is reported.
  47. <p>
  48. A <b>SDL_JOYHATMOTION</b> event occurs when ever a user moves a hat on the joystick.
  49. The field <b>which</b> is the index of the joystick that reported the event and
  50. <b>hat</b> is the index of the hat (for a more detailed exlaination see the <i>Joystick
  51. section</i>). <b>value</b> is the current position of the hat. It is a logically OR'd
  52. combination of the following values (whose meanings should be pretty obvious:)
  53. : 
  54. <dl>
  55.  
  56. <dt><b>SDL_HAT_CENTERED</b> </dt>
  57. <dd></dd>
  58.  
  59. <dt><b>SDL_HAT_UP</b> </dt>
  60. <dd></dd>
  61.  
  62. <dt><b>SDL_HAT_RIGHT</b> </dt>
  63. <dd></dd>
  64.  
  65. <dt><b>SDL_HAT_DOWN</b> </dt>
  66. <dd></dd>
  67.  
  68. <dt><b>SDL_HAT_LEFT</b> </dt>
  69. <dd></dd>
  70. </dl>
  71. <p>
  72. The
  73. following defines are also provided: 
  74. <dl>
  75.  
  76. <dt><b>SDL_HAT_RIGHTUP</b> </dt>
  77. <dd></dd>
  78.  
  79. <dt><b>SDL_HAT_RIGHTDOWN</b>
  80. </dt>
  81. <dd></dd>
  82.  
  83. <dt><b>SDL_HAT_LEFTUP</b> </dt>
  84. <dd></dd>
  85.  
  86. <dt><b>SDL_HAT_LEFTDOWN</b> </dt>
  87. <dd></dd>
  88. </dl>
  89.  
  90. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  91. <p>
  92. <i><b>SDL_Event</b></i>, <i>Joystick Functions</i>,
  93. <i><b>SDL_JoystickEventState</b></i>, <i><b>SDL_JoystickGetHat</b></i> 
  94. <!--
  95.   
  96.  <p>
  97.  
  98. <hr><p>
  99. <a name='toc'><b>Table of Contents</b></a><p>
  100. <ul>
  101. <li><a name='toc0' href='#sect0'>Name</a></li>
  102. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  103. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  104. <li><a name='toc3' href='#sect3'>Description</a></li>
  105. <li><a name='toc4' href='#sect4'>See Also</a></li>
  106. </ul>
  107. </body>
  108. </html>
  109.