[sdl_omap.git] / docs / html / sdljoyaxisevent.html

<HTML
><HEAD
><TITLE
>SDL_JoyAxisEvent</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="SDL Event Structures."
HREF="eventstructures.html"><LINK
REL="PREVIOUS"
TITLE="SDL_MouseButtonEvent"
HREF="sdlmousebuttonevent.html"><LINK
REL="NEXT"
TITLE="SDL_JoyButtonEvent"
HREF="sdljoybuttonevent.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlmousebuttonevent.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdljoybuttonevent.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLJOYAXISEVENT"
></A
>SDL_JoyAxisEvent</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4203"
></A
><H2
>Name</H2
>SDL_JoyAxisEvent&nbsp;--&nbsp;Joystick axis motion event structure</DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4206"
></A
><H2
>Structure Definition</H2
><PRE
CLASS="PROGRAMLISTING"
>typedef struct{
  Uint8 type;
  Uint8 which;
  Uint8 axis;
  Sint16 value;
} SDL_JoyAxisEvent;</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4209"
></A
><H2
>Structure Data</H2
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN4211"
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>type</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>SDL_JOYAXISMOTION</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>which</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Joystick device index</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>axis</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Joystick axis index</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>value</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>Axis value (range: -32768 to 32767)</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4231"
></A
><H2
>Description</H2
><P
><SPAN
CLASS="STRUCTNAME"
>SDL_JoyAxisEvent</SPAN
> is a member of the <A
HREF="sdlevent.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_Event</SPAN
></A
> union and is used when an event of type <TT
CLASS="LITERAL"
>SDL_JOYAXISMOTION</TT
> is reported.</P
><P
>A <TT
CLASS="LITERAL"
>SDL_JOYAXISMOTION</TT
> event occurs when ever a user moves an axis on the joystick. The field <TT
CLASS="STRUCTFIELD"
><I
>which</I
></TT
> is the index of the joystick that reported the event and <TT
CLASS="STRUCTFIELD"
><I
>axis</I
></TT
> is the index of the axis (for a more detailed explaination see the <A
HREF="joystick.html"
>Joystick section</A
>). <TT
CLASS="STRUCTFIELD"
><I
>value</I
></TT
> is the current position of the axis.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4244"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlevent.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_Event</SPAN
></A
>,
<A
HREF="joystick.html"
>Joystick Functions</A
>,
<A
HREF="sdljoystickeventstate.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickEventState</TT
></A
>,
<A
HREF="sdljoystickgetaxis.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickGetAxis</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlmousebuttonevent.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdljoybuttonevent.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_MouseButtonEvent</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="eventstructures.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_JoyButtonEvent</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_JoyAxisEvent</TITLE
	5	><META
	6	NAME="GENERATOR"
	7	CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
	8	"><LINK
	9	REL="HOME"
	10	TITLE="SDL Library Documentation"
	11	HREF="index.html"><LINK
	12	REL="UP"
	13	TITLE="SDL Event Structures."
	14	HREF="eventstructures.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL_MouseButtonEvent"
	17	HREF="sdlmousebuttonevent.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_JoyButtonEvent"
	20	HREF="sdljoybuttonevent.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	SUMMARY="Header navigation table"
	32	WIDTH="100%"
	33	BORDER="0"
	34	CELLPADDING="0"
	35	CELLSPACING="0"
	36	><TR
	37	><TH
	38	COLSPAN="3"
	39	ALIGN="center"
	40	>SDL Library Documentation</TH
	41	></TR
	42	><TR
	43	><TD
	44	WIDTH="10%"
	45	ALIGN="left"
	46	VALIGN="bottom"
	47	><A
	48	HREF="sdlmousebuttonevent.html"
	49	ACCESSKEY="P"
	50	>Prev</A
	51	></TD
	52	><TD
	53	WIDTH="80%"
	54	ALIGN="center"
	55	VALIGN="bottom"
	56	></TD
	57	><TD
	58	WIDTH="10%"
	59	ALIGN="right"
	60	VALIGN="bottom"
	61	><A
	62	HREF="sdljoybuttonevent.html"
	63	ACCESSKEY="N"
	64	>Next</A
