• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_JoystickOpen</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_JoystickName"
17HREF="sdljoystickname.html"><LINK
18REL="NEXT"
19TITLE="SDL_JoystickOpened"
20HREF="sdljoystickopened.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="sdljoystickname.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="sdljoystickopened.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLJOYSTICKOPEN"
74></A
75>SDL_JoystickOpen</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN6096"
80></A
81><H2
82>Name</H2
83>SDL_JoystickOpen&nbsp;--&nbsp;Opens a joystick for use.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN6099"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN6100"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>SDL_Joystick *<B
106CLASS="FSFUNC"
107>SDL_JoystickOpen</B
108></CODE
109>(int index);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN6106"
119></A
120><H2
121>Description</H2
122><P
123>Opens a joystick for use within SDL. The <TT
124CLASS="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
131CLASS="REFSECT1"
132><A
133NAME="AEN6110"
134></A
135><H2
136>Return Value</H2
137><P
138>Returns a <SPAN
139CLASS="STRUCTNAME"
140>SDL_Joystick</SPAN
141> structure on success. <SPAN
142CLASS="RETURNVALUE"
143>NULL</SPAN
144> on failure.</P
145></DIV
146><DIV
147CLASS="REFSECT1"
148><A
149NAME="AEN6115"
150></A
151><H2
152>Examples</H2
153><P
154><PRE
155CLASS="PROGRAMLISTING"
156>SDL_Joystick *joy;
157// Check for joystick
158if(SDL_NumJoysticks()&#62;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
180CLASS="REFSECT1"
181><A
182NAME="AEN6119"
183></A
184><H2
185>See Also</H2
186><P
187><A
188HREF="sdljoystickclose.html"
189><TT
190CLASS="FUNCTION"
191>SDL_JoystickClose</TT
192></A
193></P
194></DIV
195><DIV
196CLASS="NAVFOOTER"
197><HR
198ALIGN="LEFT"
199WIDTH="100%"><TABLE
200SUMMARY="Footer navigation table"
201WIDTH="100%"
202BORDER="0"
203CELLPADDING="0"
204CELLSPACING="0"
205><TR
206><TD
207WIDTH="33%"
208ALIGN="left"
209VALIGN="top"
210><A
211HREF="sdljoystickname.html"
212ACCESSKEY="P"
213>Prev</A
214></TD
215><TD
216WIDTH="34%"
217ALIGN="center"
218VALIGN="top"
219><A
220HREF="index.html"
221ACCESSKEY="H"
222>Home</A
223></TD
224><TD
225WIDTH="33%"
226ALIGN="right"
227VALIGN="top"
228><A
229HREF="sdljoystickopened.html"
230ACCESSKEY="N"
231>Next</A
232></TD
233></TR
234><TR
235><TD
236WIDTH="33%"
237ALIGN="left"
238VALIGN="top"
239>SDL_JoystickName</TD
240><TD
241WIDTH="34%"
242ALIGN="center"
243VALIGN="top"
244><A
245HREF="joystick.html"
246ACCESSKEY="U"
247>Up</A
248></TD
249><TD
250WIDTH="33%"
251ALIGN="right"
252VALIGN="top"
253>SDL_JoystickOpened</TD
254></TR
255></TABLE
256></DIV
257></BODY
258></HTML
259>