Mercurial > sdl-ios-xcode
annotate docs/html/sdlsetvideomode.html @ 769:b8d311d90021
Updated copyright information for 2004 (Happy New Year!)
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sun, 04 Jan 2004 16:49:27 +0000 |
| parents | e5bc29de3f0a |
| children | 355632dca928 |
| rev | line source |
|---|---|
| 0 | 1 <HTML |
| 2 ><HEAD | |
| 3 ><TITLE | |
| 4 >SDL_SetVideoMode</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_VideoModeOK" | |
| 17 HREF="sdlvideomodeok.html"><LINK | |
| 18 REL="NEXT" | |
| 19 TITLE="SDL_UpdateRect" | |
| 20 HREF="sdlupdaterect.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="sdlvideomodeok.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="sdlupdaterect.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="SDLSETVIDEOMODE" | |
| 71 >SDL_SetVideoMode</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="AEN856" |
| 0 | 77 ></A |
| 78 ><H2 | |
| 79 >Name</H2 | |
| 80 >SDL_SetVideoMode -- Set up a video mode with the specified width, height and bits-per-pixel.</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="AEN859" |
| 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="AEN860" |
| 0 | 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_SetVideoMode</B | |
| 105 ></CODE | |
| 106 >(int width, int height, int bpp, 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="AEN866" |
| 0 | 116 ></A |
| 117 ><H2 | |
| 118 >Description</H2 | |
| 119 ><P | |
| 120 >Set up a video mode with the specified width, height and bits-per-pixel.</P | |
| 121 ><P | |
| 122 >If <TT | |
| 123 CLASS="PARAMETER" | |
| 124 ><I | |
| 125 >bpp</I | |
| 126 ></TT | |
| 127 > is 0, it is treated as the | |
| 128 current display bits per pixel.</P | |
| 129 ><P | |
| 130 >The <TT | |
| 131 CLASS="PARAMETER" | |
| 132 ><I | |
| 133 >flags</I | |
| 134 ></TT | |
| 135 > parameter is the same as the <TT | |
| 136 CLASS="STRUCTFIELD" | |
| 137 ><I | |
| 138 >flags</I | |
| 139 ></TT | |
| 140 > field of the <A | |
| 141 HREF="sdlsurface.html" | |
| 142 ><SPAN | |
| 143 CLASS="STRUCTNAME" | |
| 144 >SDL_Surface</SPAN | |
| 145 ></A | |
| 146 > structure. OR'd combinations of the following values are valid.</P | |
| 147 ><DIV | |
| 148 CLASS="INFORMALTABLE" | |
| 149 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
150 NAME="AEN876" |
| 0 | 151 ></A |
| 152 ><P | |
| 153 ></P | |
| 154 ><TABLE | |
| 155 BORDER="1" | |
| 156 CLASS="CALSTABLE" | |
| 157 ><TBODY | |
| 158 ><TR | |
| 159 ><TD | |
| 160 ALIGN="LEFT" | |
| 161 VALIGN="TOP" | |
| 162 ><TT | |
| 163 CLASS="LITERAL" | |
| 164 >SDL_SWSURFACE</TT | |
| 165 ></TD | |
| 166 ><TD | |
| 167 ALIGN="LEFT" | |
| 168 VALIGN="TOP" | |
| 169 >Create the video surface in system memory</TD | |
| 170 ></TR | |
| 171 ><TR | |
| 172 ><TD | |
| 173 ALIGN="LEFT" | |
| 174 VALIGN="TOP" | |
| 175 ><TT | |
| 176 CLASS="LITERAL" | |
| 177 >SDL_HWSURFACE</TT | |
| 178 ></TD | |
| 179 ><TD | |
| 180 ALIGN="LEFT" | |
| 181 VALIGN="TOP" | |
| 182 >Create the video surface in video memory</TD | |
| 183 ></TR | |
| 184 ><TR | |
| 185 ><TD | |
| 186 ALIGN="LEFT" | |
| 187 VALIGN="TOP" | |
| 188 ><TT | |
| 189 CLASS="LITERAL" | |
| 190 >SDL_ASYNCBLIT</TT | |
| 191 ></TD | |
| 192 ><TD | |
| 193 ALIGN="LEFT" | |
| 194 VALIGN="TOP" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
195 >Enables the use of asynchronous updates of the display surface. This will |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
196 usually slow down blitting on single CPU machines, but may provide a speed |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
197 increase on SMP systems.</TD |
| 0 | 198 ></TR |
| 199 ><TR | |
| 200 ><TD | |
| 201 ALIGN="LEFT" | |
| 202 VALIGN="TOP" | |
| 203 ><TT | |
| 204 CLASS="LITERAL" | |
| 205 >SDL_ANYFORMAT</TT | |
| 206 ></TD | |
| 207 ><TD | |
| 208 ALIGN="LEFT" | |
| 209 VALIGN="TOP" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
210 >Normally, if a video surface of the requested bits-per-pixel (<TT |
| 0 | 211 CLASS="PARAMETER" |
| 212 ><I | |
| 213 >bpp</I | |
| 214 ></TT | |
| 215 >) is not available, SDL will emulate one with a shadow surface. Passing <TT | |
| 216 CLASS="LITERAL" | |
| 217 >SDL_ANYFORMAT</TT | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
218 > prevents this and causes SDL to use the video surface, regardless of its pixel depth.</TD |
| 0 | 219 ></TR |
| 220 ><TR | |
| 221 ><TD | |
| 222 ALIGN="LEFT" | |
| 223 VALIGN="TOP" | |
| 224 ><TT | |
| 225 CLASS="LITERAL" | |
| 226 >SDL_HWPALETTE</TT | |
| 227 ></TD | |
| 228 ><TD | |
| 229 ALIGN="LEFT" | |
| 230 VALIGN="TOP" | |
| 231 >Give SDL exclusive palette access. Without this flag you may not always get the the colors you request with <A | |
| 232 HREF="sdlsetcolors.html" | |
| 233 ><TT | |
| 234 CLASS="FUNCTION" | |
| 235 >SDL_SetColors</TT | |
| 236 ></A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
237 > or <A |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
238 HREF="sdlsetpalette.html" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
239 ><TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
240 CLASS="FUNCTION" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
241 >SDL_SetPalette</TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
242 ></A |
| 0 | 243 >.</TD |
| 244 ></TR | |
| 245 ><TR | |
| 246 ><TD | |
| 247 ALIGN="LEFT" | |
| 248 VALIGN="TOP" | |
| 249 ><TT | |
| 250 CLASS="LITERAL" | |
| 251 >SDL_DOUBLEBUF</TT | |
| 252 ></TD | |
| 253 ><TD | |
| 254 ALIGN="LEFT" | |
| 255 VALIGN="TOP" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
256 >Enable hardware double buffering; only valid with SDL_HWSURFACE. Calling |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
257 <A |
| 0 | 258 HREF="sdlflip.html" |
| 259 ><TT | |
| 260 CLASS="FUNCTION" | |
| 261 >SDL_Flip</TT | |
| 262 ></A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
263 > will flip the |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
264 buffers and update the screen. All drawing will take place on the surface |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
265 that is not displayed at the moment. If double buffering could not be enabled |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
266 then <TT |
| 0 | 267 CLASS="FUNCTION" |
| 268 >SDL_Flip</TT | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
269 > will just perform a |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
270 <A |
| 0 | 271 HREF="sdlupdaterect.html" |
| 272 ><TT | |
| 273 CLASS="FUNCTION" | |
| 274 >SDL_UpdateRect</TT | |
| 275 ></A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
276 > |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
277 on the entire screen.</TD |
| 0 | 278 ></TR |
| 279 ><TR | |
| 280 ><TD | |
| 281 ALIGN="LEFT" | |
| 282 VALIGN="TOP" | |
| 283 ><TT | |
| 284 CLASS="LITERAL" | |
| 285 >SDL_FULLSCREEN</TT | |
| 286 ></TD | |
| 287 ><TD | |
| 288 ALIGN="LEFT" | |
| 289 VALIGN="TOP" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
290 >SDL will attempt to use a fullscreen mode. If a hardware resolution change is |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
291 not possible (for whatever reason), the next higher resolution will be used and |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
292 the display window centered on a black background.</TD |
| 0 | 293 ></TR |
| 294 ><TR | |
| 295 ><TD | |
| 296 ALIGN="LEFT" | |
| 297 VALIGN="TOP" | |
| 298 ><TT | |
| 299 CLASS="LITERAL" | |
| 300 >SDL_OPENGL</TT | |
| 301 ></TD | |
| 302 ><TD | |
| 303 ALIGN="LEFT" | |
| 304 VALIGN="TOP" | |
| 305 >Create an OpenGL rendering context. You should have previously set OpenGL video attributes with <A | |
| 306 HREF="sdlglsetattribute.html" | |
| 307 ><TT | |
| 308 CLASS="FUNCTION" | |
| 309 >SDL_GL_SetAttribute</TT | |
| 310 ></A | |
| 311 >.</TD | |
| 312 ></TR | |
| 313 ><TR | |
| 314 ><TD | |
| 315 ALIGN="LEFT" | |
| 316 VALIGN="TOP" | |
| 317 ><TT | |
| 318 CLASS="LITERAL" | |
| 319 >SDL_OPENGLBLIT</TT | |
| 320 ></TD | |
| 321 ><TD | |
| 322 ALIGN="LEFT" | |
| 323 VALIGN="TOP" | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
324 >Create an OpenGL rendering context, like above, but allow normal blitting |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
325 operations. The screen (2D) surface may have an alpha channel, and |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
326 <A |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
327 HREF="sdlupdaterects.html" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
328 ><TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
329 CLASS="FUNCTION" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
330 >SDL_UpdateRects</TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
331 ></A |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
332 > |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
333 must be used for updating changes to the screen surface.</TD |
| 0 | 334 ></TR |
| 335 ><TR | |
| 336 ><TD | |
| 337 ALIGN="LEFT" | |
| 338 VALIGN="TOP" | |
| 339 ><TT | |
| 340 CLASS="LITERAL" | |
| 341 >SDL_RESIZABLE</TT | |
| 342 ></TD | |
| 343 ><TD | |
| 344 ALIGN="LEFT" | |
| 345 VALIGN="TOP" | |
| 346 >Create a resizable window. When the window is resized by the user a <A | |
| 347 HREF="sdlresizeevent.html" | |
| 348 ><TT | |
| 349 CLASS="LITERAL" | |
| 350 >SDL_VIDEORESIZE</TT | |
| 351 ></A | |
| 352 > event is generated and <TT | |
| 353 CLASS="FUNCTION" | |
| 354 >SDL_SetVideoMode</TT | |
| 355 > can be called again with the new size.</TD | |
| 356 ></TR | |
| 357 ><TR | |
| 358 ><TD | |
| 359 ALIGN="LEFT" | |
| 360 VALIGN="TOP" | |
| 361 ><TT | |
| 362 CLASS="LITERAL" | |
| 363 >SDL_NOFRAME</TT | |
| 364 ></TD | |
| 365 ><TD | |
| 366 ALIGN="LEFT" | |
| 367 VALIGN="TOP" | |
| 368 >If possible, <TT | |
| 369 CLASS="LITERAL" | |
| 370 >SDL_NOFRAME</TT | |
| 371 > causes SDL to create a window with no title bar or frame decoration. Fullscreen modes automatically have this flag set.</TD | |
| 372 ></TR | |
| 373 ></TBODY | |
| 374 ></TABLE | |
| 375 ><P | |
| 376 ></P | |
| 377 ></DIV | |
| 378 ><DIV | |
| 379 CLASS="NOTE" | |
| 380 ><BLOCKQUOTE | |
| 381 CLASS="NOTE" | |
| 382 ><P | |
| 383 ><B | |
| 384 >Note: </B | |
| 385 >Whatever <TT | |
| 386 CLASS="PARAMETER" | |
| 387 ><I | |
| 388 >flags</I | |
| 389 ></TT | |
| 390 > <TT | |
| 391 CLASS="FUNCTION" | |
| 392 >SDL_SetVideoMode</TT | |
| 393 > could satisfy are set in the <TT | |
| 394 CLASS="STRUCTFIELD" | |
| 395 ><I | |
| 396 >flags</I | |
| 397 ></TT | |
| 398 > member of the returned surface.</P | |
| 399 ></BLOCKQUOTE | |
| 400 ></DIV | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
401 ><DIV |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
402 CLASS="NOTE" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
403 ><BLOCKQUOTE |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
404 CLASS="NOTE" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
405 ><P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
406 ><B |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
407 >Note: </B |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
408 >The <TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
409 CLASS="PARAMETER" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
410 ><I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
411 >bpp</I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
412 ></TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
413 > parameter is the number of bits per pixel, |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
414 so a <TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
415 CLASS="PARAMETER" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
416 ><I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
417 >bpp</I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
418 ></TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
419 > of 24 uses the packed representation of |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
420 3 bytes/pixel. For the more common 4 bytes/pixel mode, use a |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
421 <TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
422 CLASS="PARAMETER" |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
423 ><I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
424 >bpp</I |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
425 ></TT |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
426 > of 32. Somewhat oddly, both 15 and 16 will |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
427 request a 2 bytes/pixel mode, but different pixel formats.</P |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
428 ></BLOCKQUOTE |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
429 ></DIV |
| 0 | 430 ></DIV |
| 431 ><DIV | |
| 432 CLASS="REFSECT1" | |
| 433 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
434 NAME="AEN952" |
| 0 | 435 ></A |
| 436 ><H2 | |
| 437 >Return Value</H2 | |
| 438 ><P | |
| 439 >The framebuffer surface, or <SPAN | |
| 440 CLASS="RETURNVALUE" | |
| 441 >NULL</SPAN | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
442 > if it fails. |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
443 The surface returned is freed by SDL_Quit() and should nt be freed by |
|
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
444 the caller.</P |
| 0 | 445 ></DIV |
| 446 ><DIV | |
| 447 CLASS="REFSECT1" | |
| 448 ><A | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
449 NAME="AEN956" |
| 0 | 450 ></A |
| 451 ><H2 | |
| 452 >See Also</H2 | |
| 453 ><P | |
| 454 ><A | |
| 455 HREF="sdllocksurface.html" | |
| 456 ><TT | |
| 457 CLASS="FUNCTION" | |
| 458 >SDL_LockSurface</TT | |
| 459 ></A | |
| 460 >, | |
| 461 <A | |
| 462 HREF="sdlsetcolors.html" | |
| 463 ><TT | |
| 464 CLASS="FUNCTION" | |
| 465 >SDL_SetColors</TT | |
| 466 ></A | |
| 467 >, | |
| 468 <A | |
| 469 HREF="sdlflip.html" | |
| 470 ><TT | |
| 471 CLASS="FUNCTION" | |
| 472 >SDL_Flip</TT | |
| 473 ></A | |
| 474 >, | |
| 475 <A | |
| 476 HREF="sdlsurface.html" | |
| 477 ><SPAN | |
| 478 CLASS="STRUCTNAME" | |
| 479 >SDL_Surface</SPAN | |
| 480 ></A | |
| 481 ></P | |
| 482 ></DIV | |
| 483 ><DIV | |
| 484 CLASS="NAVFOOTER" | |
| 485 ><HR | |
| 486 ALIGN="LEFT" | |
| 487 WIDTH="100%"><TABLE | |
| 488 WIDTH="100%" | |
| 489 BORDER="0" | |
| 490 CELLPADDING="0" | |
| 491 CELLSPACING="0" | |
| 492 ><TR | |
| 493 ><TD | |
| 494 WIDTH="33%" | |
| 495 ALIGN="left" | |
| 496 VALIGN="top" | |
| 497 ><A | |
| 498 HREF="sdlvideomodeok.html" | |
| 499 >Prev</A | |
| 500 ></TD | |
| 501 ><TD | |
| 502 WIDTH="34%" | |
| 503 ALIGN="center" | |
| 504 VALIGN="top" | |
| 505 ><A | |
| 506 HREF="index.html" | |
| 507 >Home</A | |
| 508 ></TD | |
| 509 ><TD | |
| 510 WIDTH="33%" | |
| 511 ALIGN="right" | |
| 512 VALIGN="top" | |
| 513 ><A | |
| 514 HREF="sdlupdaterect.html" | |
| 515 >Next</A | |
| 516 ></TD | |
| 517 ></TR | |
| 518 ><TR | |
| 519 ><TD | |
| 520 WIDTH="33%" | |
| 521 ALIGN="left" | |
| 522 VALIGN="top" | |
| 523 >SDL_VideoModeOK</TD | |
| 524 ><TD | |
| 525 WIDTH="34%" | |
| 526 ALIGN="center" | |
| 527 VALIGN="top" | |
| 528 ><A | |
| 529 HREF="video.html" | |
| 530 >Up</A | |
| 531 ></TD | |
| 532 ><TD | |
| 533 WIDTH="33%" | |
| 534 ALIGN="right" | |
| 535 VALIGN="top" | |
| 536 >SDL_UpdateRect</TD | |
| 537 ></TR | |
| 538 ></TABLE | |
| 539 ></DIV | |
| 540 ></BODY | |
| 541 ></HTML | |
| 542 > |