home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_JoystickGetAxis.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.0 KB  |  64 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_JoystickGetAxis"("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_JoystickGetAxis- Get the current state of an axis 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include
  16. "SDL.h" <p>
  17. </b><b>Sint16 <b>SDL_JoystickGetAxis</b></b>(<b>SDL_Joystick *joystick, int axis</b>); 
  18. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  19. <p>
  20. <b>SDL_JoystickGetAxis</b>
  21. returns the current state of the given <b>axis</b> on the given <b>joystick</b>. <p>
  22. On most
  23. modern joysticks the X axis is usually represented by <b>axis</b> 0 and the Y
  24. axis by <b>axis</b> 1. The value returned by <b>SDL_JoystickGetAxis</b> is a signed integer
  25. (-32768 to 32768) representing the current position of the <b>axis</b>, it maybe
  26. necessary to impose certain tolerances on these values to account for jitter.
  27. It is worth noting that some joysticks use axes 2 and 3 for extra buttons.
  28.  
  29. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  30. <p>
  31. Returns a 16-bit signed integer representing the current position
  32. of the <b>axis</b>. 
  33. <h2><a name='sect4' href='#toc4'>Examples</a></h2>
  34. <p>
  35. <p>
  36. <br>
  37. <pre>CWSint16 x_move, y_move;
  38. SDL_Joystick *joy1;
  39. .
  40. .
  41. x_move=SDL_JoystickGetAxis(joy1, 0);
  42. y_move=SDL_JoystickGetAxis(joy1, 1);
  43. </pre><p>
  44.  
  45. <h2><a name='sect5' href='#toc5'>See Also</a></h2>
  46. <p>
  47. <i><b>SDL_JoystickNumAxes</b></i> 
  48. <!--
  49.   
  50.  <p>
  51.  
  52. <hr><p>
  53. <a name='toc'><b>Table of Contents</b></a><p>
  54. <ul>
  55. <li><a name='toc0' href='#sect0'>Name</a></li>
  56. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  57. <li><a name='toc2' href='#sect2'>Description</a></li>
  58. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  59. <li><a name='toc4' href='#sect4'>Examples</a></li>
  60. <li><a name='toc5' href='#sect5'>See Also</a></li>
  61. </ul>
  62. </body>
  63. </html>
  64.