home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_MapRGB.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.9 KB  |  54 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_MapRGB"("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_MapRGB- Map a RGB 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_MapRGB</b></b>(<b>SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8
  18. b</b>); 
  19. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  20. <p>
  21. Maps the RGB color value to the specified pixel format and
  22. returns the pixel value as a 32-bit int. <p>
  23. If the format has a palette (8-bit)
  24. the index of the closest matching color in the palette will be returned.
  25. <p>
  26. If the specified pixel format has an alpha component it will be returned
  27. as all 1 bits (fully opaque). 
  28. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  29. <p>
  30. A pixel value best approximating
  31. the given RGB color value for a given pixel format. If the pixel format
  32. bpp (color depth) is less than 32-bpp then the unused upper bits of the
  33. return value can safely be ignored (e.g., with a 16-bpp format the return
  34. value can be assigned to a <b>Uint16</b>, and similarly a <b>Uint8</b> for an 8-bpp format).
  35.  
  36. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  37. <p>
  38. <i><b>SDL_GetRGB</b></i>, <i><b>SDL_GetRGBA</b></i>, <i><b>SDL_MapRGBA</b></i>, <i><b>SDL_PixelFormat</b></i> 
  39. <!--
  40.   
  41.  <p>
  42.  
  43. <hr><p>
  44. <a name='toc'><b>Table of Contents</b></a><p>
  45. <ul>
  46. <li><a name='toc0' href='#sect0'>Name</a></li>
  47. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  48. <li><a name='toc2' href='#sect2'>Description</a></li>
  49. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  50. <li><a name='toc4' href='#sect4'>See Also</a></li>
  51. </ul>
  52. </body>
  53. </html>
  54.