65	></TD
66	></TR
67	></TABLE
68	><HR
69	ALIGN="LEFT"
70	WIDTH="100%"></DIV
71	><H1
72	><A
73	NAME="SDLJOYAXISEVENT"
74	></A
75	>SDL_JoyAxisEvent</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN4203"
80	></A
81	><H2
82	>Name</H2
83	>SDL_JoyAxisEvent -- Joystick axis motion event structure</DIV
84	><DIV
85	CLASS="REFSECT1"
86	><A
87	NAME="AEN4206"
88	></A
89	><H2
90	>Structure Definition</H2
91	><PRE
92	CLASS="PROGRAMLISTING"
93	>typedef struct{
94	Uint8 type;
95	Uint8 which;
96	Uint8 axis;
97	Sint16 value;
98	} SDL_JoyAxisEvent;</PRE
99	></DIV
100	><DIV
101	CLASS="REFSECT1"
102	><A
103	NAME="AEN4209"
104	></A
105	><H2
106	>Structure Data</H2
107	><DIV
108	CLASS="INFORMALTABLE"
109	><A
110	NAME="AEN4211"
111	></A
112	><P
113	></P
114	><TABLE
115	BORDER="0"
116	CLASS="CALSTABLE"
117	><TBODY
118	><TR
119	><TD
120	ALIGN="LEFT"
121	VALIGN="TOP"
122	><TT
123	CLASS="STRUCTFIELD"
124	><I
125	>type</I
126	></TT
127	></TD
128	><TD
129	ALIGN="LEFT"
130	VALIGN="TOP"
131	><TT
132	CLASS="LITERAL"
133	>SDL_JOYAXISMOTION</TT
134	></TD
135	></TR
136	><TR
137	><TD
138	ALIGN="LEFT"
139	VALIGN="TOP"
140	><TT
141	CLASS="STRUCTFIELD"
142	><I
143	>which</I
144	></TT
145	></TD
146	><TD
147	ALIGN="LEFT"
148	VALIGN="TOP"
149	>Joystick device index</TD
150	></TR
151	><TR
152	><TD
153	ALIGN="LEFT"
154	VALIGN="TOP"
155	><TT
156	CLASS="STRUCTFIELD"
157	><I
158	>axis</I
159	></TT
160	></TD
161	><TD
162	ALIGN="LEFT"
163	VALIGN="TOP"
164	>Joystick axis index</TD
165	></TR
166	><TR
167	><TD
168	ALIGN="LEFT"
169	VALIGN="TOP"
170	><TT
171	CLASS="STRUCTFIELD"
172	><I
173	>value</I
174	></TT
175	></TD
176	><TD
177	ALIGN="LEFT"
178	VALIGN="TOP"
179	>Axis value (range: -32768 to 32767)</TD
180	></TR
181	></TBODY
182	></TABLE
183	><P
184	></P
185	></DIV
186	></DIV
187	><DIV
188	CLASS="REFSECT1"
189	><A
190	NAME="AEN4231"
191	></A
192	><H2
193	>Description</H2
194	><P
195	><SPAN
196	CLASS="STRUCTNAME"
197	>SDL_JoyAxisEvent</SPAN
198	> is a member of the <A
199	HREF="sdlevent.html"
200	><SPAN
201	CLASS="STRUCTNAME"
202	>SDL_Event</SPAN
203	></A
204	> union and is used when an event of type <TT
205	CLASS="LITERAL"
206	>SDL_JOYAXISMOTION</TT
207	> is reported.</P
208	><P
209	>A <TT
210	CLASS="LITERAL"
211	>SDL_JOYAXISMOTION</TT
212	> event occurs when ever a user moves an axis on the joystick. The field <TT
213	CLASS="STRUCTFIELD"
214	><I
215	>which</I
216	></TT
217	> is the index of the joystick that reported the event and <TT
218	CLASS="STRUCTFIELD"
219	><I
220	>axis</I
221	></TT
222	> is the index of the axis (for a more detailed explaination see the <A
223	HREF="joystick.html"
224	>Joystick section</A
225	>). <TT
226	CLASS="STRUCTFIELD"
227	><I
228	>value</I
229	></TT
230	> is the current position of the axis.</P
231	></DIV
232	><DIV
233	CLASS="REFSECT1"
234	><A
235	NAME="AEN4244"
236	></A
237	><H2
238	>See Also</H2
239	><P
240	><A
241	HREF="sdlevent.html"
242	><SPAN
243	CLASS="STRUCTNAME"
244	>SDL_Event</SPAN
245	></A
246	>,
247	<A
248	HREF="joystick.html"
249	>Joystick Functions</A
250	>,
251	<A
252	HREF="sdljoystickeventstate.html"
253	><TT
254	CLASS="FUNCTION"
255	>SDL_JoystickEventState</TT
256	></A
257	>,
258	<A
259	HREF="sdljoystickgetaxis.html"
260	><TT
261	CLASS="FUNCTION"
262	>SDL_JoystickGetAxis</TT
263	></A
264	></P
265	></DIV
266	><DIV
267	CLASS="NAVFOOTER"
268	><HR
269	ALIGN="LEFT"
270	WIDTH="100%"><TABLE
271	SUMMARY="Footer navigation table"
272	WIDTH="100%"
273	BORDER="0"
274	CELLPADDING="0"
275	CELLSPACING="0"
276	><TR
277	><TD
278	WIDTH="33%"
279	ALIGN="left"
280	VALIGN="top"
281	><A
282	HREF="sdlmousebuttonevent.html"
283	ACCESSKEY="P"
284	>Prev</A
285	></TD
286	><TD
287	WIDTH="34%"
288	ALIGN="center"
289	VALIGN="top"
290	><A
291	HREF="index.html"
292	ACCESSKEY="H"
293	>Home</A
294	></TD
295	><TD
296	WIDTH="33%"
297	ALIGN="right"
298	VALIGN="top"
299	><A
300	HREF="sdljoybuttonevent.html"
301	ACCESSKEY="N"
302	>Next</A
303	></TD
304	></TR
305	><TR
306	><TD
307	WIDTH="33%"
308	ALIGN="left"
309	VALIGN="top"
310	>SDL_MouseButtonEvent</TD
311	><TD
312	WIDTH="34%"
313	ALIGN="center"
314	VALIGN="top"
315	><A
316	HREF="eventstructures.html"
317	ACCESSKEY="U"
318	>Up</A
319	></TD
320	><TD
321	WIDTH="33%"
322	ALIGN="right"
323	VALIGN="top"
324	>SDL_JoyButtonEvent</TD
325	></TR
326	></TABLE
327	></DIV
328	></BODY
329	></HTML
330	>