home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_CreateRGBSurfaceFrom.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  1.8 KB  |  53 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_CreateRGBSurfaceFrom"("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_CreateRGBSurfaceFrom- Create an SDL_Surface from pixel data 
  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_CreateRGBSurfaceFrom</b></b>(<b>void *pixels, int width, int
  18. height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask,
  19. Uint32 Amask</b>); 
  20. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  21. <p>
  22. Creates an SDL_Surface from the provided pixel
  23. data. <p>
  24. The data stored in <b>pixels</b> is assumed to be of the <b>depth</b> specified
  25. in the parameter list. The pixel data is not copied into the <b>SDL_Surface</b>
  26. structure so it should not be freed until the surface has been freed with
  27. a called to <i>SDL_FreeSurface</i>. <b>pitch</b> is the length of each scanline in bytes.
  28.  <p>
  29. See <i><b>SDL_CreateRGBSurface</b></i> for a more detailed description of the other
  30. parameters. 
  31. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  32. <p>
  33. Returns the created surface, or <b>NULL</b> upon error.
  34.  
  35. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  36. <p>
  37. <i><b>SDL_CreateRGBSurface</b></i>, <i><b>SDL_FreeSurface</b></i> 
  38. <!--
  39.   
  40.  <p>
  41.  
  42. <hr><p>
  43. <a name='toc'><b>Table of Contents</b></a><p>
  44. <ul>
  45. <li><a name='toc0' href='#sect0'>Name</a></li>
  46. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  47. <li><a name='toc2' href='#sect2'>Description</a></li>
  48. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  49. <li><a name='toc4' href='#sect4'>See Also</a></li>
  50. </ul>
  51. </body>
  52. </html>
  53.