TIFFWriteEncodedStrip.3tiff.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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>TIFFWriteEncodedStrip</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFWriteEncodedStrip</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>TIFFWritedEncodedStrip &minus; compress and write a
  28. strip 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 TIFFWriteEncodedStrip(TIFF
  42. *</b><i>tif</i><b>, tstrip_t</b> <i>strip</i><b>,
  43. tdata_t</b> <i>buf</i><b>, tsize_t</b>
  44. <i>size</i><b>)</b></big></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><big>Compress <i>size</i> bytes of raw data from
  56. <i>buf</i> and write the result to the specified strip;
  57. replacing any previously written data. Note that the value
  58. of <i>strip</i> is a &lsquo;&lsquo;raw strip
  59. number.&rsquo;&rsquo; That is, the caller must take into
  60. account whether or not the data are organized in separate
  61. planes (<i>PlanarConfiguration</i>=2).</big></p>
  62. </td>
  63. </table>
  64. <a name="NOTES"></a>
  65. <h2>NOTES</h2>
  66. <!-- INDENTATION -->
  67. <table width="100%" border=0 rules="none" frame="void"
  68. cols="2" cellspacing="0" cellpadding="0">
  69. <tr valign="top" align="left">
  70. <td width="8%"></td>
  71. <td width="91%">
  72. <p><big>The library writes encoded data using the native
  73. machine byte order. Correctly implemented</big> TIFF
  74. <big>readers are expected to do any necessary byte-swapping
  75. to correctly process image data with BitsPerSample greater
  76. than 8.</big></p>
  77. <!-- INDENTATION -->
  78. <p><big>The strip number must be valid according to the
  79. current settings of the <i>ImageLength</i> and
  80. <i>RowsPerStrip</i> tags. An image may be dynamically grown
  81. by increasing the value of <i>ImageLength</i> prior to each
  82. call to <i>TIFFWriteEncodedStrip</i>.</big></p>
  83. </td>
  84. </table>
  85. <a name="RETURN VALUES"></a>
  86. <h2>RETURN VALUES</h2>
  87. <!-- INDENTATION -->
  88. <table width="100%" border=0 rules="none" frame="void"
  89. cols="2" cellspacing="0" cellpadding="0">
  90. <tr valign="top" align="left">
  91. <td width="8%"></td>
  92. <td width="91%">
  93. <p><big>&minus;1 is returned if an error was encountered.
  94. Otherwise, the value of <i>size</i> is returned.</big></p>
  95. </td>
  96. </table>
  97. <a name="DIAGNOSTICS"></a>
  98. <h2>DIAGNOSTICS</h2>
  99. <!-- INDENTATION -->
  100. <table width="100%" border=0 rules="none" frame="void"
  101. cols="2" cellspacing="0" cellpadding="0">
  102. <tr valign="top" align="left">
  103. <td width="8%"></td>
  104. <td width="91%">
  105. <p><big>All error messages are directed to the
  106. <i>TIFFError</i>(3TIFF) routine.</big></p>
  107. <!-- INDENTATION -->
  108. <p><big><b>%s: File not open for writing</b>. The file was
  109. opened for reading, not writing.</big></p>
  110. <!-- INDENTATION -->
  111. <p><big><b>Can not write scanlines to a tiled image</b>. The
  112. image is assumed to be organized in tiles because the
  113. <i>TileWidth</i> and <i>TileLength</i> tags have been set
  114. with <i>TIFFSetField</i>(3TIFF).</big></p>
  115. <!-- INDENTATION -->
  116. <p><big><b>%s: Must set &quot;ImageWidth&quot; before
  117. writing data</b>. The image&rsquo;s width has not be set
  118. before the first write. See <i>TIFFSetField</i>(3TIFF) for
  119. information on how to do this.</big></p>
  120. <!-- INDENTATION -->
  121. <p><big><b>%s: Must set &quot;PlanarConfiguration&quot;
  122. before writing data</b>. The organization of data has not be
  123. defined before the first write. See
  124. <i>TIFFSetField</i>(3TIFF) for information on how to do
  125. this.</big></p>
  126. <!-- INDENTATION -->
  127. <p><big><b>%s: No space for strip arrays&quot;</b>. There
  128. was not enough space for the arrays that hold strip offsets
  129. and byte counts.</big></p>
  130. </td>
  131. </table>
  132. <a name="SEE ALSO"></a>
  133. <h2>SEE ALSO</h2>
  134. <!-- INDENTATION -->
  135. <table width="100%" border=0 rules="none" frame="void"
  136. cols="2" cellspacing="0" cellpadding="0">
  137. <tr valign="top" align="left">
  138. <td width="8%"></td>
  139. <td width="91%">
  140. <p><big><b>TIFFOpen</b>(3TIFF),
  141. <b>TIFFWriteScanline</b>(3TIFF),
  142. <b>TIFFWriteRawStrip</b>(3TIFF),
  143. <b>libtiff</b>(3TIFF)</big></p>
  144. <!-- INDENTATION -->
  145. <p><big>Libtiff library home page:
  146. <b>http://www.simplesystems.org/libtiff/</b></big></p>
  147. </td>
  148. </table>
  149. <hr>
  150. </body>
  151. </html>