Mercurial > sdl-ios-xcode

comparison docs/html/sdldisplayformatalpha.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_DisplayFormatAlpha</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_DisplayFormat"
17 HREF="sdldisplayformat.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_WarpMouse"
20 HREF="sdlwarpmouse.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="sdldisplayformat.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="sdlwarpmouse.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="SDLDISPLAYFORMATALPHA"
71 >SDL_DisplayFormatAlpha</A
72 ></H1
73 ><DIV
74 CLASS="REFNAMEDIV"
75 ><A
76 NAME="AEN1936"
77 ></A
78 ><H2
79 >Name</H2
80 >SDL_DisplayFormatAlpha&nbsp;--&nbsp;Convert a surface to the display format</DIV
81 ><DIV
82 CLASS="REFSYNOPSISDIV"
83 ><A
84 NAME="AEN1939"
85 ></A
86 ><H2
87 >Synopsis</H2
88 ><DIV
89 CLASS="FUNCSYNOPSIS"
90 ><A
91 NAME="AEN1940"
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_DisplayFormatAlpha</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="AEN1946"
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 plus an alpha channel,
122 suitable for fast 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 ></DIV
132 ><DIV
133 CLASS="REFSECT1"
134 ><A
135 NAME="AEN1951"
136 ></A
137 ><H2
138 >Return Value</H2
139 ><P
140 >If the conversion fails or runs out of memory, it returns
141 <SPAN
142 CLASS="RETURNVALUE"
143 >NULL</SPAN
144 ></P
145 ></DIV
146 ><DIV
147 CLASS="REFSECT1"
148 ><A
149 NAME="AEN1955"
150 ></A
151 ><H2
152 >See Also</H2
153 ><P
154 ><A
155 HREF="sdlconvertsurface.html"
156 >SDL_ConvertSurface</A
157 >,
158 <A
159 HREF="sdlsetalpha.html"
160 >SDL_SetAlpha</A
161 >,
162 <A
163 HREF="sdlsetcolorkey.html"
164 >SDL_SetColorKey</A
165 >,
166 <A
167 HREF="sdldisplayformat.html"
168 >SDL_DisplayFormat</A
169 >,
170 <A
171 HREF="sdlsurface.html"
172 >SDL_Surface</A
173 ></P
174 ></DIV
175 ><DIV
176 CLASS="NAVFOOTER"
177 ><HR
178 ALIGN="LEFT"
179 WIDTH="100%"><TABLE
180 WIDTH="100%"
181 BORDER="0"
182 CELLPADDING="0"
183 CELLSPACING="0"
184 ><TR
185 ><TD
186 WIDTH="33%"
187 ALIGN="left"
188 VALIGN="top"
189 ><A
190 HREF="sdldisplayformat.html"
191 >Prev</A
192 ></TD
193 ><TD
194 WIDTH="34%"
195 ALIGN="center"
196 VALIGN="top"
197 ><A
198 HREF="index.html"
199 >Home</A
200 ></TD
201 ><TD
202 WIDTH="33%"
203 ALIGN="right"
204 VALIGN="top"
205 ><A
206 HREF="sdlwarpmouse.html"
207 >Next</A
208 ></TD
209 ></TR
210 ><TR
211 ><TD
212 WIDTH="33%"
213 ALIGN="left"
214 VALIGN="top"
215 >SDL_DisplayFormat</TD
216 ><TD
217 WIDTH="34%"
218 ALIGN="center"
219 VALIGN="top"
220 ><A
221 HREF="video.html"
222 >Up</A
223 ></TD
224 ><TD
225 WIDTH="33%"
226 ALIGN="right"
227 VALIGN="top"
228 >SDL_WarpMouse</TD
229 ></TR
230 ></TABLE
231 ></DIV
232 ></BODY
233 ></HTML
234 >