home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_FillRect.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.0 KB  |  56 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_FillRect"("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_FillRect- This function performs a fast fill of the given rectangle
  13. with some color 
  14. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  15. <p>
  16. <b>#include "SDL.h" <p>
  17. </b><b>int <b>SDL_FillRect</b></b>(<b>SDL_Surface *dst,
  18. SDL_Rect *dstrect, Uint32 color</b>); 
  19. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  20. <p>
  21. This function performs a fast
  22. fill of the given rectangle with <b>color</b>. If <b>dstrect</b> is <b>NULL</b>, the whole surface
  23. will be filled with <b>color</b>. <p>
  24. The color should be a pixel of the format used
  25. by the surface, and can be generated by the <i>SDL_MapRGB</i> or <i>SDL_MapRGBA</i> functions.
  26. If the color value contains an alpha value then the destination is simply
  27. "filled" with that alpha information, no blending takes place. <p>
  28. If there
  29. is a clip rectangle set on the destination (set via <i>SDL_SetClipRect</i>) then
  30. this function will clip based on the intersection of the clip rectangle
  31. and the <b>dstrect</b> rectangle and the dstrect rectangle will be modified to
  32. represent the area actually filled. 
  33. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  34. <p>
  35. This function returns <b>0</b>
  36. on success, or <b>-1</b> on error. 
  37. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  38. <p>
  39. <i><b>SDL_MapRGB</b></i>, <i><b>SDL_MapRGBA</b></i>, <i><b>SDL_BlitSurface</b></i>,
  40. <i><b>SDL_Rect</b></i> 
  41. <!--
  42.   
  43.  <p>
  44.  
  45. <hr><p>
  46. <a name='toc'><b>Table of Contents</b></a><p>
  47. <ul>
  48. <li><a name='toc0' href='#sect0'>Name</a></li>
  49. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  50. <li><a name='toc2' href='#sect2'>Description</a></li>
  51. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  52. <li><a name='toc4' href='#sect4'>See Also</a></li>
  53. </ul>
  54. </body>
  55. </html>
  56.