Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 5131 | clevermous | 1 | |
| 2 | > |
||
| 3 | > |
||
| 4 | >SDL_Surface |
||
| 5 | > |
||
| 6 | NAME="GENERATOR" |
||
| 7 | CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
||
| 8 | "> |
||
| 9 | REL="HOME" |
||
| 10 | TITLE="SDL Library Documentation" |
||
| 11 | HREF="index.html"> |
||
| 12 | REL="UP" |
||
| 13 | TITLE="Video" |
||
| 14 | HREF="video.html"> |
||
| 15 | REL="PREVIOUS" |
||
| 16 | TITLE="SDL_PixelFormat" |
||
| 17 | HREF="sdlpixelformat.html"> |
||
| 18 | REL="NEXT" |
||
| 19 | TITLE="SDL_VideoInfo" |
||
| 20 | HREF="sdlvideoinfo.html"> |
||
| 21 | > |
||
| 22 | CLASS="REFENTRY" |
||
| 23 | BGCOLOR="#FFF8DC" |
||
| 24 | TEXT="#000000" |
||
| 25 | LINK="#0000ee" |
||
| 26 | VLINK="#551a8b" |
||
| 27 | ALINK="#ff0000" |
||
| 28 | > |
||
| 29 | CLASS="NAVHEADER" |
||
| 30 | > |
||
| 31 | WIDTH="100%" |
||
| 32 | BORDER="0" |
||
| 33 | CELLPADDING="0" |
||
| 34 | CELLSPACING="0" |
||
| 35 | > |
||
| 36 | > |
||
| 37 | COLSPAN="3" |
||
| 38 | ALIGN="center" |
||
| 39 | >SDL Library Documentation |
||
| 40 | > |
||
| 41 | > |
||
| 42 | > |
||
| 43 | WIDTH="10%" |
||
| 44 | ALIGN="left" |
||
| 45 | VALIGN="bottom" |
||
| 46 | > |
||
| 47 | HREF="sdlpixelformat.html" |
||
| 48 | >Prev |
||
| 49 | > |
||
| 50 | > |
||
| 51 | WIDTH="80%" |
||
| 52 | ALIGN="center" |
||
| 53 | VALIGN="bottom" |
||
| 54 | > |
||
| 55 | > |
||
| 56 | WIDTH="10%" |
||
| 57 | ALIGN="right" |
||
| 58 | VALIGN="bottom" |
||
| 59 | > |
||
| 60 | HREF="sdlvideoinfo.html" |
||
| 61 | >Next |
||
| 62 | > |
||
| 63 | > |
||
| 64 | > |
||
| 65 | > |
||
| 66 | ALIGN="LEFT" |
||
| 67 | WIDTH="100%"> |
||
| 68 | > |
||
| 69 | > |
||
| 70 | NAME="SDLSURFACE" |
||
| 71 | >SDL_Surface |
||
| 72 | > |
||
| 73 | > |
||
| 74 | CLASS="REFNAMEDIV" |
||
| 75 | > |
||
| 76 | NAME="AEN2841" |
||
| 77 | > |
||
| 78 | > |
||
| 79 | >Name |
||
| 80 | >SDL_Surface -- Graphical Surface Structure |
||
| 81 | > |
||
| 82 | CLASS="REFSECT1" |
||
| 83 | > |
||
| 84 | NAME="AEN2844" |
||
| 85 | > |
||
| 86 | > |
||
| 87 | >Structure Definition |
||
| 88 | > |
||
| 89 | CLASS="PROGRAMLISTING" |
||
| 90 | >typedef struct SDL_Surface { |
||
| 91 | Uint32 flags; /* Read-only */ |
||
| 92 | SDL_PixelFormat *format; /* Read-only */ |
||
| 93 | int w, h; /* Read-only */ |
||
| 94 | Uint16 pitch; /* Read-only */ |
||
| 95 | void *pixels; /* Read-write */ |
||
| 96 | |||
| 97 | /* clipping information */ |
||
| 98 | SDL_Rect clip_rect; /* Read-only */ |
||
| 99 | |||
| 100 | /* Reference count -- used when freeing surface */ |
||
| 101 | int refcount; /* Read-mostly */ |
||
| 102 | |||
| 103 | /* This structure also contains private fields not shown here */ |
||
| 104 | } SDL_Surface; |
||
| 105 | > |
||
| 106 | > |
||
| 107 | CLASS="REFSECT1" |
||
| 108 | > |
||
| 109 | NAME="AEN2847" |
||
| 110 | > |
||
| 111 | > |
||
| 112 | >Structure Data |
||
| 113 | > |
||
| 114 | CLASS="INFORMALTABLE" |
||
| 115 | > |
||
| 116 | NAME="AEN2849" |
||
| 117 | > |
||
| 118 | > |
||
| 119 | > |
||
| 120 | > |
||
| 121 | BORDER="0" |
||
| 122 | CLASS="CALSTABLE" |
||
| 123 | > |
||
| 124 | > |
||
| 125 | > |
||
| 126 | ALIGN="LEFT" |
||
| 127 | VALIGN="TOP" |
||
| 128 | > |
||
| 129 | CLASS="STRUCTFIELD" |
||
| 130 | > |
||
| 131 | >flags |
||
| 132 | > |
||
| 133 | > |
||
| 134 | > |
||
| 135 | ALIGN="LEFT" |
||
| 136 | VALIGN="TOP" |
||
| 137 | >Surface flags |
||
| 138 | > |
||
| 139 | > |
||
| 140 | > |
||
| 141 | ALIGN="LEFT" |
||
| 142 | VALIGN="TOP" |
||
| 143 | > |
||
| 144 | CLASS="STRUCTFIELD" |
||
| 145 | > |
||
| 146 | >format |
||
| 147 | > |
||
| 148 | > |
||
| 149 | > |
||
| 150 | ALIGN="LEFT" |
||
| 151 | VALIGN="TOP" |
||
| 152 | >Pixel |
||
| 153 | HREF="sdlpixelformat.html" |
||
| 154 | >format |
||
| 155 | > |
||
| 156 | > |
||
| 157 | > |
||
| 158 | > |
||
| 159 | ALIGN="LEFT" |
||
| 160 | VALIGN="TOP" |
||
| 161 | > |
||
| 162 | CLASS="STRUCTFIELD" |
||
| 163 | > |
||
| 164 | >w, h |
||
| 165 | > |
||
| 166 | > |
||
| 167 | > |
||
| 168 | ALIGN="LEFT" |
||
| 169 | VALIGN="TOP" |
||
| 170 | >Width and height of the surface |
||
| 171 | > |
||
| 172 | > |
||
| 173 | > |
||
| 174 | ALIGN="LEFT" |
||
| 175 | VALIGN="TOP" |
||
| 176 | > |
||
| 177 | CLASS="STRUCTFIELD" |
||
| 178 | > |
||
| 179 | >pitch |
||
| 180 | > |
||
| 181 | > |
||
| 182 | > |
||
| 183 | ALIGN="LEFT" |
||
| 184 | VALIGN="TOP" |
||
| 185 | >Length of a surface scanline in bytes |
||
| 186 | > |
||
| 187 | > |
||
| 188 | > |
||
| 189 | ALIGN="LEFT" |
||
| 190 | VALIGN="TOP" |
||
| 191 | > |
||
| 192 | CLASS="STRUCTFIELD" |
||
| 193 | > |
||
| 194 | >pixels |
||
| 195 | > |
||
| 196 | > |
||
| 197 | > |
||
| 198 | ALIGN="LEFT" |
||
| 199 | VALIGN="TOP" |
||
| 200 | >Pointer to the actual pixel data |
||
| 201 | > |
||
| 202 | > |
||
| 203 | > |
||
| 204 | ALIGN="LEFT" |
||
| 205 | VALIGN="TOP" |
||
| 206 | > |
||
| 207 | CLASS="STRUCTFIELD" |
||
| 208 | > |
||
| 209 | >clip_rect |
||
| 210 | > |
||
| 211 | > |
||
| 212 | > |
||
| 213 | ALIGN="LEFT" |
||
| 214 | VALIGN="TOP" |
||
| 215 | >surface clip |
||
| 216 | HREF="sdlrect.html" |
||
| 217 | >rectangle |
||
| 218 | > |
||
| 219 | > |
||
| 220 | > |
||
| 221 | > |
||
| 222 | > |
||
| 223 | > |
||
| 224 | > |
||
| 225 | > |
||
| 226 | > |
||
| 227 | CLASS="REFSECT1" |
||
| 228 | > |
||
| 229 | NAME="AEN2878" |
||
| 230 | > |
||
| 231 | > |
||
| 232 | >Description |
||
| 233 | > |
||
| 234 | > |
||
| 235 | CLASS="STRUCTNAME" |
||
| 236 | >SDL_Surface |
||
| 237 | >'s represent areas of "graphical" |
||
| 238 | memory, memory that can be drawn to. The video framebuffer is returned |
||
| 239 | as a |
||
| 240 | CLASS="STRUCTNAME" |
||
| 241 | >SDL_Surface |
||
| 242 | > by |
||
| 243 | |||
| 244 | HREF="sdlsetvideomode.html" |
||
| 245 | > |
||
| 246 | CLASS="FUNCTION" |
||
| 247 | >SDL_SetVideoMode |
||
| 248 | > |
||
| 249 | > |
||
| 250 | and |
||
| 251 | HREF="sdlgetvideosurface.html" |
||
| 252 | > |
||
| 253 | CLASS="FUNCTION" |
||
| 254 | >SDL_GetVideoSurface |
||
| 255 | > |
||
| 256 | >. |
||
| 257 | Most of the fields should be pretty obvious. |
||
| 258 | |||
| 259 | CLASS="STRUCTFIELD" |
||
| 260 | > |
||
| 261 | >w |
||
| 262 | > |
||
| 263 | > and |
||
| 264 | CLASS="STRUCTFIELD" |
||
| 265 | > |
||
| 266 | >h |
||
| 267 | > |
||
| 268 | > are the |
||
| 269 | width and height of the surface in pixels. |
||
| 270 | |||
| 271 | CLASS="STRUCTFIELD" |
||
| 272 | > |
||
| 273 | >pixels |
||
| 274 | > |
||
| 275 | > is a pointer to the actual pixel data, |
||
| 276 | the surface should be |
||
| 277 | HREF="sdllocksurface.html" |
||
| 278 | >locked |
||
| 279 | > |
||
| 280 | before accessing this field. The |
||
| 281 | CLASS="STRUCTFIELD" |
||
| 282 | > |
||
| 283 | >clip_rect |
||
| 284 | > |
||
| 285 | > field |
||
| 286 | is the clipping rectangle as set by |
||
| 287 | |||
| 288 | HREF="sdlsetcliprect.html" |
||
| 289 | > |
||
| 290 | CLASS="FUNCTION" |
||
| 291 | >SDL_SetClipRect |
||
| 292 | > |
||
| 293 | >. |
||
| 294 | > |
||
| 295 | >The following are supported in the |
||
| 296 | |||
| 297 | CLASS="STRUCTFIELD" |
||
| 298 | > |
||
| 299 | >flags |
||
| 300 | > |
||
| 301 | > field. |
||
| 302 | > |
||
| 303 | CLASS="INFORMALTABLE" |
||
| 304 | > |
||
| 305 | NAME="AEN2896" |
||
| 306 | > |
||
| 307 | > |
||
| 308 | > |
||
| 309 | > |
||
| 310 | BORDER="1" |
||
| 311 | CLASS="CALSTABLE" |
||
| 312 | > |
||
| 313 | > |
||
| 314 | > |
||
| 315 | ALIGN="LEFT" |
||
| 316 | VALIGN="TOP" |
||
| 317 | > |
||
| 318 | CLASS="LITERAL" |
||
| 319 | >SDL_SWSURFACE |
||
| 320 | > |
||
| 321 | > |
||
| 322 | ALIGN="LEFT" |
||
| 323 | VALIGN="TOP" |
||
| 324 | >Surface is stored in system memory |
||
| 325 | > |
||
| 326 | > |
||
| 327 | > |
||
| 328 | ALIGN="LEFT" |
||
| 329 | VALIGN="TOP" |
||
| 330 | > |
||
| 331 | CLASS="LITERAL" |
||
| 332 | >SDL_HWSURFACE |
||
| 333 | > |
||
| 334 | > |
||
| 335 | ALIGN="LEFT" |
||
| 336 | VALIGN="TOP" |
||
| 337 | >Surface is stored in video memory |
||
| 338 | > |
||
| 339 | > |
||
| 340 | > |
||
| 341 | ALIGN="LEFT" |
||
| 342 | VALIGN="TOP" |
||
| 343 | > |
||
| 344 | CLASS="LITERAL" |
||
| 345 | >SDL_ASYNCBLIT |
||
| 346 | > |
||
| 347 | > |
||
| 348 | ALIGN="LEFT" |
||
| 349 | VALIGN="TOP" |
||
| 350 | >Surface uses asynchronous blits if possible |
||
| 351 | > |
||
| 352 | > |
||
| 353 | > |
||
| 354 | ALIGN="LEFT" |
||
| 355 | VALIGN="TOP" |
||
| 356 | > |
||
| 357 | CLASS="LITERAL" |
||
| 358 | >SDL_ANYFORMAT |
||
| 359 | > |
||
| 360 | > |
||
| 361 | ALIGN="LEFT" |
||
| 362 | VALIGN="TOP" |
||
| 363 | >Allows any pixel-format (Display surface) |
||
| 364 | > |
||
| 365 | > |
||
| 366 | > |
||
| 367 | ALIGN="LEFT" |
||
| 368 | VALIGN="TOP" |
||
| 369 | > |
||
| 370 | CLASS="LITERAL" |
||
| 371 | >SDL_HWPALETTE |
||
| 372 | > |
||
| 373 | > |
||
| 374 | ALIGN="LEFT" |
||
| 375 | VALIGN="TOP" |
||
| 376 | >Surface has exclusive palette |
||
| 377 | > |
||
| 378 | > |
||
| 379 | > |
||
| 380 | ALIGN="LEFT" |
||
| 381 | VALIGN="TOP" |
||
| 382 | > |
||
| 383 | CLASS="LITERAL" |
||
| 384 | >SDL_DOUBLEBUF |
||
| 385 | > |
||
| 386 | > |
||
| 387 | ALIGN="LEFT" |
||
| 388 | VALIGN="TOP" |
||
| 389 | >Surface is double buffered (Display surface) |
||
| 390 | > |
||
| 391 | > |
||
| 392 | > |
||
| 393 | ALIGN="LEFT" |
||
| 394 | VALIGN="TOP" |
||
| 395 | > |
||
| 396 | CLASS="LITERAL" |
||
| 397 | >SDL_FULLSCREEN |
||
| 398 | > |
||
| 399 | > |
||
| 400 | ALIGN="LEFT" |
||
| 401 | VALIGN="TOP" |
||
| 402 | >Surface is full screen (Display Surface) |
||
| 403 | > |
||
| 404 | > |
||
| 405 | > |
||
| 406 | ALIGN="LEFT" |
||
| 407 | VALIGN="TOP" |
||
| 408 | > |
||
| 409 | CLASS="LITERAL" |
||
| 410 | >SDL_OPENGL |
||
| 411 | > |
||
| 412 | > |
||
| 413 | ALIGN="LEFT" |
||
| 414 | VALIGN="TOP" |
||
| 415 | >Surface has an OpenGL context (Display Surface) |
||
| 416 | > |
||
| 417 | > |
||
| 418 | > |
||
| 419 | ALIGN="LEFT" |
||
| 420 | VALIGN="TOP" |
||
| 421 | > |
||
| 422 | CLASS="LITERAL" |
||
| 423 | >SDL_OPENGLBLIT |
||
| 424 | > |
||
| 425 | > |
||
| 426 | ALIGN="LEFT" |
||
| 427 | VALIGN="TOP" |
||
| 428 | >Surface supports OpenGL blitting (Display Surface) |
||
| 429 | > |
||
| 430 | > |
||
| 431 | > |
||
| 432 | ALIGN="LEFT" |
||
| 433 | VALIGN="TOP" |
||
| 434 | > |
||
| 435 | CLASS="LITERAL" |
||
| 436 | >SDL_RESIZABLE |
||
| 437 | > |
||
| 438 | > |
||
| 439 | ALIGN="LEFT" |
||
| 440 | VALIGN="TOP" |
||
| 441 | >Surface is resizable (Display Surface) |
||
| 442 | > |
||
| 443 | > |
||
| 444 | > |
||
| 445 | ALIGN="LEFT" |
||
| 446 | VALIGN="TOP" |
||
| 447 | > |
||
| 448 | CLASS="LITERAL" |
||
| 449 | >SDL_HWACCEL |
||
| 450 | > |
||
| 451 | > |
||
| 452 | ALIGN="LEFT" |
||
| 453 | VALIGN="TOP" |
||
| 454 | >Surface blit uses hardware acceleration |
||
| 455 | > |
||
| 456 | > |
||
| 457 | > |
||
| 458 | ALIGN="LEFT" |
||
| 459 | VALIGN="TOP" |
||
| 460 | > |
||
| 461 | CLASS="LITERAL" |
||
| 462 | >SDL_SRCCOLORKEY |
||
| 463 | > |
||
| 464 | > |
||
| 465 | ALIGN="LEFT" |
||
| 466 | VALIGN="TOP" |
||
| 467 | >Surface use colorkey blitting |
||
| 468 | > |
||
| 469 | > |
||
| 470 | > |
||
| 471 | ALIGN="LEFT" |
||
| 472 | VALIGN="TOP" |
||
| 473 | > |
||
| 474 | CLASS="LITERAL" |
||
| 475 | >SDL_RLEACCEL |
||
| 476 | > |
||
| 477 | > |
||
| 478 | ALIGN="LEFT" |
||
| 479 | VALIGN="TOP" |
||
| 480 | >Colorkey blitting is accelerated with RLE |
||
| 481 | > |
||
| 482 | > |
||
| 483 | > |
||
| 484 | ALIGN="LEFT" |
||
| 485 | VALIGN="TOP" |
||
| 486 | > |
||
| 487 | CLASS="LITERAL" |
||
| 488 | >SDL_SRCALPHA |
||
| 489 | > |
||
| 490 | > |
||
| 491 | ALIGN="LEFT" |
||
| 492 | VALIGN="TOP" |
||
| 493 | >Surface blit uses alpha blending |
||
| 494 | > |
||
| 495 | > |
||
| 496 | > |
||
| 497 | ALIGN="LEFT" |
||
| 498 | VALIGN="TOP" |
||
| 499 | > |
||
| 500 | CLASS="LITERAL" |
||
| 501 | >SDL_PREALLOC |
||
| 502 | > |
||
| 503 | > |
||
| 504 | ALIGN="LEFT" |
||
| 505 | VALIGN="TOP" |
||
| 506 | >Surface uses preallocated memory |
||
| 507 | > |
||
| 508 | > |
||
| 509 | > |
||
| 510 | > |
||
| 511 | > |
||
| 512 | > |
||
| 513 | > |
||
| 514 | > |
||
| 515 | CLASS="REFSECT1" |
||
| 516 | > |
||
| 517 | NAME="AEN2959" |
||
| 518 | > |
||
| 519 | > |
||
| 520 | >See Also |
||
| 521 | > |
||
| 522 | > |
||
| 523 | HREF="sdlpixelformat.html" |
||
| 524 | > |
||
| 525 | CLASS="STRUCTNAME" |
||
| 526 | >SDL_PixelFormat |
||
| 527 | > |
||
| 528 | > |
||
| 529 | > |
||
| 530 | > |
||
| 531 | CLASS="NAVFOOTER" |
||
| 532 | > |
||
| 533 | ALIGN="LEFT" |
||
| 534 | WIDTH="100%"> |
||
| 535 | WIDTH="100%" |
||
| 536 | BORDER="0" |
||
| 537 | CELLPADDING="0" |
||
| 538 | CELLSPACING="0" |
||
| 539 | > |
||
| 540 | > |
||
| 541 | WIDTH="33%" |
||
| 542 | ALIGN="left" |
||
| 543 | VALIGN="top" |
||
| 544 | > |
||
| 545 | HREF="sdlpixelformat.html" |
||
| 546 | >Prev |
||
| 547 | > |
||
| 548 | > |
||
| 549 | WIDTH="34%" |
||
| 550 | ALIGN="center" |
||
| 551 | VALIGN="top" |
||
| 552 | > |
||
| 553 | HREF="index.html" |
||
| 554 | >Home |
||
| 555 | > |
||
| 556 | > |
||
| 557 | WIDTH="33%" |
||
| 558 | ALIGN="right" |
||
| 559 | VALIGN="top" |
||
| 560 | > |
||
| 561 | HREF="sdlvideoinfo.html" |
||
| 562 | >Next |
||
| 563 | > |
||
| 564 | > |
||
| 565 | > |
||
| 566 | > |
||
| 567 | WIDTH="33%" |
||
| 568 | ALIGN="left" |
||
| 569 | VALIGN="top" |
||
| 570 | >SDL_PixelFormat |
||
| 571 | > |
||
| 572 | WIDTH="34%" |
||
| 573 | ALIGN="center" |
||
| 574 | VALIGN="top" |
||
| 575 | > |
||
| 576 | HREF="video.html" |
||
| 577 | >Up |
||
| 578 | > |
||
| 579 | > |
||
| 580 | WIDTH="33%" |
||
| 581 | ALIGN="right" |
||
| 582 | VALIGN="top" |
||
| 583 | >SDL_VideoInfo |
||
| 584 | > |
||
| 585 | > |
||
| 586 | > |
||
| 587 | > |
||
| 588 | > |
||
| 589 | > |