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