Mercurial > sdl-ios-xcode
annotate docs/html/sdlsavebmp.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_SaveBMP</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_LoadBMP" | |
17 HREF="sdlloadbmp.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_SetColorKey" | |
20 HREF="sdlsetcolorkey.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="sdlloadbmp.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="sdlsetcolorkey.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="SDLSAVEBMP" | |
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_SaveBMP</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="AEN2015" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_SaveBMP -- Save an SDL_Surface as a Windows BMP file.</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="AEN2018" |
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="AEN2019" |
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_SaveBMP</B | |
108 ></CODE | |
109 >(SDL_Surface *surface, const char *file);</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="AEN2025" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Saves the <SPAN | |
124 CLASS="STRUCTNAME" | |
125 >SDL_Surface</SPAN | |
126 > <TT | |
127 CLASS="PARAMETER" | |
128 ><I | |
129 >surface</I | |
130 ></TT | |
131 > as a Windows BMP file named <TT | |
132 CLASS="PARAMETER" | |
133 ><I | |
134 >file</I | |
135 ></TT | |
136 >.</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="AEN2031" |
0 | 142 ></A |
143 ><H2 | |
144 >Return Value</H2 | |
145 ><P | |
146 >Returns <SPAN | |
147 CLASS="RETURNVALUE" | |
148 >0</SPAN | |
149 > if successful or | |
150 <SPAN | |
151 CLASS="RETURNVALUE" | |
152 >-1</SPAN | |
153 > | |
154 if there was an error.</P | |
155 ></DIV | |
156 ><DIV | |
157 CLASS="REFSECT1" | |
158 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
159 NAME="AEN2036" |
0 | 160 ></A |
161 ><H2 | |
162 >See Also</H2 | |
163 ><P | |
164 ><A | |
165 HREF="sdlloadbmp.html" | |
166 ><TT | |
167 CLASS="FUNCTION" | |
168 >SDL_LoadBMP</TT | |
169 ></A | |
170 ></P | |
171 ></DIV | |
172 ><DIV | |
173 CLASS="NAVFOOTER" | |
174 ><HR | |
175 ALIGN="LEFT" | |
176 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
177 SUMMARY="Footer navigation table" |
0 | 178 WIDTH="100%" |
179 BORDER="0" | |
180 CELLPADDING="0" | |
181 CELLSPACING="0" | |
182 ><TR | |
183 ><TD | |
184 WIDTH="33%" | |
185 ALIGN="left" | |
186 VALIGN="top" | |
187 ><A | |
188 HREF="sdlloadbmp.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
189 ACCESSKEY="P" |
0 | 190 >Prev</A |
191 ></TD | |
192 ><TD | |
193 WIDTH="34%" | |
194 ALIGN="center" | |
195 VALIGN="top" | |
196 ><A | |
197 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
198 ACCESSKEY="H" |
0 | 199 >Home</A |
200 ></TD | |
201 ><TD | |
202 WIDTH="33%" | |
203 ALIGN="right" | |
204 VALIGN="top" | |
205 ><A | |
206 HREF="sdlsetcolorkey.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
207 ACCESSKEY="N" |
0 | 208 >Next</A |
209 ></TD | |
210 ></TR | |
211 ><TR | |
212 ><TD | |
213 WIDTH="33%" | |
214 ALIGN="left" | |
215 VALIGN="top" | |
216 >SDL_LoadBMP</TD | |
217 ><TD | |
218 WIDTH="34%" | |
219 ALIGN="center" | |
220 VALIGN="top" | |
221 ><A | |
222 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
223 ACCESSKEY="U" |
0 | 224 >Up</A |
225 ></TD | |
226 ><TD | |
227 WIDTH="33%" | |
228 ALIGN="right" | |
229 VALIGN="top" | |
230 >SDL_SetColorKey</TD | |
231 ></TR | |
232 ></TABLE | |
233 ></DIV | |
234 ></BODY | |
235 ></HTML | |
236 > |