1<!-- Creator     : groff version 1.19.2 -->
2<!-- CreationDate: Mon Jan  2 17:41:43 2006 -->
3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4"http://www.w3.org/TR/html4/loose.dtd">
5<html>
6<head>
7<meta name="generator" content="groff -Thtml, see www.gnu.org">
8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9<meta name="Content-Style" content="text/css">
10<style type="text/css">
11       p     { margin-top: 0; margin-bottom: 0; }
12       pre   { margin-top: 0; margin-bottom: 0; }
13       table { margin-top: 0; margin-bottom: 0; }
14</style>
15<title>TIFFReadTile</title>
16
17</head>
18<body>
19
20<h1 align=center>TIFFReadTile</h1>
21
22<a href="#NAME">NAME</a><br>
23<a href="#SYNOPSIS">SYNOPSIS</a><br>
24<a href="#DESCRIPTION">DESCRIPTION</a><br>
25<a href="#NOTES">NOTES</a><br>
26<a href="#RETURN VALUES">RETURN VALUES</a><br>
27<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
28<a href="#SEE ALSO">SEE ALSO</a><br>
29
30<hr>
31
32
33<a name="NAME"></a>
34<h2>NAME</h2>
35
36
37<p style="margin-left:11%; margin-top: 1em">TIFFReadTile
38&minus; read and decode a tile of data from an open
39<small>TIFF</small> file</p>
40
41<a name="SYNOPSIS"></a>
42<h2>SYNOPSIS</h2>
43
44
45<p style="margin-left:11%; margin-top: 1em"><b>#include
46&lt;tiffio.h&gt;</b></p>
47
48<p style="margin-left:11%; margin-top: 1em"><b>tsize_t
49TIFFReadTile(TIFF *</b><i>tif</i><b>, tdata_t</b>
50<i>buf</i><b>, uint32</b> <i>x</i><b>, uint32</b>
51<i>y</i><b>, uint32</b> <i>z</i><b>, tsample_t</b>
52<i>sample</i><b>)</b></p>
53
54<a name="DESCRIPTION"></a>
55<h2>DESCRIPTION</h2>
56
57
58<p style="margin-left:11%; margin-top: 1em">Return the data
59for the tile <i>containing</i> the specified coordinates.
60The data placed in <i>buf</i> are returned decompressed and,
61typically, in the native byte- and bit-ordering, but are
62otherwise packed (see further below). The buffer must be
63large enough to hold an entire tile of data. Applications
64should call the routine <i>TIFFTileSize</i> to find out the
65size (in bytes) of a tile buffer. The <i>x</i> and <i>y</i>
66parameters are always used by <i>TIFFReadTile</i>. The
67<i>z</i> parameter is used if the image is deeper than 1
68slice (<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter
69is used only if data are organized in separate planes
70(<i>PlanarConfiguration</i>=2).</p>
71
72<a name="NOTES"></a>
73<h2>NOTES</h2>
74
75
76<p style="margin-left:11%; margin-top: 1em">The library
77attempts to hide bit- and byte-ordering differences between
78the image and the native machine by converting data to the
79native machine order. Bit reversal is done if the
80<i>FillOrder</i> tag is opposite to the native machine bit
81order. 16- and 32-bit samples are automatically byte-swapped
82if the file was written with a byte order opposite to the
83native machine byte order,</p>
84
85<a name="RETURN VALUES"></a>
86<h2>RETURN VALUES</h2>
87
88
89
90<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadTile</i>
91returns &minus;1 if it detects an error; otherwise the
92number of bytes in the decoded tile is returned.</p>
93
94<a name="DIAGNOSTICS"></a>
95<h2>DIAGNOSTICS</h2>
96
97
98<p style="margin-left:11%; margin-top: 1em">All error
99messages are directed to the <b>TIFFError</b>(3TIFF)
100routine.</p>
101
102<a name="SEE ALSO"></a>
103<h2>SEE ALSO</h2>
104
105
106
107<p style="margin-left:11%; margin-top: 1em"><b>TIFFCheckTile</b>(3TIFF),
108<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF),
109<b>TIFFReadEncodedTile</b>(3TIFF),
110<b>TIFFReadRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
111
112<p style="margin-left:11%; margin-top: 1em">Libtiff library
113home page: <b>http://www.remotesensing.org/libtiff/</b></p>
114<hr>
115</body>
116</html>
117