structILimage.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
  3. <title>DevIL: ILimage Struct Reference</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.5.6 -->
  8. <div class="navigation" id="top">
  9. <div class="tabs">
  10. <ul>
  11. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12. <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13. <li><a href="files.html"><span>Files</span></a></li>
  14. </ul>
  15. </div>
  16. <div class="tabs">
  17. <ul>
  18. <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  19. <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  20. </ul>
  21. </div>
  22. </div>
  23. <div class="contents">
  24. <h1>ILimage Struct Reference</h1><!-- doxytag: class="ILimage" -->The Fundamental Image structure.
  25. <a href="#_details">More...</a>
  26. <p>
  27. <code>#include &lt;<a class="el" href="devil__internal__exports_8h-source.html">devil_internal_exports.h</a>&gt;</code>
  28. <p>
  29. <table border="0" cellpadding="0" cellspacing="0">
  30. <tr><td></td></tr>
  31. <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  32. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cdaccde79cda12c44c7a076ef9978cf1"></a><!-- doxytag: member="ILimage::Width" ref="cdaccde79cda12c44c7a076ef9978cf1" args="" -->
  33. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#cdaccde79cda12c44c7a076ef9978cf1">Width</a></td></tr>
  34. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the image's width <br></td></tr>
  35. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0fe112b929d774c723ba5d8b6c2c5da"></a><!-- doxytag: member="ILimage::Height" ref="f0fe112b929d774c723ba5d8b6c2c5da" args="" -->
  36. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#f0fe112b929d774c723ba5d8b6c2c5da">Height</a></td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the image's height <br></td></tr>
  38. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00e19fb6f1e50731d114c302129112d9"></a><!-- doxytag: member="ILimage::Depth" ref="00e19fb6f1e50731d114c302129112d9" args="" -->
  39. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#00e19fb6f1e50731d114c302129112d9">Depth</a></td></tr>
  40. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the image's depth <br></td></tr>
  41. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b3ec86e5bf7087b7d46f0ed61d86eb9"></a><!-- doxytag: member="ILimage::Bpp" ref="1b3ec86e5bf7087b7d46f0ed61d86eb9" args="" -->
  42. ILubyte&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#1b3ec86e5bf7087b7d46f0ed61d86eb9">Bpp</a></td></tr>
  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">bytes per pixel (now number of channels) <br></td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20c53053c80d504de93c3ee17290a9ba"></a><!-- doxytag: member="ILimage::Bpc" ref="20c53053c80d504de93c3ee17290a9ba" args="" -->
  45. ILubyte&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#20c53053c80d504de93c3ee17290a9ba">Bpc</a></td></tr>
  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">bytes per channel <br></td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09ee9478fab289cf2622f06db9171894"></a><!-- doxytag: member="ILimage::Bps" ref="09ee9478fab289cf2622f06db9171894" args="" -->
  48. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#09ee9478fab289cf2622f06db9171894">Bps</a></td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">bytes per scanline (components for IL) <br></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7a9627719d89abb3cb48087452acbc8"></a><!-- doxytag: member="ILimage::Data" ref="b7a9627719d89abb3cb48087452acbc8" args="" -->
  51. ILubyte *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#b7a9627719d89abb3cb48087452acbc8">Data</a></td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the image data <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e84436c94d9cd5afad59be12dff753b"></a><!-- doxytag: member="ILimage::SizeOfData" ref="9e84436c94d9cd5afad59be12dff753b" args="" -->
  54. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#9e84436c94d9cd5afad59be12dff753b">SizeOfData</a></td></tr>
  55. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the total size of the data (in bytes) <br></td></tr>
  56. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ce85bc0b983ddf0ed91b1ed98d9132a"></a><!-- doxytag: member="ILimage::SizeOfPlane" ref="5ce85bc0b983ddf0ed91b1ed98d9132a" args="" -->
  57. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#5ce85bc0b983ddf0ed91b1ed98d9132a">SizeOfPlane</a></td></tr>
  58. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SizeOfData in a 2d image, size of each plane slice in a 3d image (in bytes). <br></td></tr>
  59. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f36941d08ffdd7ed7c42cdb11d2a5513"></a><!-- doxytag: member="ILimage::Format" ref="f36941d08ffdd7ed7c42cdb11d2a5513" args="" -->
  60. ILenum&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#f36941d08ffdd7ed7c42cdb11d2a5513">Format</a></td></tr>
  61. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">image format (in IL enum style) <br></td></tr>
  62. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f84630dff97fdc18dcf1c8187f5e1918"></a><!-- doxytag: member="ILimage::Type" ref="f84630dff97fdc18dcf1c8187f5e1918" args="" -->
  63. ILenum&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#f84630dff97fdc18dcf1c8187f5e1918">Type</a></td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">image type (in IL enum style) <br></td></tr>
  65. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c2bc011c3f8a65eea30a8d4495c96a2e"></a><!-- doxytag: member="ILimage::Origin" ref="c2bc011c3f8a65eea30a8d4495c96a2e" args="" -->
  66. ILenum&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#c2bc011c3f8a65eea30a8d4495c96a2e">Origin</a></td></tr>
  67. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">origin of the image <br></td></tr>
  68. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e17c6b3c912a9bcddb50dd7a61011a7"></a><!-- doxytag: member="ILimage::Pal" ref="1e17c6b3c912a9bcddb50dd7a61011a7" args="" -->
  69. <a class="el" href="structILpal.html">ILpal</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#1e17c6b3c912a9bcddb50dd7a61011a7">Pal</a></td></tr>
  70. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">palette details <br></td></tr>
  71. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fde5827e053680ff1e81a9a9c0832042"></a><!-- doxytag: member="ILimage::Duration" ref="fde5827e053680ff1e81a9a9c0832042" args="" -->
  72. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#fde5827e053680ff1e81a9a9c0832042">Duration</a></td></tr>
  73. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">length of the time to display this "frame" <br></td></tr>
  74. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20bd452e1573aa08c7d9687190cbfa89"></a><!-- doxytag: member="ILimage::CubeFlags" ref="20bd452e1573aa08c7d9687190cbfa89" args="" -->
  75. ILenum&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#20bd452e1573aa08c7d9687190cbfa89">CubeFlags</a></td></tr>
  76. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cube map flags for sides present in chain <br></td></tr>
  77. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fa2c8bedcd1178760327302911969035"></a><!-- doxytag: member="ILimage::Mipmaps" ref="fa2c8bedcd1178760327302911969035" args="" -->
  78. struct <a class="el" href="structILimage.html">ILimage</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#fa2c8bedcd1178760327302911969035">Mipmaps</a></td></tr>
  79. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mipmapped versions of this image terminated by a NULL - usu. NULL <br></td></tr>
  80. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbd033e6e25af697caa549be3deeb5ff"></a><!-- doxytag: member="ILimage::Next" ref="dbd033e6e25af697caa549be3deeb5ff" args="" -->
  81. struct <a class="el" href="structILimage.html">ILimage</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#dbd033e6e25af697caa549be3deeb5ff">Next</a></td></tr>
  82. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">next image in the chain - usu. NULL <br></td></tr>
  83. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42b8f93f02ab5e6c9623967a08e2d013"></a><!-- doxytag: member="ILimage::Faces" ref="42b8f93f02ab5e6c9623967a08e2d013" args="" -->
  84. struct <a class="el" href="structILimage.html">ILimage</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#42b8f93f02ab5e6c9623967a08e2d013">Faces</a></td></tr>
  85. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">next cubemap face in the chain - usu. NULL <br></td></tr>
  86. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="504d31f6b9c9d6da656f5eecb57bdd46"></a><!-- doxytag: member="ILimage::Layers" ref="504d31f6b9c9d6da656f5eecb57bdd46" args="" -->
  87. struct <a class="el" href="structILimage.html">ILimage</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#504d31f6b9c9d6da656f5eecb57bdd46">Layers</a></td></tr>
  88. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">subsequent layers in the chain - usu. NULL <br></td></tr>
  89. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b128f3c35d0617202e3ec8252af5fa03"></a><!-- doxytag: member="ILimage::AnimList" ref="b128f3c35d0617202e3ec8252af5fa03" args="" -->
  90. ILuint *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#b128f3c35d0617202e3ec8252af5fa03">AnimList</a></td></tr>
  91. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">animation list <br></td></tr>
  92. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70e6057f47ac13562d06c43e17f9be56"></a><!-- doxytag: member="ILimage::AnimSize" ref="70e6057f47ac13562d06c43e17f9be56" args="" -->
  93. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#70e6057f47ac13562d06c43e17f9be56">AnimSize</a></td></tr>
  94. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">animation list size <br></td></tr>
  95. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78a95799c50680f0301e83b3f09c010f"></a><!-- doxytag: member="ILimage::Profile" ref="78a95799c50680f0301e83b3f09c010f" args="" -->
  96. void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#78a95799c50680f0301e83b3f09c010f">Profile</a></td></tr>
  97. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">colour profile <br></td></tr>
  98. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03dcb37bc626f621f4c638fde928bf64"></a><!-- doxytag: member="ILimage::ProfileSize" ref="03dcb37bc626f621f4c638fde928bf64" args="" -->
  99. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#03dcb37bc626f621f4c638fde928bf64">ProfileSize</a></td></tr>
  100. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">colour profile size <br></td></tr>
  101. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0438126967c9e3fcdbf916776c7430c"></a><!-- doxytag: member="ILimage::OffX" ref="e0438126967c9e3fcdbf916776c7430c" args="" -->
  102. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#e0438126967c9e3fcdbf916776c7430c">OffX</a></td></tr>
  103. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">x-offset of the image <br></td></tr>
  104. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d0db9b9c3aa7399ff8fe82327e1cc42"></a><!-- doxytag: member="ILimage::OffY" ref="3d0db9b9c3aa7399ff8fe82327e1cc42" args="" -->
  105. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#3d0db9b9c3aa7399ff8fe82327e1cc42">OffY</a></td></tr>
  106. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">y-offset of the image <br></td></tr>
  107. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65df57fee0fb33328ef00fecb7709638"></a><!-- doxytag: member="ILimage::DxtcData" ref="65df57fee0fb33328ef00fecb7709638" args="" -->
  108. ILubyte *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#65df57fee0fb33328ef00fecb7709638">DxtcData</a></td></tr>
  109. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compressed data <br></td></tr>
  110. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="41c04c16ff79d67c0c20d726ea411805"></a><!-- doxytag: member="ILimage::DxtcFormat" ref="41c04c16ff79d67c0c20d726ea411805" args="" -->
  111. ILenum&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#41c04c16ff79d67c0c20d726ea411805">DxtcFormat</a></td></tr>
  112. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compressed data format <br></td></tr>
  113. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d423e11ee4e5076d92f6a7e863b2070"></a><!-- doxytag: member="ILimage::DxtcSize" ref="5d423e11ee4e5076d92f6a7e863b2070" args="" -->
  114. ILuint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structILimage.html#5d423e11ee4e5076d92f6a7e863b2070">DxtcSize</a></td></tr>
  115. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compressed data size <br></td></tr>
  116. </table>
  117. <hr><a name="_details"></a><h2>Detailed Description</h2>
  118. The Fundamental Image structure.
  119. <p>
  120. Every bit of information about an image is stored in this internal structure. <hr>The documentation for this struct was generated from the following file:<ul>
  121. <li>/home/dwoods/DevIL/include/IL/<a class="el" href="devil__internal__exports_8h-source.html">devil_internal_exports.h</a></ul>
  122. </div>
  123. <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 8 20:01:42 2009 for DevIL by&nbsp;
  124. <a href="http://www.doxygen.org/index.html">
  125. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  126. </body>
  127. </html>