structth__img__plane.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>libtheora: th_img_plane Struct Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.6.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15. <li><a href="modules.html"><span>Modules</span></a></li>
  16. <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  17. <li><a href="files.html"><span>Files</span></a></li>
  18. </ul>
  19. </div>
  20. <div class="tabs">
  21. <ul>
  22. <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  23. <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  24. </ul>
  25. </div>
  26. </div>
  27. <div class="contents">
  28. <h1>th_img_plane Struct Reference</h1><!-- doxytag: class="th_img_plane" -->
  29. <p>A buffer for a single color plane in an uncompressed image.
  30. <a href="#_details">More...</a></p>
  31. <p><code>#include &lt;<a class="el" href="codec_8h_source.html">codec.h</a>&gt;</code></p>
  32. <table border="0" cellpadding="0" cellspacing="0">
  33. <tr><td colspan="2"><h2>Data Fields</h2></td></tr>
  34. <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structth__img__plane.html#a58cc297a99cd4594c3d30e56f2ed6b74">width</a></td></tr>
  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The width of this plane. <a href="#a58cc297a99cd4594c3d30e56f2ed6b74"></a><br/></td></tr>
  36. <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structth__img__plane.html#a21aea1367894468de489d529d7eaf44d">height</a></td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The height of this plane. <a href="#a21aea1367894468de489d529d7eaf44d"></a><br/></td></tr>
  38. <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structth__img__plane.html#ab1100f071ffee3b37e07e3222f819bad">stride</a></td></tr>
  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The offset in bytes between successive rows. <a href="#ab1100f071ffee3b37e07e3222f819bad"></a><br/></td></tr>
  40. <tr><td class="memItemLeft" align="right" valign="top">unsigned char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structth__img__plane.html#af8133681516ce88b5a201c1b4b7e6ba2">data</a></td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A pointer to the beginning of the first row. <a href="#af8133681516ce88b5a201c1b4b7e6ba2"></a><br/></td></tr>
  42. </table>
  43. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  44. <p>A buffer for a single color plane in an uncompressed image. </p>
  45. <p>This contains the image data in a left-to-right, top-down format. Each row of pixels is stored contiguously in memory, but successive rows need not be. Use <em>stride</em> to compute the offset of the next row. The encoder accepts both positive <em>stride</em> values (top-down in memory) and negative (bottom-up in memory). The decoder currently always generates images with positive strides. </p>
  46. <hr/><h2>Field Documentation</h2>
  47. <a class="anchor" id="af8133681516ce88b5a201c1b4b7e6ba2"></a><!-- doxytag: member="th_img_plane::data" ref="af8133681516ce88b5a201c1b4b7e6ba2" args="" -->
  48. <div class="memitem">
  49. <div class="memproto">
  50. <table class="memname">
  51. <tr>
  52. <td class="memname">unsigned char* <a class="el" href="structth__img__plane.html#af8133681516ce88b5a201c1b4b7e6ba2">th_img_plane::data</a></td>
  53. </tr>
  54. </table>
  55. </div>
  56. <div class="memdoc">
  57. <p>A pointer to the beginning of the first row. </p>
  58. </div>
  59. </div>
  60. <a class="anchor" id="a21aea1367894468de489d529d7eaf44d"></a><!-- doxytag: member="th_img_plane::height" ref="a21aea1367894468de489d529d7eaf44d" args="" -->
  61. <div class="memitem">
  62. <div class="memproto">
  63. <table class="memname">
  64. <tr>
  65. <td class="memname">int <a class="el" href="structth__img__plane.html#a21aea1367894468de489d529d7eaf44d">th_img_plane::height</a></td>
  66. </tr>
  67. </table>
  68. </div>
  69. <div class="memdoc">
  70. <p>The height of this plane. </p>
  71. </div>
  72. </div>
  73. <a class="anchor" id="ab1100f071ffee3b37e07e3222f819bad"></a><!-- doxytag: member="th_img_plane::stride" ref="ab1100f071ffee3b37e07e3222f819bad" args="" -->
  74. <div class="memitem">
  75. <div class="memproto">
  76. <table class="memname">
  77. <tr>
  78. <td class="memname">int <a class="el" href="structth__img__plane.html#ab1100f071ffee3b37e07e3222f819bad">th_img_plane::stride</a></td>
  79. </tr>
  80. </table>
  81. </div>
  82. <div class="memdoc">
  83. <p>The offset in bytes between successive rows. </p>
  84. </div>
  85. </div>
  86. <a class="anchor" id="a58cc297a99cd4594c3d30e56f2ed6b74"></a><!-- doxytag: member="th_img_plane::width" ref="a58cc297a99cd4594c3d30e56f2ed6b74" args="" -->
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">int <a class="el" href="structth__img__plane.html#a58cc297a99cd4594c3d30e56f2ed6b74">th_img_plane::width</a></td>
  92. </tr>
  93. </table>
  94. </div>
  95. <div class="memdoc">
  96. <p>The width of this plane. </p>
  97. </div>
  98. </div>
  99. <hr/>The documentation for this struct was generated from the following file:<ul>
  100. <li><a class="el" href="codec_8h_source.html">codec.h</a></li>
  101. </ul>
  102. </div>
  103. <hr size="1"/><address style="text-align: right;"><small>Generated on 28 Sep 2009 for libtheora by&nbsp;
  104. <a href="http://www.doxygen.org/index.html">
  105. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  106. </body>
  107. </html>