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