home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_DisplayFormat.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.7 KB  |  52 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_DisplayFormat"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_DisplayFormat- Convert a surface to the display format 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include
  16. "SDL.h" <p>
  17. </b><b>SDL_Surface *<b>SDL_DisplayFormat</b></b>(<b>SDL_Surface *surface</b>); 
  18. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  19. <p>
  20. This
  21. function takes a surface and copies it to a new surface of the pixel format
  22. and colors of the video framebuffer, suitable for fast blitting onto the
  23. display surface. It calls <i>SDL_ConvertSurface</i> <p>
  24. If you want to take advantage
  25. of hardware colorkey or alpha blit acceleration, you should set the colorkey
  26. and alpha value before calling this function. <p>
  27. If you want an alpha channel,
  28. see <i>SDL_DisplayFormatAlpha</i>. 
  29. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  30. <p>
  31. If the conversion fails or runs
  32. out of memory, it returns <b>NULL</b> 
  33. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  34. <p>
  35. <i><b>SDL_ConvertSurface</b></i>, <i><b>SDL_DisplayFormatAlpha</b></i>
  36. <i><b>SDL_SetAlpha</b></i>, <i><b>SDL_SetColorKey</b></i>, <i><b>SDL_Surface</b></i> 
  37. <!--
  38.   
  39.  <p>
  40.  
  41. <hr><p>
  42. <a name='toc'><b>Table of Contents</b></a><p>
  43. <ul>
  44. <li><a name='toc0' href='#sect0'>Name</a></li>
  45. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  46. <li><a name='toc2' href='#sect2'>Description</a></li>
  47. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  48. <li><a name='toc4' href='#sect4'>See Also</a></li>
  49. </ul>
  50. </body>
  51. </html>
  52.