e14743d1 |
1 | <HTML |
2 | ><HEAD |
3 | ><TITLE |
4 | >SDL_DisplayFormat</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_FillRect" |
17 | HREF="sdlfillrect.html"><LINK |
18 | REL="NEXT" |
19 | TITLE="SDL_DisplayFormatAlpha" |
20 | HREF="sdldisplayformatalpha.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="sdlfillrect.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="sdldisplayformatalpha.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="SDLDISPLAYFORMAT" |
74 | ></A |
75 | >SDL_DisplayFormat</H1 |
76 | ><DIV |
77 | CLASS="REFNAMEDIV" |
78 | ><A |
79 | NAME="AEN2394" |
80 | ></A |
81 | ><H2 |
82 | >Name</H2 |
83 | >SDL_DisplayFormat -- Convert a surface to the display format</DIV |
84 | ><DIV |
85 | CLASS="REFSYNOPSISDIV" |
86 | ><A |
87 | NAME="AEN2397" |
88 | ></A |
89 | ><H2 |
90 | >Synopsis</H2 |
91 | ><DIV |
92 | CLASS="FUNCSYNOPSIS" |
93 | ><A |
94 | NAME="AEN2398" |
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_DisplayFormat</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 |
118 | NAME="AEN2404" |
119 | ></A |
120 | ><H2 |
121 | >Description</H2 |
122 | ><P |
123 | >This function takes a surface and copies it to a new surface of the |
124 | pixel format and colors of the video framebuffer, suitable for fast |
125 | blitting onto the display surface. It calls |
126 | <A |
127 | HREF="sdlconvertsurface.html" |
128 | >SDL_ConvertSurface</A |
129 | ></P |
130 | ><P |
131 | >If you want to take advantage of hardware colorkey or alpha blit |
132 | acceleration, you should set the colorkey and alpha value before |
133 | calling this function.</P |
134 | ><P |
135 | >If you want an alpha channel, see <A |
136 | HREF="sdldisplayformatalpha.html" |
137 | >SDL_DisplayFormatAlpha</A |
138 | >.</P |
139 | ></DIV |
140 | ><DIV |
141 | CLASS="REFSECT1" |
142 | ><A |
143 | NAME="AEN2411" |
144 | ></A |
145 | ><H2 |
146 | >Return Value</H2 |
147 | ><P |
148 | >If the conversion fails or runs out of memory, it returns |
149 | <SPAN |
150 | CLASS="RETURNVALUE" |
151 | >NULL</SPAN |
152 | ></P |
153 | ></DIV |
154 | ><DIV |
155 | CLASS="REFSECT1" |
156 | ><A |
157 | NAME="AEN2415" |
158 | ></A |
159 | ><H2 |
160 | >See Also</H2 |
161 | ><P |
162 | ><A |
163 | HREF="sdlconvertsurface.html" |
164 | ><TT |
165 | CLASS="FUNCTION" |
166 | >SDL_ConvertSurface</TT |
167 | ></A |
168 | >, |
169 | <A |
170 | HREF="sdldisplayformatalpha.html" |
171 | ><TT |
172 | CLASS="FUNCTION" |
173 | >SDL_DisplayFormatAlpha</TT |
174 | ></A |
175 | > |
176 | <A |
177 | HREF="sdlsetalpha.html" |
178 | ><TT |
179 | CLASS="FUNCTION" |
180 | >SDL_SetAlpha</TT |
181 | ></A |
182 | >, |
183 | <A |
184 | HREF="sdlsetcolorkey.html" |
185 | ><TT |
186 | CLASS="FUNCTION" |
187 | >SDL_SetColorKey</TT |
188 | ></A |
189 | >, |
190 | <A |
191 | HREF="sdlsurface.html" |
192 | ><SPAN |
193 | CLASS="STRUCTNAME" |
194 | >SDL_Surface</SPAN |
195 | ></A |
196 | ></P |
197 | ></DIV |
198 | ><DIV |
199 | CLASS="NAVFOOTER" |
200 | ><HR |
201 | ALIGN="LEFT" |
202 | WIDTH="100%"><TABLE |
203 | SUMMARY="Footer navigation table" |
204 | WIDTH="100%" |
205 | BORDER="0" |
206 | CELLPADDING="0" |
207 | CELLSPACING="0" |
208 | ><TR |
209 | ><TD |
210 | WIDTH="33%" |
211 | ALIGN="left" |
212 | VALIGN="top" |
213 | ><A |
214 | HREF="sdlfillrect.html" |
215 | ACCESSKEY="P" |
216 | >Prev</A |
217 | ></TD |
218 | ><TD |
219 | WIDTH="34%" |
220 | ALIGN="center" |
221 | VALIGN="top" |
222 | ><A |
223 | HREF="index.html" |
224 | ACCESSKEY="H" |
225 | >Home</A |
226 | ></TD |
227 | ><TD |
228 | WIDTH="33%" |
229 | ALIGN="right" |
230 | VALIGN="top" |
231 | ><A |
232 | HREF="sdldisplayformatalpha.html" |
233 | ACCESSKEY="N" |
234 | >Next</A |
235 | ></TD |
236 | ></TR |
237 | ><TR |
238 | ><TD |
239 | WIDTH="33%" |
240 | ALIGN="left" |
241 | VALIGN="top" |
242 | >SDL_FillRect</TD |
243 | ><TD |
244 | WIDTH="34%" |
245 | ALIGN="center" |
246 | VALIGN="top" |
247 | ><A |
248 | HREF="video.html" |
249 | ACCESSKEY="U" |
250 | >Up</A |
251 | ></TD |
252 | ><TD |
253 | WIDTH="33%" |
254 | ALIGN="right" |
255 | VALIGN="top" |
256 | >SDL_DisplayFormatAlpha</TD |
257 | ></TR |
258 | ></TABLE |
259 | ></DIV |
260 | ></BODY |
261 | ></HTML |
262 | > |