Mercurial > sdl-ios-xcode
annotate docs/html/sdlconvertsurface.html @ 353:d47637068e52
The documented error return value for SDL_WaitEvent() is 0.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 15 Apr 2002 04:53:41 +0000 |
| parents | e5bc29de3f0a |
| children | 355632dca928 |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_ConvertSurface</TITLE | |
| 5 ><META | |
| 6 NAME="GENERATOR" | |
|
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
| 0 | 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_GetClipRect" | |
| 17 HREF="sdlgetcliprect.html"><LINK | |
| 18 REL="NEXT" | |
| 19 TITLE="SDL_BlitSurface" | |
| 20 HREF="sdlblitsurface.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="sdlgetcliprect.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="sdlblitsurface.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="SDLCONVERTSURFACE" | |
| 71 >SDL_ConvertSurface</A | |
| 72 ></H1 | |
| 73 ><DIV | |
| 74 CLASS="REFNAMEDIV" | |
| 75 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN1874" |
| 0 | 77 ></A |
| 78 ><H2 | |
| 79 >Name</H2 | |
| 80 >SDL_ConvertSurface -- Converts a surface to the same format as another surface.</DIV | |
| 81 ><DIV | |
| 82 CLASS="REFSYNOPSISDIV" | |
| 83 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN1877" |
| 0 | 85 ></A |
| 86 ><H2 | |
| 87 >Synopsis</H2 | |
| 88 ><DIV | |
| 89 CLASS="FUNCSYNOPSIS" | |
| 90 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN1878" |
| 0 | 92 ></A |
| 93 ><P | |
| 94 ></P | |
| 95 ><PRE | |
| 96 CLASS="FUNCSYNOPSISINFO" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
97 >#include "SDL/SDL.h"</PRE |
| 0 | 98 ><P |
| 99 ><CODE | |
| 100 ><CODE | |
| 101 CLASS="FUNCDEF" | |
| 102 >SDL_Surface *<B | |
| 103 CLASS="FSFUNC" | |
| 104 >SDL_ConvertSurface</B | |
| 105 ></CODE | |
| 106 >(SDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags);</CODE | |
| 107 ></P | |
| 108 ><P | |
| 109 ></P | |
| 110 ></DIV | |
| 111 ></DIV | |
| 112 ><DIV | |
| 113 CLASS="REFSECT1" | |
| 114 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN1884" |
| 0 | 116 ></A |
| 117 ><H2 | |
| 118 >Description</H2 | |
| 119 ><P | |
| 120 >Creates a new surface of the specified format, and then copies and maps | |
| 121 the given surface to it. If this function fails, it returns | |
| 122 <TT | |
| 123 CLASS="LITERAL" | |
| 124 >NULL</TT | |
| 125 >.</P | |
| 126 ><P | |
| 127 >The <TT | |
| 128 CLASS="PARAMETER" | |
| 129 ><I | |
| 130 >flags</I | |
| 131 ></TT | |
| 132 > parameter is passed to | |
| 133 <A | |
| 134 HREF="sdlcreatergbsurface.html" | |
| 135 ><TT | |
| 136 CLASS="FUNCTION" | |
| 137 >SDL_CreateRGBSurface</TT | |
| 138 ></A | |
| 139 > | |
| 140 and has those semantics.</P | |
| 141 ><P | |
| 142 >This function is used internally by | |
| 143 <A | |
| 144 HREF="sdldisplayformat.html" | |
| 145 ><TT | |
| 146 CLASS="FUNCTION" | |
| 147 >SDL_DisplayFormat</TT | |
| 148 ></A | |
| 149 >.</P | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
150 ><P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
151 >This function can only be called after SDL_Init.</P |
| 0 | 152 ></DIV |
| 153 ><DIV | |
| 154 CLASS="REFSECT1" | |
| 155 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
156 NAME="AEN1896" |
| 0 | 157 ></A |
| 158 ><H2 | |
| 159 >Return Value</H2 | |
| 160 ><P | |
| 161 >Returns either a pointer to the new surface, or | |
| 162 <TT | |
| 163 CLASS="LITERAL" | |
| 164 >NULL</TT | |
| 165 > on error.</P | |
| 166 ></DIV | |
| 167 ><DIV | |
| 168 CLASS="REFSECT1" | |
| 169 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
170 NAME="AEN1900" |
| 0 | 171 ></A |
| 172 ><H2 | |
| 173 >See Also</H2 | |
| 174 ><P | |
| 175 ><A | |
| 176 HREF="sdlcreatergbsurface.html" | |
| 177 ><TT | |
| 178 CLASS="FUNCTION" | |
| 179 >SDL_CreateRGBSurface</TT | |
| 180 ></A | |
| 181 >, | |
| 182 <A | |
| 183 HREF="sdldisplayformat.html" | |
| 184 ><TT | |
| 185 CLASS="FUNCTION" | |
| 186 >SDL_DisplayFormat</TT | |
| 187 ></A | |
| 188 >, | |
| 189 <A | |
| 190 HREF="sdlpixelformat.html" | |
| 191 ><SPAN | |
| 192 CLASS="STRUCTNAME" | |
| 193 >SDL_PixelFormat</SPAN | |
| 194 ></A | |
| 195 >, | |
| 196 <A | |
| 197 HREF="sdlsurface.html" | |
| 198 ><SPAN | |
| 199 CLASS="STRUCTNAME" | |
| 200 >SDL_Surface</SPAN | |
| 201 ></A | |
| 202 ></P | |
| 203 ></DIV | |
| 204 ><DIV | |
| 205 CLASS="NAVFOOTER" | |
| 206 ><HR | |
| 207 ALIGN="LEFT" | |
| 208 WIDTH="100%"><TABLE | |
| 209 WIDTH="100%" | |
| 210 BORDER="0" | |
| 211 CELLPADDING="0" | |
| 212 CELLSPACING="0" | |
| 213 ><TR | |
| 214 ><TD | |
| 215 WIDTH="33%" | |
| 216 ALIGN="left" | |
| 217 VALIGN="top" | |
| 218 ><A | |
| 219 HREF="sdlgetcliprect.html" | |
| 220 >Prev</A | |
| 221 ></TD | |
| 222 ><TD | |
| 223 WIDTH="34%" | |
| 224 ALIGN="center" | |
| 225 VALIGN="top" | |
| 226 ><A | |
| 227 HREF="index.html" | |
| 228 >Home</A | |
| 229 ></TD | |
| 230 ><TD | |
| 231 WIDTH="33%" | |
| 232 ALIGN="right" | |
| 233 VALIGN="top" | |
| 234 ><A | |
| 235 HREF="sdlblitsurface.html" | |
| 236 >Next</A | |
| 237 ></TD | |
| 238 ></TR | |
| 239 ><TR | |
| 240 ><TD | |
| 241 WIDTH="33%" | |
| 242 ALIGN="left" | |
| 243 VALIGN="top" | |
| 244 >SDL_GetClipRect</TD | |
| 245 ><TD | |
| 246 WIDTH="34%" | |
| 247 ALIGN="center" | |
| 248 VALIGN="top" | |
| 249 ><A | |
| 250 HREF="video.html" | |
| 251 >Up</A | |
| 252 ></TD | |
| 253 ><TD | |
| 254 WIDTH="33%" | |
| 255 ALIGN="right" | |
| 256 VALIGN="top" | |
| 257 >SDL_BlitSurface</TD | |
| 258 ></TR | |
| 259 ></TABLE | |
| 260 ></DIV | |
| 261 ></BODY | |
| 262 ></HTML | |
| 263 > |