/
joystick.html
296 lines (296 loc) · 5.25 KB
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>Joystick</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="SDL Reference"
HREF="reference.html"><LINK
REL="PREVIOUS"
TITLE="SDL_JoystickEventState"
HREF="sdljoystickeventstate.html"><LINK
REL="NEXT"
TITLE="SDL_NumJoysticks"
HREF="sdlnumjoysticks.html"><META
NAME="KEYWORD"
CONTENT="joystick"><META
NAME="KEYWORD"
CONTENT="function"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
35
SUMMARY="Header navigation table"
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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="sdljoystickeventstate.html"
53
ACCESSKEY="P"
54
55
56
57
58
59
60
61
62
63
64
65
66
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlnumjoysticks.html"
67
ACCESSKEY="N"
68
69
70
71
72
73
74
75
76
77
78
79
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="JOYSTICK"
80
81
></A
>Chapter 9. Joystick</H1
82
83
84
85
86
87
88
89
90
91
92
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="sdlnumjoysticks.html"
>SDL_NumJoysticks</A
93
> -- Count available joysticks.</DT
94
95
96
97
><DT
><A
HREF="sdljoystickname.html"
>SDL_JoystickName</A
98
> -- Get joystick name.</DT
99
100
101
102
><DT
><A
HREF="sdljoystickopen.html"
>SDL_JoystickOpen</A
103
> -- Opens a joystick for use.</DT
104
105
106
107
><DT
><A
HREF="sdljoystickopened.html"
>SDL_JoystickOpened</A
108
> -- Determine if a joystick has been opened</DT
109
110
111
112
><DT
><A
HREF="sdljoystickindex.html"
>SDL_JoystickIndex</A
113
> -- Get the index of an SDL_Joystick.</DT
114
115
116
117
><DT
><A
HREF="sdljoysticknumaxes.html"
>SDL_JoystickNumAxes</A
118
> -- Get the number of joystick axes</DT
119
120
121
122
><DT
><A
HREF="sdljoysticknumballs.html"
>SDL_JoystickNumBalls</A
123
> -- Get the number of joystick trackballs</DT
124
125
126
127
><DT
><A
HREF="sdljoysticknumhats.html"
>SDL_JoystickNumHats</A
128
> -- Get the number of joystick hats</DT
129
130
131
132
><DT
><A
HREF="sdljoysticknumbuttons.html"
>SDL_JoystickNumButtons</A
133
> -- Get the number of joysitck buttons</DT
134
135
136
137
><DT
><A
HREF="sdljoystickupdate.html"
>SDL_JoystickUpdate</A
138
> -- Updates the state of all joysticks</DT
139
140
141
142
><DT
><A
HREF="sdljoystickgetaxis.html"
>SDL_JoystickGetAxis</A
143
> -- Get the current state of an axis</DT
144
145
146
147
><DT
><A
HREF="sdljoystickgethat.html"
>SDL_JoystickGetHat</A
148
> -- Get the current state of a joystick hat</DT
149
150
151
152
><DT
><A
HREF="sdljoystickgetbutton.html"
>SDL_JoystickGetButton</A
153
> -- Get the current state of a given button on a given joystick</DT
154
155
156
157
><DT
><A
HREF="sdljoystickgetball.html"
>SDL_JoystickGetBall</A
158
> -- Get relative trackball motion</DT
159
160
161
162
><DT
><A
HREF="sdljoystickclose.html"
>SDL_JoystickClose</A
163
> -- Closes a previously opened joystick</DT
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
></DL
></DIV
><P
>Joysticks, and other similar input devices, have a very strong role in game playing and SDL provides comprehensive support for them. Axes, Buttons, POV Hats and trackballs are all supported.</P
><P
>Joystick support is initialized by passed the <TT
CLASS="LITERAL"
>SDL_INIT_JOYSTICK</TT
> flag to <A
HREF="sdlinit.html"
><TT
CLASS="FUNCTION"
>SDL_Init</TT
></A
>. Once initilized joysticks must be opened using <A
HREF="sdljoystickopen.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickOpen</TT
></A
>.</P
><P
>While using the functions describe in this secton may seem like the best way to access and read from joysticks, in most cases they aren't. Ideally joysticks should be read using the <A
HREF="event.html"
>event</A
> system. To enable this, you must set the joystick event processing state with <A
HREF="sdljoystickeventstate.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickEventState</TT
></A
>. Joysticks must be <A
HREF="sdljoystickopen.html"
>opened</A
> before they can be used of course.</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
206
207
208
>If you are <SPAN
CLASS="emphasis"
><I
209
210
CLASS="EMPHASIS"
>not</I
211
></SPAN
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
> handling the joystick via the event queue then you must explicitly request a joystick update by calling <A
HREF="sdljoystickupdate.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickUpdate</TT
></A
>.</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Force Feedback is not yet support. Sam (slouken@libsdl.org) is soliciting suggestions from people with force-feedback experience on the best wat to desgin the API.</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
237
SUMMARY="Footer navigation table"
238
239
240
241
242
243
244
245
246
247
248
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdljoystickeventstate.html"
249
ACCESSKEY="P"
250
251
252
253
254
255
256
257
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
258
ACCESSKEY="H"
259
260
261
262
263
264
265
266
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlnumjoysticks.html"
267
ACCESSKEY="N"
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_JoystickEventState</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="reference.html"
283
ACCESSKEY="U"
284
285
286
287
288
289
290
291
292
293
294
295
296
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_NumJoysticks</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>