home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_Overlay.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.6 KB  |  90 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_Overlay"("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_Overlay- YUV video overlay 
  13. <h2><a name='sect1' href='#toc1'>Structure Definition</a></h2>
  14. <p>
  15. <br>
  16. <pre>CWtypedef struct{
  17.   Uint32 format;
  18.   int w, h;
  19.   int planes;
  20.   Uint16 *pitches;
  21.   Uint8 **pixels;
  22.   Uint32 hw_overlay:1;
  23. } SDL_Overlay;
  24. </pre><p>
  25.  
  26. <h2><a name='sect2' href='#toc2'>Structure Data</a></h2>
  27.  
  28. <dl>
  29.  
  30. <dt><b>format</b> </dt>
  31. <dd>Overlay format (see below) </dd>
  32.  
  33. <dt><b>w, h</b> </dt>
  34. <dd>Width and height of
  35. overlay </dd>
  36.  
  37. <dt><b>planes</b> </dt>
  38. <dd>Number of planes in the overlay. Usually either 1 or 3 </dd>
  39.  
  40. <dt><b>pitches</b>
  41. </dt>
  42. <dd>An array of pitches, one for each plane. Pitch is the length of a row in
  43. bytes. </dd>
  44.  
  45. <dt><b>pixels</b> </dt>
  46. <dd>An array of pointers to teh data of each plane. The overlay
  47. should be locked before these pointers are used. </dd>
  48.  
  49. <dt><b>hw_overlay</b> </dt>
  50. <dd>This will be
  51. set to 1 if the overlay is hardware accelerated. </dd>
  52. </dl>
  53.  
  54. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  55. <p>
  56. A <b>SDL_Overlay</b>
  57. is similar to a <i><b>SDL_Surface</b></i> except it stores a YUV overlay. All the fields
  58. are read only, except for <b>pixels</b> which should be <i>locked</i> before use. The
  59. <b>format</b> field stores the format of the overlay which is one of the following:
  60.  <p>
  61. <br>
  62. <pre>CW#define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
  63. #define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
  64. #define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
  65. #define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
  66. #define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */
  67. </pre><p>
  68.  More information on YUV formats can be found at <i>http://www.webartz.com/fourcc/indexyuv.htm
  69. (link to URL http://www.webartz.com/fourcc/indexyuv.htm) </i>.<br>
  70.  
  71. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  72. <p>
  73. <i><b>SDL_CreateYUVOverlay</b></i>, <i><b>SDL_LockYUVOverlay</b></i>, <i><b>SDL_UnlockYUVOverlay</b></i>,
  74. <i><b>SDL_FreeYUVOverlay</b></i> 
  75. <!--
  76.   
  77.  <p>
  78.  
  79. <hr><p>
  80. <a name='toc'><b>Table of Contents</b></a><p>
  81. <ul>
  82. <li><a name='toc0' href='#sect0'>Name</a></li>
  83. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  84. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  85. <li><a name='toc3' href='#sect3'>Description</a></li>
  86. <li><a name='toc4' href='#sect4'>See Also</a></li>
  87. </ul>
  88. </body>
  89. </html>
  90.