SDL-1.2.14
[sdl_omap.git] / docs / html / sdlloadbmp.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_LoadBMP</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
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_UnlockSurface"
17 HREF="sdlunlocksurface.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_SaveBMP"
20 HREF="sdlsavebmp.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
31 SUMMARY="Header navigation table"
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="sdlunlocksurface.html"
49 ACCESSKEY="P"
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="sdlsavebmp.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><H1
72 ><A
73 NAME="SDLLOADBMP"
74 ></A
75 >SDL_LoadBMP</H1
76 ><DIV
77 CLASS="REFNAMEDIV"
78 ><A
79 NAME="AEN1989"
80 ></A
81 ><H2
82 >Name</H2
83 >SDL_LoadBMP&nbsp;--&nbsp;Load a Windows BMP file into an SDL_Surface.</DIV
84 ><DIV
85 CLASS="REFSYNOPSISDIV"
86 ><A
87 NAME="AEN1992"
88 ></A
89 ><H2
90 >Synopsis</H2
91 ><DIV
92 CLASS="FUNCSYNOPSIS"
93 ><A
94 NAME="AEN1993"
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 >SDL_Surface *<B
106 CLASS="FSFUNC"
107 >SDL_LoadBMP</B
108 ></CODE
109 >(const char *file);</CODE
110 ></P
111 ><P
112 ></P
113 ></DIV
114 ></DIV
115 ><DIV
116 CLASS="REFSECT1"
117 ><A
118 NAME="AEN1999"
119 ></A
120 ><H2
121 >Description</H2
122 ><P
123 >Loads a surface from a named Windows BMP file.</P
124 ></DIV
125 ><DIV
126 CLASS="REFSECT1"
127 ><A
128 NAME="AEN2002"
129 ></A
130 ><H2
131 >Return Value</H2
132 ><P
133 >Returns the new surface, or <TT
134 CLASS="LITERAL"
135 >NULL</TT
136
137 if there was an error.</P
138 ></DIV
139 ><DIV
140 CLASS="REFSECT1"
141 ><A
142 NAME="AEN2006"
143 ></A
144 ><H2
145 >See Also</H2
146 ><P
147 ><A
148 HREF="sdlsavebmp.html"
149 ><TT
150 CLASS="FUNCTION"
151 >SDL_SaveBMP</TT
152 ></A
153 ></P
154 ></DIV
155 ><DIV
156 CLASS="NAVFOOTER"
157 ><HR
158 ALIGN="LEFT"
159 WIDTH="100%"><TABLE
160 SUMMARY="Footer navigation table"
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="sdlunlocksurface.html"
172 ACCESSKEY="P"
173 >Prev</A
174 ></TD
175 ><TD
176 WIDTH="34%"
177 ALIGN="center"
178 VALIGN="top"
179 ><A
180 HREF="index.html"
181 ACCESSKEY="H"
182 >Home</A
183 ></TD
184 ><TD
185 WIDTH="33%"
186 ALIGN="right"
187 VALIGN="top"
188 ><A
189 HREF="sdlsavebmp.html"
190 ACCESSKEY="N"
191 >Next</A
192 ></TD
193 ></TR
194 ><TR
195 ><TD
196 WIDTH="33%"
197 ALIGN="left"
198 VALIGN="top"
199 >SDL_UnlockSurface</TD
200 ><TD
201 WIDTH="34%"
202 ALIGN="center"
203 VALIGN="top"
204 ><A
205 HREF="video.html"
206 ACCESSKEY="U"
207 >Up</A
208 ></TD
209 ><TD
210 WIDTH="33%"
211 ALIGN="right"
212 VALIGN="top"
213 >SDL_SaveBMP</TD
214 ></TR
215 ></TABLE
216 ></DIV
217 ></BODY
218 ></HTML
219 >