TIFFtile.3tiff.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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>TIFFTILE</title>
  8. </head>
  9. <body>
  10. <h1 align=center>TIFFTILE</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="#DIAGNOSTICS">DIAGNOSTICS</a><br>
  15. <a href="#SEE ALSO">SEE ALSO</a><br>
  16. <hr>
  17. <a name="NAME"></a>
  18. <h2>NAME</h2>
  19. <!-- INDENTATION -->
  20. <table width="100%" border=0 rules="none" frame="void"
  21. cols="2" cellspacing="0" cellpadding="0">
  22. <tr valign="top" align="left">
  23. <td width="8%"></td>
  24. <td width="91%">
  25. <p>TIFFTileSize, TIFFTileRowSize, TIFFVTileSize,
  26. TIFFDefaultTileSize, TIFFComputeTile, TIFFCheckTile,
  27. TIFFNumberOfTiles &minus; tile-related utility routines</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>void TIFFDefaultTileSize(TIFF *</b><i>tif</i><b>,
  41. uint32_t *</b><i>tw</i><b>, uint32_t *</b><i>th</i><b>)<br>
  42. tsize_t TIFFTileSize(TIFF *</b><i>tif</i><b>)<br>
  43. tsize_t TIFFTileRowSize(TIFF *</b><i>tif</i><b>)<br>
  44. tsize_t TIFFVTileSize(TIFF *</b><i>tif</i><b>, uint32_t</b>
  45. <i>nrows</i><b>)<br>
  46. ttile_t TIFFComputeTile(TIFF *</b><i>tif</i><b>, uint32_t</b>
  47. <i>x</i><b>, uint32_t</b> <i>y</i><b>, uint32_t</b> <i>z</i><b>,
  48. tsample_t</b> <i>sample</i><b>)<br>
  49. int TIFFCheckTile(TIFF *</b><i>tif</i><b>, uint32_t</b>
  50. <i>x</i><b>, uint32_t</b> <i>y</i><b>, uint32_t</b> <i>z</i><b>,
  51. tsample_t</b> <i>sample</i><b>)<br>
  52. ttile_t TIFFNumberOfTiles(TIFF *</b><i>tif</i><b>)</b></p>
  53. </td>
  54. </table>
  55. <a name="DESCRIPTION"></a>
  56. <h2>DESCRIPTION</h2>
  57. <!-- INDENTATION -->
  58. <table width="100%" border=0 rules="none" frame="void"
  59. cols="2" cellspacing="0" cellpadding="0">
  60. <tr valign="top" align="left">
  61. <td width="8%"></td>
  62. <td width="91%">
  63. <p><i>TIFFDefaultTileSize</i> returns the pixel width and
  64. height of a reasonable-sized tile; suitable for setting up
  65. the <i>TileWidth</i> and <i>TileLength</i> tags. If the
  66. <i>tw</i> and <i>th</i> values passed in are non-zero, then
  67. they are adjusted to reflect any compression-specific
  68. requirements. The returned width and height are constrained
  69. to be a multiple of 16 pixels to conform with the
  70. <small>TIFF</small> specification.</p>
  71. <!-- INDENTATION -->
  72. <p><i>TIFFTileSize</i> returns the equivalent size for a
  73. tile of data as it would be returned in a call to
  74. <i>TIFFReadTile</i> or as it would be expected in a call to
  75. <i>TIFFWriteTile</i>.</p>
  76. <!-- INDENTATION -->
  77. <p><i>TIFFVTileSize</i> returns the number of bytes in a
  78. row-aligned tile with <i>nrows</i> of data.</p>
  79. <!-- INDENTATION -->
  80. <p><i>TIFFTileRowSize</i> returns the number of bytes of a
  81. row of data in a tile.</p>
  82. <!-- INDENTATION -->
  83. <p><i>TIFFComputeTile</i> returns the tile that contains the
  84. specified coordinates. A valid tile is always returned;
  85. out-of-range coordinate values are clamped to the bounds of
  86. the image. The <i>x</i> and <i>y</i> parameters are always
  87. used in calculating a tile. The <i>z</i> parameter is used
  88. if the image is deeper than 1 slice
  89. (<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter is
  90. used only if data are organized in separate planes
  91. (<i>PlanarConfiguration</i>=2).</p>
  92. <!-- INDENTATION -->
  93. <p><i>TIFFCheckTile</i> returns a non-zero value if the
  94. supplied coordinates are within the bounds of the image and
  95. zero otherwise. The <i>x</i> parameter is checked against
  96. the value of the <i>ImageWidth</i> tag. The <i>y</i>
  97. parameter is checked against the value of the
  98. <i>ImageLength</i> tag. The <i>z</i> parameter is checked
  99. against the value of the <i>ImageDepth</i> tag (if defined).
  100. The <i>sample</i> parameter is checked against the value of
  101. the <i>SamplesPerPixel</i> parameter if the data are
  102. organized in separate planes.</p>
  103. <!-- INDENTATION -->
  104. <p><i>TIFFNumberOfTiles</i> returns the number of tiles in
  105. the image.</p>
  106. </td>
  107. </table>
  108. <a name="DIAGNOSTICS"></a>
  109. <h2>DIAGNOSTICS</h2>
  110. <!-- INDENTATION -->
  111. <table width="100%" border=0 rules="none" frame="void"
  112. cols="2" cellspacing="0" cellpadding="0">
  113. <tr valign="top" align="left">
  114. <td width="8%"></td>
  115. <td width="91%">
  116. <p>None.</p>
  117. </td>
  118. </table>
  119. <a name="SEE ALSO"></a>
  120. <h2>SEE ALSO</h2>
  121. <!-- INDENTATION -->
  122. <table width="100%" border=0 rules="none" frame="void"
  123. cols="2" cellspacing="0" cellpadding="0">
  124. <tr valign="top" align="left">
  125. <td width="8%"></td>
  126. <td width="91%">
  127. <p><b>TIFFReadEncodedTile</b>(3TIFF),
  128. <b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF),
  129. <b>TIFFWriteEncodedTile</b>(3TIFF),
  130. <b>TIFFWriteRawTile</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF),
  131. <b>libtiff</b>(3TIFF)</p>
  132. <!-- INDENTATION -->
  133. <p>Libtiff library home page:
  134. <b>http://www.simplesystems.org/libtiff/</b></p>
  135. </td>
  136. </table>
  137. <hr>
  138. </body>
  139. </html>