Mercurial > sdl-ios-xcode

comparison docs/html/sdldisplayformat.html @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_DisplayFormat</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.61
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 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 >SDL Library Documentation</TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="sdlfillrect.html"
48 >Prev</A
49 ></TD
50 ><TD
51 WIDTH="80%"
52 ALIGN="center"
53 VALIGN="bottom"
54 ></TD
55 ><TD
56 WIDTH="10%"
57 ALIGN="right"
58 VALIGN="bottom"
59 ><A
60 HREF="sdldisplayformatalpha.html"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><H1
69 ><A
70 NAME="SDLDISPLAYFORMAT"
71 >SDL_DisplayFormat</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN1898"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_DisplayFormat&nbsp;--&nbsp;Convert a surface to the display format</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN1901"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN1902"
92 ></A
93 ><P
94 ></P
95 ><PRE
96 CLASS="FUNCSYNOPSISINFO"
97 >#include "SDL.h"</PRE
98 ><P
99 ><CODE
100 ><CODE
101 CLASS="FUNCDEF"
102 >SDL_Surface *<B
103 CLASS="FSFUNC"
104 >SDL_DisplayFormat</B
105 ></CODE
106 >(SDL_Surface *surface);</CODE
107 ></P
108 ><P
109 ></P
110 ></DIV
111 ></DIV
112 ><DIV
113 CLASS="REFSECT1"
114 ><A
115 NAME="AEN1908"
116 ></A
117 ><H2
118 >Description</H2
119 ><P
120 >This function takes a surface and copies it to a new surface of the
121 pixel format and colors of the video framebuffer, suitable for fast
122 blitting onto the display surface. It calls
123 <A
124 HREF="sdlconvertsurface.html"
125 >SDL_ConvertSurface</A
126 ></P
127 ><P
128 >If you want to take advantage of hardware colorkey or alpha blit
129 acceleration, you should set the colorkey and alpha value before
130 calling this function.</P
131 ><P
132 >If you want an alpha channel, see <A
133 HREF="sdldisplayformatalpha.html"
134 >SDL_DisplayFormatAlpha</A
135 >.</P
136 ></DIV
137 ><DIV
138 CLASS="REFSECT1"
139 ><A
140 NAME="AEN1915"
141 ></A
142 ><H2
143 >Return Value</H2
144 ><P
145 >If the conversion fails or runs out of memory, it returns
146 <SPAN
147 CLASS="RETURNVALUE"
148 >NULL</SPAN
149 ></P
150 ></DIV
151 ><DIV
152 CLASS="REFSECT1"
153 ><A
154 NAME="AEN1919"
155 ></A
156 ><H2
157 >See Also</H2
158 ><P
159 ><A
160 HREF="sdlconvertsurface.html"
161 ><TT
162 CLASS="FUNCTION"
163 >SDL_ConvertSurface</TT
164 ></A
165 >,
166 <A
167 HREF="sdldisplayformatalpha.html"
168 ><TT
169 CLASS="FUNCTION"
170 >SDL_DisplayFormatAlpha</TT
171 ></A
172 >
173 <A
174 HREF="sdlsetalpha.html"
175 ><TT
176 CLASS="FUNCTION"
177 >SDL_SetAlpha</TT
178 ></A
179 >,
180 <A
181 HREF="sdlsetcolorkey.html"
182 ><TT
183 CLASS="FUNCTION"
184 >SDL_SetColorKey</TT
185 ></A
186 >,
187 <A
188 HREF="sdlsurface.html"
189 ><SPAN
190 CLASS="STRUCTNAME"
191 >SDL_Surface</SPAN
192 ></A
193 ></P
194 ></DIV
195 ><DIV
196 CLASS="NAVFOOTER"
197 ><HR
198 ALIGN="LEFT"
199 WIDTH="100%"><TABLE
200 WIDTH="100%"
201 BORDER="0"
202 CELLPADDING="0"
203 CELLSPACING="0"
204 ><TR
205 ><TD
206 WIDTH="33%"
207 ALIGN="left"
208 VALIGN="top"
209 ><A
210 HREF="sdlfillrect.html"
211 >Prev</A
212 ></TD
213 ><TD
214 WIDTH="34%"
215 ALIGN="center"
216 VALIGN="top"
217 ><A
218 HREF="index.html"
219 >Home</A
220 ></TD
221 ><TD
222 WIDTH="33%"
223 ALIGN="right"
224 VALIGN="top"
225 ><A
226 HREF="sdldisplayformatalpha.html"
227 >Next</A
228 ></TD
229 ></TR
230 ><TR
231 ><TD
232 WIDTH="33%"
233 ALIGN="left"
234 VALIGN="top"
235 >SDL_FillRect</TD
236 ><TD
237 WIDTH="34%"
238 ALIGN="center"
239 VALIGN="top"
240 ><A
241 HREF="video.html"
242 >Up</A
243 ></TD
244 ><TD
245 WIDTH="33%"
246 ALIGN="right"
247 VALIGN="top"
248 >SDL_DisplayFormatAlpha</TD
249 ></TR
250 ></TABLE
251 ></DIV
252 ></BODY
253 ></HTML
254 >