sdljoystickopen.html
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_JoystickOpen</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
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Joystick"
HREF="joystick.html"><LINK
REL="PREVIOUS"
TITLE="SDL_JoystickName"
HREF="sdljoystickname.html"><LINK
REL="NEXT"
TITLE="SDL_JoystickOpened"
HREF="sdljoystickopened.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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="sdljoystickname.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdljoystickopened.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLJOYSTICKOPEN"
74
75
></A
>SDL_JoystickOpen</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN6096"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_JoystickOpen -- Opens a joystick for use.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN6099"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN6100"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDL_Joystick *<B
CLASS="FSFUNC"
>SDL_JoystickOpen</B
></CODE
>(int index);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
118
NAME="AEN6106"
119
120
121
122
123
124
125
126
127
128
129
130
131
132
></A
><H2
>Description</H2
><P
>Opens a joystick for use within SDL. The <TT
CLASS="PARAMETER"
><I
>index</I
></TT
> refers to the N'th joystick in the system. A joystick must be opened before it game be used.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
133
NAME="AEN6110"
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
></A
><H2
>Return Value</H2
><P
>Returns a <SPAN
CLASS="STRUCTNAME"
>SDL_Joystick</SPAN
> structure on success. <SPAN
CLASS="RETURNVALUE"
>NULL</SPAN
> on failure.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
149
NAME="AEN6115"
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
></A
><H2
>Examples</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>SDL_Joystick *joy;
// Check for joystick
if(SDL_NumJoysticks()>0){
// Open joystick
joy=SDL_JoystickOpen(0);
if(joy)
{
printf("Opened Joystick 0\n");
printf("Name: %s\n", SDL_JoystickName(0));
166
167
168
printf("Number of Axes: %d\n", SDL_JoystickNumAxes(joy));
printf("Number of Buttons: %d\n", SDL_JoystickNumButtons(joy));
printf("Number of Balls: %d\n", SDL_JoystickNumBalls(joy));
169
170
171
172
173
174
175
176
177
178
179
180
181
}
else
printf("Couldn't open Joystick 0\n");
// Close if opened
if(SDL_JoystickOpened(0))
SDL_JoystickClose(joy);
}</PRE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
182
NAME="AEN6119"
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
></A
><H2
>See Also</H2
><P
><A
HREF="sdljoystickclose.html"
><TT
CLASS="FUNCTION"
>SDL_JoystickClose</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
200
SUMMARY="Footer navigation table"
201
202
203
204
205
206
207
208
209
210
211
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdljoystickname.html"
212
ACCESSKEY="P"
213
214
215
216
217
218
219
220
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
221
ACCESSKEY="H"
222
223
224
225
226
227
228
229
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdljoystickopened.html"
230
ACCESSKEY="N"
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_JoystickName</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="joystick.html"
246
ACCESSKEY="U"
247
248
249
250
251
252
253
254
255
256
257
258
259
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_JoystickOpened</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>