home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_DisplayFormatAlpha.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.9 KB  |  55 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_DisplayFormatAlpha"("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_DisplayFormatAlpha- 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_DisplayFormatAlpha</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 plus an alpha channel, suitable for
  23. fast blitting onto the display surface. It calls <i>SDL_ConvertSurface</i> <p>
  24. If you
  25. want to take advantage of hardware colorkey or alpha blit acceleration,
  26. you should set the colorkey and alpha value before calling this function.
  27. <p>
  28. This function can be used to convert a colourkey to an alpha channel, if
  29. the <b>SDL_SRCCOLORKEY</b> flag is set on the surface. The generated surface will
  30. then be transparent (alpha=0) where the pixels match the colourkey, and
  31. opaque (alpha=255) elsewhere. 
  32. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  33. <p>
  34. If the conversion fails or runs
  35. out of memory, it returns <b>NULL</b> 
  36. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  37. <p>
  38. <i>SDL_ConvertSurface</i>, <i>SDL_SetAlpha</i>,
  39. <i>SDL_SetColorKey</i>, <i>SDL_DisplayFormat</i>, <i>SDL_Surface</i> 
  40. <!--
  41.   
  42.  <p>
  43.  
  44. <hr><p>
  45. <a name='toc'><b>Table of Contents</b></a><p>
  46. <ul>
  47. <li><a name='toc0' href='#sect0'>Name</a></li>
  48. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  49. <li><a name='toc2' href='#sect2'>Description</a></li>
  50. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  51. <li><a name='toc4' href='#sect4'>See Also</a></li>
  52. </ul>
  53. </body>
  54. </html>
  55.