Mercurial > sdl-ios-xcode
annotate docs/html/sdljoystickindex.html @ 2866:e532417a6977
Fixed SDL 1.2 compatibility problem.
The API specifies that SDL_OpenAudio() will fill out the 'desired' audio spec
with the correct samples and size set by the driver. This value is important
since it may be used by applications that size audio buffers, etc.
However, we want to allow advanced applications to call SDL_OpenAudioDevice()
which gets passed a const 'desired' parameter, and have the correct data filled
into the 'obtained' parameter, possibly allowing or not allowing format changes.
So... 'obtained' becomes the audio format the user callback is expected to use,
and we add flags to allow the application to specify which format changes are
allowed.
Note: We really need to add a way to query the 'obtained' audio spec.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 13 Dec 2008 06:36:47 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_JoystickIndex</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 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_JoystickOpened" | |
17 HREF="sdljoystickopened.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_JoystickNumAxes" | |
20 HREF="sdljoysticknumaxes.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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 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="sdljoystickopened.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 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="sdljoysticknumaxes.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLJOYSTICKINDEX" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_JoystickIndex</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN6158" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_JoystickIndex -- Get the index of an SDL_Joystick.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN6161" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN6162" |
0 | 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 >int <B | |
106 CLASS="FSFUNC" | |
107 >SDL_JoystickIndex</B | |
108 ></CODE | |
109 >(SDL_Joystick *joystick);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN6168" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Returns the index of a given <SPAN | |
124 CLASS="STRUCTNAME" | |
125 >SDL_Joystick</SPAN | |
126 > structure.</P | |
127 ></DIV | |
128 ><DIV | |
129 CLASS="REFSECT1" | |
130 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
131 NAME="AEN6172" |
0 | 132 ></A |
133 ><H2 | |
134 >Return Value</H2 | |
135 ><P | |
136 >Index number of the joystick.</P | |
137 ></DIV | |
138 ><DIV | |
139 CLASS="REFSECT1" | |
140 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
141 NAME="AEN6175" |
0 | 142 ></A |
143 ><H2 | |
144 >See Also</H2 | |
145 ><P | |
146 ><A | |
147 HREF="sdljoystickopen.html" | |
148 ><TT | |
149 CLASS="FUNCTION" | |
150 >SDL_JoystickOpen</TT | |
151 ></A | |
152 ></P | |
153 ></DIV | |
154 ><DIV | |
155 CLASS="NAVFOOTER" | |
156 ><HR | |
157 ALIGN="LEFT" | |
158 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
159 SUMMARY="Footer navigation table" |
0 | 160 WIDTH="100%" |
161 BORDER="0" | |
162 CELLPADDING="0" | |
163 CELLSPACING="0" | |
164 ><TR | |
165 ><TD | |
166 WIDTH="33%" | |
167 ALIGN="left" | |
168 VALIGN="top" | |
169 ><A | |
170 HREF="sdljoystickopened.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
171 ACCESSKEY="P" |
0 | 172 >Prev</A |
173 ></TD | |
174 ><TD | |
175 WIDTH="34%" | |
176 ALIGN="center" | |
177 VALIGN="top" | |
178 ><A | |
179 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
180 ACCESSKEY="H" |
0 | 181 >Home</A |
182 ></TD | |
183 ><TD | |
184 WIDTH="33%" | |
185 ALIGN="right" | |
186 VALIGN="top" | |
187 ><A | |
188 HREF="sdljoysticknumaxes.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
189 ACCESSKEY="N" |
0 | 190 >Next</A |
191 ></TD | |
192 ></TR | |
193 ><TR | |
194 ><TD | |
195 WIDTH="33%" | |
196 ALIGN="left" | |
197 VALIGN="top" | |
198 >SDL_JoystickOpened</TD | |
199 ><TD | |
200 WIDTH="34%" | |
201 ALIGN="center" | |
202 VALIGN="top" | |
203 ><A | |
204 HREF="joystick.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
205 ACCESSKEY="U" |
0 | 206 >Up</A |
207 ></TD | |
208 ><TD | |
209 WIDTH="33%" | |
210 ALIGN="right" | |
211 VALIGN="top" | |
212 >SDL_JoystickNumAxes</TD | |
213 ></TR | |
214 ></TABLE | |
215 ></DIV | |
216 ></BODY | |
217 ></HTML | |
218 > |