home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_MapRGBA.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_MapRGBA"("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_MapRGBA- Map a RGBA color value to a pixel format. 
  13. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  14. <p>
  15. <b>#include
  16. "SDL.h" <p>
  17. </b><b>Uint32 <b>SDL_MapRGBA</b></b>(<b>SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8
  18. b, Uint8 a</b>); 
  19. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  20. <p>
  21. Maps the RGBA color value to the specified pixel
  22. format and returns the pixel value as a 32-bit int. <p>
  23. If the format has a palette
  24. (8-bit) the index of the closest matching color in the palette will be returned.
  25. <p>
  26. If the specified pixel format has no alpha component the alpha value will
  27. be ignored (as it will be in formats with a palette). 
  28. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  29. <p>
  30. A pixel
  31. value best approximating the given RGBA color value for a given pixel format.
  32. If the pixel format bpp (color depth) is less than 32-bpp then the unused
  33. upper bits of the return value can safely be ignored (e.g., with a 16-bpp
  34. format the return value can be assigned to a <b>Uint16</b>, and similarly a <b>Uint8</b>
  35. for an 8-bpp format). 
  36. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  37. <p>
  38. <i>SDL_GetRGB</i>, <i>SDL_GetRGBA</i>, <i>SDL_MapRGB</i>, <i>SDL_PixelFormat</i>
  39.  
  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.