TIFFWriteEncodedTile.3tiff.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!-- Creator : groff version 1.18.1 -->
  2. <!-- CreationDate: Sat Feb 24 18:37:18 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>TIFFWriteEncodedTile</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFWriteEncodedTile</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><big>TIFFWritedEncodedTile &minus; compress and write a
  28. tile of data to an open</big> TIFF <big>file</big></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><big><b>#include &lt;tiffio.h&gt;</b></big></p>
  40. <!-- INDENTATION -->
  41. <p><big><b>tsize_t TIFFWriteEncodedTile(TIFF
  42. *</b><i>tif</i><b>, ttile_t</b> <i>tile</i><b>, tdata_t</b>
  43. <i>buf</i><b>, tsize_t</b> <i>size</i><b>)</b></big></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><big>Compress <i>size</i> bytes of raw data from
  55. <i>buf</i> and <b>append</b> the result to the end of the
  56. specified tile. Note that the value of <i>tile</i> is a
  57. &lsquo;&lsquo;raw tile number.&rsquo;&rsquo; That is, the
  58. caller must take into account whether or not the data are
  59. organized in separate places (<i>PlanarConfiguration</i>=2).
  60. <i>TIFFComputeTile</i> automatically does this when
  61. converting an (x,y,z,sample) coordinate quadruple to a tile
  62. number.</big></p>
  63. </td>
  64. </table>
  65. <a name="NOTES"></a>
  66. <h2>NOTES</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><big>The library writes encoded data using the native
  74. machine byte order. Correctly implemented</big> TIFF
  75. <big>readers are expected to do any necessary byte-swapping
  76. to correctly process image data with BitsPerSample greater
  77. than 8.</big></p>
  78. </td>
  79. </table>
  80. <a name="RETURN VALUES"></a>
  81. <h2>RETURN VALUES</h2>
  82. <!-- INDENTATION -->
  83. <table width="100%" border=0 rules="none" frame="void"
  84. cols="2" cellspacing="0" cellpadding="0">
  85. <tr valign="top" align="left">
  86. <td width="8%"></td>
  87. <td width="91%">
  88. <p><big>&minus;1 is returned if an error was encountered.
  89. Otherwise, the value of <i>size</i> is returned.</big></p>
  90. </td>
  91. </table>
  92. <a name="DIAGNOSTICS"></a>
  93. <h2>DIAGNOSTICS</h2>
  94. <!-- INDENTATION -->
  95. <table width="100%" border=0 rules="none" frame="void"
  96. cols="2" cellspacing="0" cellpadding="0">
  97. <tr valign="top" align="left">
  98. <td width="8%"></td>
  99. <td width="91%">
  100. <p><big>All error messages are directed to the
  101. <b>TIFFError</b>(3TIFF) routine.</big></p>
  102. <!-- INDENTATION -->
  103. <p><big><b>%s: File not open for writing</b>. The file was
  104. opened for reading, not writing.</big></p>
  105. <!-- INDENTATION -->
  106. <p><big><b>Can not write tiles to a stripped image</b>. The
  107. image is assumed to be organized in strips because neither
  108. of the <i>TileWidth</i> or <i>TileLength</i> tags have been
  109. set with <b>TIFFSetField</b>(3TIFF).</big></p>
  110. <!-- INDENTATION -->
  111. <p><big><b>%s: Must set &quot;ImageWidth&quot; before
  112. writing data</b>. The image&rsquo;s width has not be set
  113. before the first write. See <b>TIFFSetField</b>(3TIFF) for
  114. information on how to do this.</big></p>
  115. <!-- INDENTATION -->
  116. <p><big><b>%s: Must set &quot;PlanarConfiguration&quot;
  117. before writing data</b>. The organization of data has not be
  118. defined before the first write. See
  119. <b>TIFFSetField</b>(3TIFF) for information on how to do
  120. this.</big></p>
  121. <!-- INDENTATION -->
  122. <p><big><b>%s: No space for tile arrays&quot;</b>. There was
  123. not enough space for the arrays that hold tile offsets and
  124. byte counts.</big></p>
  125. </td>
  126. </table>
  127. <a name="SEE ALSO"></a>
  128. <h2>SEE ALSO</h2>
  129. <!-- INDENTATION -->
  130. <table width="100%" border=0 rules="none" frame="void"
  131. cols="2" cellspacing="0" cellpadding="0">
  132. <tr valign="top" align="left">
  133. <td width="8%"></td>
  134. <td width="91%">
  135. <p><big><b>TIFFOpen</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF),
  136. <b>TIFFWriteRawTile</b>(3TIFF),
  137. <b>libtiff</b>(3TIFF)</big></p>
  138. <!-- INDENTATION -->
  139. <p><big>Libtiff library home page:
  140. <b>http://www.simplesystems.org/libtiff/</b></big></p>
  141. </td>
  142. </table>
  143. <hr>
  144. </body>
  145. </html>