Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Last modification | View Log | RSS feed

  1. <HTML
  2. ><HEAD
  3. ><TITLE
  4. >SDL_JoystickGetAxis</TITLE
  5. ><META
  6. NAME="GENERATOR"
  7. CONTENT="Modular DocBook HTML Stylesheet Version 1.64
  8. "><LINK
  9. REL="HOME"
  10. TITLE="SDL Library Documentation"
  11. HREF="index.html"><LINK
  12. REL="UP"
  13. TITLE="Joystick"
  14. HREF="joystick.html"><LINK
  15. REL="PREVIOUS"
  16. TITLE="SDL_JoystickUpdate"
  17. HREF="sdljoystickupdate.html"><LINK
  18. REL="NEXT"
  19. TITLE="SDL_JoystickGetHat"
  20. HREF="sdljoystickgethat.html"></HEAD
  21. ><BODY
  22. CLASS="REFENTRY"
  23. BGCOLOR="#FFF8DC"
  24. TEXT="#000000"
  25. LINK="#0000ee"
  26. VLINK="#551a8b"
  27. ALINK="#ff0000"
  28. ><DIV
  29. CLASS="NAVHEADER"
  30. ><TABLE
  31. WIDTH="100%"
  32. BORDER="0"
  33. CELLPADDING="0"
  34. CELLSPACING="0"
  35. ><TR
  36. ><TH
  37. COLSPAN="3"
  38. ALIGN="center"
  39. >SDL Library Documentation</TH
  40. ></TR
  41. ><TR
  42. ><TD
  43. WIDTH="10%"
  44. ALIGN="left"
  45. VALIGN="bottom"
  46. ><A
  47. HREF="sdljoystickupdate.html"
  48. >Prev</A
  49. ></TD
  50. ><TD
  51. WIDTH="80%"
  52. ALIGN="center"
  53. VALIGN="bottom"
  54. ></TD
  55. ><TD
  56. WIDTH="10%"
  57. ALIGN="right"
  58. VALIGN="bottom"
  59. ><A
  60. HREF="sdljoystickgethat.html"
  61. >Next</A
  62. ></TD
  63. ></TR
  64. ></TABLE
  65. ><HR
  66. ALIGN="LEFT"
  67. WIDTH="100%"></DIV
  68. ><H1
  69. ><A
  70. NAME="SDLJOYSTICKGETAXIS"
  71. >SDL_JoystickGetAxis</A
  72. ></H1
  73. ><DIV
  74. CLASS="REFNAMEDIV"
  75. ><A
  76. NAME="AEN5773"
  77. ></A
  78. ><H2
  79. >Name</H2
  80. >SDL_JoystickGetAxis&nbsp;--&nbsp;Get the current state of an axis</DIV
  81. ><DIV
  82. CLASS="REFSYNOPSISDIV"
  83. ><A
  84. NAME="AEN5776"
  85. ></A
  86. ><H2
  87. >Synopsis</H2
  88. ><DIV
  89. CLASS="FUNCSYNOPSIS"
  90. ><A
  91. NAME="AEN5777"
  92. ></A
  93. ><P
  94. ></P
  95. ><PRE
  96. CLASS="FUNCSYNOPSISINFO"
  97. >#include "SDL.h"</PRE
  98. ><P
  99. ><CODE
  100. ><CODE
  101. CLASS="FUNCDEF"
  102. >Sint16 <B
  103. CLASS="FSFUNC"
  104. >SDL_JoystickGetAxis</B
  105. ></CODE
  106. >(SDL_Joystick *joystick, int axis);</CODE
  107. ></P
  108. ><P
  109. ></P
  110. ></DIV
  111. ></DIV
  112. ><DIV
  113. CLASS="REFSECT1"
  114. ><A
  115. NAME="AEN5783"
  116. ></A
  117. ><H2
  118. >Description</H2
  119. ><P
  120. ><TT
  121. CLASS="FUNCTION"
  122. >SDL_JoystickGetAxis</TT
  123. > returns the current state of the given <TT
  124. CLASS="PARAMETER"
  125. ><I
  126. >axis</I
  127. ></TT
  128. > on the given <TT
  129. CLASS="PARAMETER"
  130. ><I
  131. >joystick</I
  132. ></TT
  133. >.</P
  134. ><P
  135. >On most modern joysticks the X axis is usually represented by <TT
  136. CLASS="PARAMETER"
  137. ><I
  138. >axis</I
  139. ></TT
  140. > 0 and the Y axis by <TT
  141. CLASS="PARAMETER"
  142. ><I
  143. >axis</I
  144. ></TT
  145. > 1. The value returned by <TT
  146. CLASS="FUNCTION"
  147. >SDL_JoystickGetAxis</TT
  148. > is a signed integer (-32768 to 32768) representing the current position of the <TT
  149. CLASS="PARAMETER"
  150. ><I
  151. >axis</I
  152. ></TT
  153. >, it maybe necessary to impose certain tolerances on these values to account for jitter. It is worth noting that some joysticks use axes 2 and 3 for extra buttons.</P
  154. ></DIV
  155. ><DIV
  156. CLASS="REFSECT1"
  157. ><A
  158. NAME="AEN5794"
  159. ></A
  160. ><H2
  161. >Return Value</H2
  162. ><P
  163. >Returns a 16-bit signed integer representing the current position of the <TT
  164. CLASS="PARAMETER"
  165. ><I
  166. >axis</I
  167. ></TT
  168. >.</P
  169. ></DIV
  170. ><DIV
  171. CLASS="REFSECT1"
  172. ><A
  173. NAME="AEN5798"
  174. ></A
  175. ><H2
  176. >Examples</H2
  177. ><P
  178. ><PRE
  179. CLASS="PROGRAMLISTING"
  180. >Sint16 x_move, y_move;
  181. SDL_Joystick *joy1;
  182. .
  183. .
  184. x_move=SDL_JoystickGetAxis(joy1, 0);
  185. y_move=SDL_JoystickGetAxis(joy1, 1);</PRE
  186. ></P
  187. ></DIV
  188. ><DIV
  189. CLASS="REFSECT1"
  190. ><A
  191. NAME="AEN5802"
  192. ></A
  193. ><H2
  194. >See Also</H2
  195. ><P
  196. ><A
  197. HREF="sdljoysticknumaxes.html"
  198. ><TT
  199. CLASS="FUNCTION"
  200. >SDL_JoystickNumAxes</TT
  201. ></A
  202. ></P
  203. ></DIV
  204. ><DIV
  205. CLASS="NAVFOOTER"
  206. ><HR
  207. ALIGN="LEFT"
  208. WIDTH="100%"><TABLE
  209. WIDTH="100%"
  210. BORDER="0"
  211. CELLPADDING="0"
  212. CELLSPACING="0"
  213. ><TR
  214. ><TD
  215. WIDTH="33%"
  216. ALIGN="left"
  217. VALIGN="top"
  218. ><A
  219. HREF="sdljoystickupdate.html"
  220. >Prev</A
  221. ></TD
  222. ><TD
  223. WIDTH="34%"
  224. ALIGN="center"
  225. VALIGN="top"
  226. ><A
  227. HREF="index.html"
  228. >Home</A
  229. ></TD
  230. ><TD
  231. WIDTH="33%"
  232. ALIGN="right"
  233. VALIGN="top"
  234. ><A
  235. HREF="sdljoystickgethat.html"
  236. >Next</A
  237. ></TD
  238. ></TR
  239. ><TR
  240. ><TD
  241. WIDTH="33%"
  242. ALIGN="left"
  243. VALIGN="top"
  244. >SDL_JoystickUpdate</TD
  245. ><TD
  246. WIDTH="34%"
  247. ALIGN="center"
  248. VALIGN="top"
  249. ><A
  250. HREF="joystick.html"
  251. >Up</A
  252. ></TD
  253. ><TD
  254. WIDTH="33%"
  255. ALIGN="right"
  256. VALIGN="top"
  257. >SDL_JoystickGetHat</TD
  258. ></TR
  259. ></TABLE
  260. ></DIV
  261. ></BODY
  262. ></HTML
  263. >