TIFFReadEncodedTile.3tiff.html 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. <!-- Creator : groff version 1.18.1 -->
  2. <!-- CreationDate: Sat Feb 24 18:37:17 2007 -->
  3. <html>
  4. <head>
  5. <meta name="generator" content="groff -Thtml, see www.gnu.org">
  6. <meta name="Content-Style" content="text/css">
  7. <title>TIFFReadEncodedTile</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFReadEncodedTile</h1>
  11. <a href="#NAME">NAME</a><br>
  12. <a href="#SYNOPSIS">SYNOPSIS</a><br>
  13. <a href="#DESCRIPTION">DESCRIPTION</a><br>
  14. <a href="#NOTES">NOTES</a><br>
  15. <a href="#RETURN VALUES">RETURN VALUES</a><br>
  16. <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
  17. <a href="#SEE ALSO">SEE ALSO</a><br>
  18. <hr>
  19. <a name="NAME"></a>
  20. <h2>NAME</h2>
  21. <!-- INDENTATION -->
  22. <table width="100%" border=0 rules="none" frame="void"
  23. cols="2" cellspacing="0" cellpadding="0">
  24. <tr valign="top" align="left">
  25. <td width="8%"></td>
  26. <td width="91%">
  27. <p>TIFFReadEncodedTile &minus; read and decode a tile of
  28. data from an open <small>TIFF</small> file</p>
  29. </td>
  30. </table>
  31. <a name="SYNOPSIS"></a>
  32. <h2>SYNOPSIS</h2>
  33. <!-- INDENTATION -->
  34. <table width="100%" border=0 rules="none" frame="void"
  35. cols="2" cellspacing="0" cellpadding="0">
  36. <tr valign="top" align="left">
  37. <td width="8%"></td>
  38. <td width="91%">
  39. <p><b>#include &lt;tiffio.h&gt;</b></p>
  40. <!-- INDENTATION -->
  41. <p><b>int TIFFReadEncodedTile(TIFF *</b><i>tif</i><b>,
  42. ttile_t</b> <i>tile</i><b>, tdata_t</b> <i>buf</i><b>,
  43. tsize_t</b> <i>size</i><b>)</b></p>
  44. </td>
  45. </table>
  46. <a name="DESCRIPTION"></a>
  47. <h2>DESCRIPTION</h2>
  48. <!-- INDENTATION -->
  49. <table width="100%" border=0 rules="none" frame="void"
  50. cols="2" cellspacing="0" cellpadding="0">
  51. <tr valign="top" align="left">
  52. <td width="8%"></td>
  53. <td width="91%">
  54. <p>Read the specified tile of data and place up to
  55. <i>size</i> bytes of decompressed information in the (user
  56. supplied) data buffer.</p>
  57. </td>
  58. </table>
  59. <a name="NOTES"></a>
  60. <h2>NOTES</h2>
  61. <!-- INDENTATION -->
  62. <table width="100%" border=0 rules="none" frame="void"
  63. cols="2" cellspacing="0" cellpadding="0">
  64. <tr valign="top" align="left">
  65. <td width="8%"></td>
  66. <td width="91%">
  67. <p>The value of <i>tile</i> is a &lsquo;&lsquo;raw tile
  68. number.&rsquo;&rsquo; That is, the caller must take into
  69. account whether or not the data are organized in separate
  70. planes (<i>PlanarConfiguration</i>=2).
  71. <i>TIFFComputeTile</i> automatically does this when
  72. converting an (x,y,z,sample) coordinate quadruple to a tile
  73. number. To read a full tile of data the data buffer should
  74. be at least as large as the value returned by
  75. <i>TIFFTileSize</i>.</p>
  76. <!-- INDENTATION -->
  77. <p>The library attempts to hide bit- and byte-ordering
  78. differences between the image and the native machine by
  79. converting data to the native machine order. Bit reversal is
  80. done if the <i>FillOrder</i> tag is opposite to the native
  81. machine bit order. 16- and 32-bit samples are automatically
  82. byte-swapped if the file was written with a byte order
  83. opposite to the native machine byte order,</p>
  84. </td>
  85. </table>
  86. <a name="RETURN VALUES"></a>
  87. <h2>RETURN VALUES</h2>
  88. <!-- INDENTATION -->
  89. <table width="100%" border=0 rules="none" frame="void"
  90. cols="2" cellspacing="0" cellpadding="0">
  91. <tr valign="top" align="left">
  92. <td width="8%"></td>
  93. <td width="91%">
  94. <p>The actual number of bytes of data that were placed in
  95. <i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns
  96. &minus;1 if an error was encountered.</p>
  97. </td>
  98. </table>
  99. <a name="DIAGNOSTICS"></a>
  100. <h2>DIAGNOSTICS</h2>
  101. <!-- INDENTATION -->
  102. <table width="100%" border=0 rules="none" frame="void"
  103. cols="2" cellspacing="0" cellpadding="0">
  104. <tr valign="top" align="left">
  105. <td width="8%"></td>
  106. <td width="91%">
  107. <p>All error messages are directed to the
  108. <b>TIFFError</b>(3TIFF) routine.</p>
  109. </td>
  110. </table>
  111. <a name="SEE ALSO"></a>
  112. <h2>SEE ALSO</h2>
  113. <!-- INDENTATION -->
  114. <table width="100%" border=0 rules="none" frame="void"
  115. cols="2" cellspacing="0" cellpadding="0">
  116. <tr valign="top" align="left">
  117. <td width="8%"></td>
  118. <td width="91%">
  119. <p><b>TIFFOpen</b>(3TIFF), <b>TIFFReadRawTile</b>(3TIFF),
  120. <b>TIFFReadTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
  121. <!-- INDENTATION -->
  122. <p>Libtiff library home page:
  123. <b>http://www.simplesystems.org/libtiff/</b></p>
  124. </td>
  125. </table>
  126. <hr>
  127. </body>
  128. </html>