Mercurial > sdl-ios-xcode
annotate docs/html/sdlfreesurface.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_FreeSurface</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_CreateRGBSurfaceFrom" | |
17 HREF="sdlcreatergbsurfacefrom.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_LockSurface" | |
20 HREF="sdllocksurface.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="sdlcreatergbsurfacefrom.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="sdllocksurface.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="SDLFREESURFACE" | |
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_FreeSurface</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="AEN1893" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
83 >SDL_FreeSurface -- Frees (deletes) a SDL_Surface</DIV |
0 | 84 ><DIV |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN1896" |
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="AEN1897" |
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 >void <B | |
106 CLASS="FSFUNC" | |
107 >SDL_FreeSurface</B | |
108 ></CODE | |
109 >(SDL_Surface *surface);</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="AEN1903" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Frees the resources used by a previously created <SPAN | |
124 CLASS="STRUCTNAME" | |
125 >SDL_Surface</SPAN | |
126 >. If the surface was created using | |
127 <A | |
128 HREF="sdlcreatergbsurfacefrom.html" | |
129 >SDL_CreateRGBSurfaceFrom</A | |
130 > then the pixel data is not freed.</P | |
131 ></DIV | |
132 ><DIV | |
133 CLASS="REFSECT1" | |
134 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
135 NAME="AEN1908" |
0 | 136 ></A |
137 ><H2 | |
138 >See Also</H2 | |
139 ><P | |
140 ><A | |
141 HREF="sdlcreatergbsurface.html" | |
142 ><TT | |
143 CLASS="FUNCTION" | |
144 >SDL_CreateRGBSurface</TT | |
145 ></A | |
146 > | |
147 <A | |
148 HREF="sdlcreatergbsurfacefrom.html" | |
149 ><TT | |
150 CLASS="FUNCTION" | |
151 >SDL_CreateRGBSurfaceFrom</TT | |
152 ></A | |
153 ></P | |
154 ></DIV | |
155 ><DIV | |
156 CLASS="NAVFOOTER" | |
157 ><HR | |
158 ALIGN="LEFT" | |
159 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
160 SUMMARY="Footer navigation table" |
0 | 161 WIDTH="100%" |
162 BORDER="0" | |
163 CELLPADDING="0" | |
164 CELLSPACING="0" | |
165 ><TR | |
166 ><TD | |
167 WIDTH="33%" | |
168 ALIGN="left" | |
169 VALIGN="top" | |
170 ><A | |
171 HREF="sdlcreatergbsurfacefrom.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
172 ACCESSKEY="P" |
0 | 173 >Prev</A |
174 ></TD | |
175 ><TD | |
176 WIDTH="34%" | |
177 ALIGN="center" | |
178 VALIGN="top" | |
179 ><A | |
180 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
181 ACCESSKEY="H" |
0 | 182 >Home</A |
183 ></TD | |
184 ><TD | |
185 WIDTH="33%" | |
186 ALIGN="right" | |
187 VALIGN="top" | |
188 ><A | |
189 HREF="sdllocksurface.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
190 ACCESSKEY="N" |
0 | 191 >Next</A |
192 ></TD | |
193 ></TR | |
194 ><TR | |
195 ><TD | |
196 WIDTH="33%" | |
197 ALIGN="left" | |
198 VALIGN="top" | |
199 >SDL_CreateRGBSurfaceFrom</TD | |
200 ><TD | |
201 WIDTH="34%" | |
202 ALIGN="center" | |
203 VALIGN="top" | |
204 ><A | |
205 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
206 ACCESSKEY="U" |
0 | 207 >Up</A |
208 ></TD | |
209 ><TD | |
210 WIDTH="33%" | |
211 ALIGN="right" | |
212 VALIGN="top" | |
213 >SDL_LockSurface</TD | |
214 ></TR | |
215 ></TABLE | |
216 ></DIV | |
217 ></BODY | |
218 ></HTML | |
219 > |