Mercurial > sdl-ios-xcode
annotate docs/html/sdllockyuvoverlay.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_LockYUVOverlay</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="Video" | |
14 HREF="video.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_CreateYUVOverlay" | |
17 HREF="sdlcreateyuvoverlay.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_UnlockYUVOverlay" | |
20 HREF="sdlunlockyuvoverlay.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="sdlcreateyuvoverlay.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="sdlunlockyuvoverlay.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="SDLLOCKYUVOVERLAY" | |
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_LockYUVOverlay</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="AEN2844" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_LockYUVOverlay -- Lock an overlay</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="AEN2847" |
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="AEN2848" |
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_LockYUVOverlay</B | |
108 ></CODE | |
109 >(SDL_Overlay *overlay);</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="AEN2854" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Much the same as <A | |
124 HREF="sdllocksurface.html" | |
125 ><TT | |
126 CLASS="FUNCTION" | |
127 >SDL_LockSurface</TT | |
128 ></A | |
129 >, <TT | |
130 CLASS="FUNCTION" | |
131 >SDL_LockYUVOverlay</TT | |
132 > locks the <A | |
133 HREF="sdloverlay.html" | |
134 ><TT | |
135 CLASS="PARAMETER" | |
136 ><I | |
137 >overlay</I | |
138 ></TT | |
139 ></A | |
140 > for direct access to pixel data.</P | |
141 ></DIV | |
142 ><DIV | |
143 CLASS="REFSECT1" | |
144 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
145 NAME="AEN2862" |
0 | 146 ></A |
147 ><H2 | |
148 >Return Value</H2 | |
149 ><P | |
150 >Returns <SPAN | |
151 CLASS="RETURNVALUE" | |
152 >0</SPAN | |
153 > on success, or <SPAN | |
154 CLASS="RETURNVALUE" | |
155 >-1</SPAN | |
156 > on an error.</P | |
157 ></DIV | |
158 ><DIV | |
159 CLASS="REFSECT1" | |
160 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
161 NAME="AEN2867" |
0 | 162 ></A |
163 ><H2 | |
164 >See Also</H2 | |
165 ><P | |
166 ><A | |
167 HREF="sdlunlockyuvoverlay.html" | |
168 ><TT | |
169 CLASS="FUNCTION" | |
170 >SDL_UnlockYUVOverlay</TT | |
171 ></A | |
172 >, | |
173 <A | |
174 HREF="sdlcreateyuvoverlay.html" | |
175 ><TT | |
176 CLASS="FUNCTION" | |
177 >SDL_CreateYUVOverlay</TT | |
178 ></A | |
179 >, | |
180 <A | |
181 HREF="sdloverlay.html" | |
182 ><SPAN | |
183 CLASS="STRUCTNAME" | |
184 >SDL_Overlay</SPAN | |
185 ></A | |
186 ></P | |
187 ></DIV | |
188 ><DIV | |
189 CLASS="NAVFOOTER" | |
190 ><HR | |
191 ALIGN="LEFT" | |
192 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
193 SUMMARY="Footer navigation table" |
0 | 194 WIDTH="100%" |
195 BORDER="0" | |
196 CELLPADDING="0" | |
197 CELLSPACING="0" | |
198 ><TR | |
199 ><TD | |
200 WIDTH="33%" | |
201 ALIGN="left" | |
202 VALIGN="top" | |
203 ><A | |
204 HREF="sdlcreateyuvoverlay.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
205 ACCESSKEY="P" |
0 | 206 >Prev</A |
207 ></TD | |
208 ><TD | |
209 WIDTH="34%" | |
210 ALIGN="center" | |
211 VALIGN="top" | |
212 ><A | |
213 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
214 ACCESSKEY="H" |
0 | 215 >Home</A |
216 ></TD | |
217 ><TD | |
218 WIDTH="33%" | |
219 ALIGN="right" | |
220 VALIGN="top" | |
221 ><A | |
222 HREF="sdlunlockyuvoverlay.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
223 ACCESSKEY="N" |
0 | 224 >Next</A |
225 ></TD | |
226 ></TR | |
227 ><TR | |
228 ><TD | |
229 WIDTH="33%" | |
230 ALIGN="left" | |
231 VALIGN="top" | |
232 >SDL_CreateYUVOverlay</TD | |
233 ><TD | |
234 WIDTH="34%" | |
235 ALIGN="center" | |
236 VALIGN="top" | |
237 ><A | |
238 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
239 ACCESSKEY="U" |
0 | 240 >Up</A |
241 ></TD | |
242 ><TD | |
243 WIDTH="33%" | |
244 ALIGN="right" | |
245 VALIGN="top" | |
246 >SDL_UnlockYUVOverlay</TD | |
247 ></TR | |
248 ></TABLE | |
249 ></DIV | |
250 ></BODY | |
251 ></HTML | |
252 > |