TIFFReadTile.3tiff.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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>TIFFReadTile</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFReadTile</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>TIFFReadTile &minus; read and decode a tile of data from
  28. 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>tsize_t TIFFReadTile(TIFF *</b><i>tif</i><b>,
  42. tdata_t</b> <i>buf</i><b>, uint32_t</b> <i>x</i><b>,
  43. uint32_t</b> <i>y</i><b>, uint32_t</b> <i>z</i><b>,
  44. tsample_t</b> <i>sample</i><b>)</b></p>
  45. </td>
  46. </table>
  47. <a name="DESCRIPTION"></a>
  48. <h2>DESCRIPTION</h2>
  49. <!-- INDENTATION -->
  50. <table width="100%" border=0 rules="none" frame="void"
  51. cols="2" cellspacing="0" cellpadding="0">
  52. <tr valign="top" align="left">
  53. <td width="8%"></td>
  54. <td width="91%">
  55. <p>Return the data for the tile <i>containing</i> the
  56. specified coordinates. The data placed in <i>buf</i> are
  57. returned decompressed and, typically, in the native byte-
  58. and bit-ordering, but are otherwise packed (see further
  59. below). The buffer must be large enough to hold an entire
  60. tile of data. Applications should call the routine
  61. <i>TIFFTileSize</i> to find out the size (in bytes) of a
  62. tile buffer. The <i>x</i> and <i>y</i> parameters are always
  63. used by <i>TIFFReadTile</i>. The <i>z</i> parameter is used
  64. if the image is deeper than 1 slice
  65. (<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter is
  66. used only if data are organized in separate planes
  67. (<i>PlanarConfiguration</i>=2).</p>
  68. </td>
  69. </table>
  70. <a name="NOTES"></a>
  71. <h2>NOTES</h2>
  72. <!-- INDENTATION -->
  73. <table width="100%" border=0 rules="none" frame="void"
  74. cols="2" cellspacing="0" cellpadding="0">
  75. <tr valign="top" align="left">
  76. <td width="8%"></td>
  77. <td width="91%">
  78. <p>The library attempts to hide bit- and byte-ordering
  79. differences between the image and the native machine by
  80. converting data to the native machine order. Bit reversal is
  81. done if the <i>FillOrder</i> tag is opposite to the native
  82. machine bit order. 16- and 32-bit samples are automatically
  83. byte-swapped if the file was written with a byte order
  84. opposite to the native machine byte order,</p>
  85. </td>
  86. </table>
  87. <a name="RETURN VALUES"></a>
  88. <h2>RETURN VALUES</h2>
  89. <!-- INDENTATION -->
  90. <table width="100%" border=0 rules="none" frame="void"
  91. cols="2" cellspacing="0" cellpadding="0">
  92. <tr valign="top" align="left">
  93. <td width="8%"></td>
  94. <td width="91%">
  95. <p><i>TIFFReadTile</i> returns &minus;1 if it detects an
  96. error; otherwise the number of bytes in the decoded tile is
  97. returned.</p>
  98. </td>
  99. </table>
  100. <a name="DIAGNOSTICS"></a>
  101. <h2>DIAGNOSTICS</h2>
  102. <!-- INDENTATION -->
  103. <table width="100%" border=0 rules="none" frame="void"
  104. cols="2" cellspacing="0" cellpadding="0">
  105. <tr valign="top" align="left">
  106. <td width="8%"></td>
  107. <td width="91%">
  108. <p>All error messages are directed to the
  109. <b>TIFFError</b>(3TIFF) routine.</p>
  110. </td>
  111. </table>
  112. <a name="SEE ALSO"></a>
  113. <h2>SEE ALSO</h2>
  114. <!-- INDENTATION -->
  115. <table width="100%" border=0 rules="none" frame="void"
  116. cols="2" cellspacing="0" cellpadding="0">
  117. <tr valign="top" align="left">
  118. <td width="8%"></td>
  119. <td width="91%">
  120. <p><b>TIFFCheckTile</b>(3TIFF),
  121. <b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF),
  122. <b>TIFFReadEncodedTile</b>(3TIFF),
  123. <b>TIFFReadRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
  124. <!-- INDENTATION -->
  125. <p>Libtiff library home page:
  126. <b>http://www.simplesystems.org/libtiff/</b></p>
  127. </td>
  128. </table>
  129. <hr>
  130. </body>
  131. </html>