TIFFReadRawTile.3tiff.html 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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>TIFFReadRawTile</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFReadRawTile</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="#RETURN VALUES">RETURN VALUES</a><br>
  15. <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
  16. <a href="#SEE ALSO">SEE ALSO</a><br>
  17. <hr>
  18. <a name="NAME"></a>
  19. <h2>NAME</h2>
  20. <!-- INDENTATION -->
  21. <table width="100%" border=0 rules="none" frame="void"
  22. cols="2" cellspacing="0" cellpadding="0">
  23. <tr valign="top" align="left">
  24. <td width="8%"></td>
  25. <td width="91%">
  26. <p>TIFFReadRawTile &minus; return an undecoded tile of data
  27. from an open <small>TIFF</small> file</p>
  28. </td>
  29. </table>
  30. <a name="SYNOPSIS"></a>
  31. <h2>SYNOPSIS</h2>
  32. <!-- INDENTATION -->
  33. <table width="100%" border=0 rules="none" frame="void"
  34. cols="2" cellspacing="0" cellpadding="0">
  35. <tr valign="top" align="left">
  36. <td width="8%"></td>
  37. <td width="91%">
  38. <p><b>#include &lt;tiffio.h&gt;</b></p>
  39. <!-- INDENTATION -->
  40. <p><b>tsize_t TIFFReadRawTile(TIFF *</b><i>tif</i><b>,
  41. ttile_t</b> <i>tile</i><b>, tdata_t</b> <i>buf</i><b>,
  42. tsize_t</b> <i>size</i><b>)</b></p>
  43. </td>
  44. </table>
  45. <a name="DESCRIPTION"></a>
  46. <h2>DESCRIPTION</h2>
  47. <!-- INDENTATION -->
  48. <table width="100%" border=0 rules="none" frame="void"
  49. cols="2" cellspacing="0" cellpadding="0">
  50. <tr valign="top" align="left">
  51. <td width="8%"></td>
  52. <td width="91%">
  53. <p>Read the contents of the specified tile into the (user
  54. supplied) data buffer. Note that the value of <i>tile</i> is
  55. a &lsquo;&lsquo;raw tile number.&rsquo;&rsquo; That is, the
  56. caller must take into account whether or not the data is
  57. organized in separate planes (<i>PlanarConfiguration</i>=2).
  58. <i>TIFFComputeTile</i> automatically does this when
  59. converting an (x,y,z,sample) coordinate quadruple to a tile
  60. number. To read a full tile of data the data buffer should
  61. typically be at least as large as the value returned by
  62. <i>TIFFTileSize</i>.</p>
  63. </td>
  64. </table>
  65. <a name="RETURN VALUES"></a>
  66. <h2>RETURN VALUES</h2>
  67. <!-- INDENTATION -->
  68. <table width="100%" border=0 rules="none" frame="void"
  69. cols="2" cellspacing="0" cellpadding="0">
  70. <tr valign="top" align="left">
  71. <td width="8%"></td>
  72. <td width="91%">
  73. <p>The actual number of bytes of data that were placed in
  74. <i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns
  75. &minus;1 if an error was encountered.</p>
  76. </td>
  77. </table>
  78. <a name="DIAGNOSTICS"></a>
  79. <h2>DIAGNOSTICS</h2>
  80. <!-- INDENTATION -->
  81. <table width="100%" border=0 rules="none" frame="void"
  82. cols="2" cellspacing="0" cellpadding="0">
  83. <tr valign="top" align="left">
  84. <td width="8%"></td>
  85. <td width="91%">
  86. <p>All error messages are directed to the
  87. <b>TIFFError</b>(3TIFF) routine.</p>
  88. </td>
  89. </table>
  90. <a name="SEE ALSO"></a>
  91. <h2>SEE ALSO</h2>
  92. <!-- INDENTATION -->
  93. <table width="100%" border=0 rules="none" frame="void"
  94. cols="2" cellspacing="0" cellpadding="0">
  95. <tr valign="top" align="left">
  96. <td width="8%"></td>
  97. <td width="91%">
  98. <p><b>TIFFOpen</b>(3TIFF),
  99. <b>TIFFReadEncodedTile</b>(3TIFF),
  100. <b>TIFFReadTile</b>(3TIFF), <b>TIFFTileSize</b>(3TIFF),
  101. <b>libtiff</b>(3TIFF)</p>
  102. <!-- INDENTATION -->
  103. <p>Libtiff library home page:
  104. <b>http://www.remotesensing.org/libtiff/</b></p>
  105. </td>
  106. </table>
  107. <hr>
  108. </body>
  109. </html>