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