TIFFWriteTile.3tiff.html 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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>TIFFWriteTile</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFWriteTile</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>TIFFWriteTile &minus; encode and write a tile of data to
  27. 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 TIFFWriteTile(TIFF *</b><i>tif</i><b>,
  41. tdata_t</b> <i>buf</i><b>, uint32_t</b> <i>x</i><b>,
  42. uint32_t</b> <i>y</i><b>, uint32_t</b> <i>z</i><b>,
  43. tsample_t</b> <i>sample</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>Write the data for the tile <i>containing</i> the
  55. specified coordinates. The data in <i>buf</i> are is
  56. (potentially) compressed, and written to the indicated file,
  57. normally being appended to the end of the file. The buffer
  58. must be contain an entire tile of data. Applications should
  59. call the routine <i>TIFFTileSize</i> to find out the size
  60. (in bytes) of a tile buffer. The <i>x</i> and <i>y</i>
  61. parameters are always used by <i>TIFFWriteTile</i>. The
  62. <i>z</i> parameter is used if the image is deeper than 1
  63. slice (<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter
  64. is used only if data are organized in separate planes
  65. (<i>PlanarConfiguration</i>=2).</p>
  66. </td>
  67. </table>
  68. <a name="RETURN VALUES"></a>
  69. <h2>RETURN VALUES</h2>
  70. <!-- INDENTATION -->
  71. <table width="100%" border=0 rules="none" frame="void"
  72. cols="2" cellspacing="0" cellpadding="0">
  73. <tr valign="top" align="left">
  74. <td width="8%"></td>
  75. <td width="91%">
  76. <p><i>TIFFWriteTile</i> returns &minus;1 if it detects an
  77. error; otherwise the number of bytes in the tile is
  78. returned.</p>
  79. </td>
  80. </table>
  81. <a name="DIAGNOSTICS"></a>
  82. <h2>DIAGNOSTICS</h2>
  83. <!-- INDENTATION -->
  84. <table width="100%" border=0 rules="none" frame="void"
  85. cols="2" cellspacing="0" cellpadding="0">
  86. <tr valign="top" align="left">
  87. <td width="8%"></td>
  88. <td width="91%">
  89. <p>All error messages are directed to the
  90. <b>TIFFError</b>(3TIFF) routine.</p>
  91. </td>
  92. </table>
  93. <a name="SEE ALSO"></a>
  94. <h2>SEE ALSO</h2>
  95. <!-- INDENTATION -->
  96. <table width="100%" border=0 rules="none" frame="void"
  97. cols="2" cellspacing="0" cellpadding="0">
  98. <tr valign="top" align="left">
  99. <td width="8%"></td>
  100. <td width="91%">
  101. <p><b>TIFFCheckTile</b>(3TIFF),
  102. <b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF),
  103. <b>TIFFReadTile</b>(3TIFF), <b>TIFFWriteScanline</b>(3TIFF),
  104. <b>TIFFWriteEncodedTile</b>(3TIFF),
  105. <b>TIFFWriteRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
  106. <!-- INDENTATION -->
  107. <p>Libtiff library home page:
  108. <b>http://www.simplesystems.org/libtiff/</b></p>
  109. </td>
  110. </table>
  111. <hr>
  112. </body>
  113. </html>