• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_SaveBMP</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="Video"
14HREF="video.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_LoadBMP"
17HREF="sdlloadbmp.html"><LINK
18REL="NEXT"
19TITLE="SDL_SetColorKey"
20HREF="sdlsetcolorkey.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="sdlloadbmp.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="sdlsetcolorkey.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLSAVEBMP"
74></A
75>SDL_SaveBMP</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN2015"
80></A
81><H2
82>Name</H2
83>SDL_SaveBMP&nbsp;--&nbsp;Save an SDL_Surface as a Windows BMP file.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN2018"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN2019"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>int <B
106CLASS="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
116CLASS="REFSECT1"
117><A
118NAME="AEN2025"
119></A
120><H2
121>Description</H2
122><P
123>Saves the <SPAN
124CLASS="STRUCTNAME"
125>SDL_Surface</SPAN
126> <TT
127CLASS="PARAMETER"
128><I
129>surface</I
130></TT
131> as a Windows BMP file named <TT
132CLASS="PARAMETER"
133><I
134>file</I
135></TT
136>.</P
137></DIV
138><DIV
139CLASS="REFSECT1"
140><A
141NAME="AEN2031"
142></A
143><H2
144>Return Value</H2
145><P
146>Returns <SPAN
147CLASS="RETURNVALUE"
148>0</SPAN
149> if successful or
150<SPAN
151CLASS="RETURNVALUE"
152>-1</SPAN
153>
154if there was an error.</P
155></DIV
156><DIV
157CLASS="REFSECT1"
158><A
159NAME="AEN2036"
160></A
161><H2
162>See Also</H2
163><P
164><A
165HREF="sdlloadbmp.html"
166><TT
167CLASS="FUNCTION"
168>SDL_LoadBMP</TT
169></A
170></P
171></DIV
172><DIV
173CLASS="NAVFOOTER"
174><HR
175ALIGN="LEFT"
176WIDTH="100%"><TABLE
177SUMMARY="Footer navigation table"
178WIDTH="100%"
179BORDER="0"
180CELLPADDING="0"
181CELLSPACING="0"
182><TR
183><TD
184WIDTH="33%"
185ALIGN="left"
186VALIGN="top"
187><A
188HREF="sdlloadbmp.html"
189ACCESSKEY="P"
190>Prev</A
191></TD
192><TD
193WIDTH="34%"
194ALIGN="center"
195VALIGN="top"
196><A
197HREF="index.html"
198ACCESSKEY="H"
199>Home</A
200></TD
201><TD
202WIDTH="33%"
203ALIGN="right"
204VALIGN="top"
205><A
206HREF="sdlsetcolorkey.html"
207ACCESSKEY="N"
208>Next</A
209></TD
210></TR
211><TR
212><TD
213WIDTH="33%"
214ALIGN="left"
215VALIGN="top"
216>SDL_LoadBMP</TD
217><TD
218WIDTH="34%"
219ALIGN="center"
220VALIGN="top"
221><A
222HREF="video.html"
223ACCESSKEY="U"
224>Up</A
225></TD
226><TD
227WIDTH="33%"
228ALIGN="right"
229VALIGN="top"
230>SDL_SetColorKey</TD
231></TR
232></TABLE
233></DIV
234></BODY
235></HTML
236>