10dcb9ef1SAndrey Kiselev<!-- Creator     : groff version 1.18.1 -->
2f14d1a56SAndrey Kiselev<!-- CreationDate: Sat Feb 24 18:37:17 2007 -->
387c5da6fSAndrey Kiselev<html>
487c5da6fSAndrey Kiselev<head>
587c5da6fSAndrey Kiselev<meta name="generator" content="groff -Thtml, see www.gnu.org">
687c5da6fSAndrey Kiselev<meta name="Content-Style" content="text/css">
787c5da6fSAndrey Kiselev<title>TIFFReadEncodedTile</title>
887c5da6fSAndrey Kiselev</head>
987c5da6fSAndrey Kiselev<body>
1087c5da6fSAndrey Kiselev
1187c5da6fSAndrey Kiselev<h1 align=center>TIFFReadEncodedTile</h1>
1287c5da6fSAndrey Kiselev<a href="#NAME">NAME</a><br>
1387c5da6fSAndrey Kiselev<a href="#SYNOPSIS">SYNOPSIS</a><br>
1487c5da6fSAndrey Kiselev<a href="#DESCRIPTION">DESCRIPTION</a><br>
1587c5da6fSAndrey Kiselev<a href="#NOTES">NOTES</a><br>
1687c5da6fSAndrey Kiselev<a href="#RETURN VALUES">RETURN VALUES</a><br>
1787c5da6fSAndrey Kiselev<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
1887c5da6fSAndrey Kiselev<a href="#SEE ALSO">SEE ALSO</a><br>
1987c5da6fSAndrey Kiselev
2087c5da6fSAndrey Kiselev<hr>
2187c5da6fSAndrey Kiselev<a name="NAME"></a>
2287c5da6fSAndrey Kiselev<h2>NAME</h2>
230dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
240dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
250dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
260dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
270dcb9ef1SAndrey Kiselev<td width="8%"></td>
280dcb9ef1SAndrey Kiselev<td width="91%">
290dcb9ef1SAndrey Kiselev<p>TIFFReadEncodedTile &minus; read and decode a tile of
300dcb9ef1SAndrey Kiselevdata from an open <small>TIFF</small> file</p>
310dcb9ef1SAndrey Kiselev</td>
320dcb9ef1SAndrey Kiselev</table>
3387c5da6fSAndrey Kiselev<a name="SYNOPSIS"></a>
3487c5da6fSAndrey Kiselev<h2>SYNOPSIS</h2>
350dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
360dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
370dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
380dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
390dcb9ef1SAndrey Kiselev<td width="8%"></td>
400dcb9ef1SAndrey Kiselev<td width="91%">
410dcb9ef1SAndrey Kiselev<p><b>#include &lt;tiffio.h&gt;</b></p>
420dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
430dcb9ef1SAndrey Kiselev<p><b>int TIFFReadEncodedTile(TIFF *</b><i>tif</i><b>,
44ef833c65SAndrey Kiselevttile_t</b> <i>tile</i><b>, tdata_t</b> <i>buf</i><b>,
45ef833c65SAndrey Kiselevtsize_t</b> <i>size</i><b>)</b></p>
460dcb9ef1SAndrey Kiselev</td>
470dcb9ef1SAndrey Kiselev</table>
4887c5da6fSAndrey Kiselev<a name="DESCRIPTION"></a>
4987c5da6fSAndrey Kiselev<h2>DESCRIPTION</h2>
500dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
510dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
520dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
530dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
540dcb9ef1SAndrey Kiselev<td width="8%"></td>
550dcb9ef1SAndrey Kiselev<td width="91%">
560dcb9ef1SAndrey Kiselev<p>Read the specified tile of data and place up to
570dcb9ef1SAndrey Kiselev<i>size</i> bytes of decompressed information in the (user
580dcb9ef1SAndrey Kiselevsupplied) data buffer.</p>
590dcb9ef1SAndrey Kiselev</td>
600dcb9ef1SAndrey Kiselev</table>
6187c5da6fSAndrey Kiselev<a name="NOTES"></a>
6287c5da6fSAndrey Kiselev<h2>NOTES</h2>
630dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
640dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
650dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
660dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
670dcb9ef1SAndrey Kiselev<td width="8%"></td>
680dcb9ef1SAndrey Kiselev<td width="91%">
690dcb9ef1SAndrey Kiselev<p>The value of <i>tile</i> is a &lsquo;&lsquo;raw tile
7087c5da6fSAndrey Kiselevnumber.&rsquo;&rsquo; That is, the caller must take into
7187c5da6fSAndrey Kiselevaccount whether or not the data are organized in separate
7287c5da6fSAndrey Kiselevplanes (<i>PlanarConfiguration</i>=2).
7387c5da6fSAndrey Kiselev<i>TIFFComputeTile</i> automatically does this when
7487c5da6fSAndrey Kiselevconverting an (x,y,z,sample) coordinate quadruple to a tile
7587c5da6fSAndrey Kiselevnumber. To read a full tile of data the data buffer should
7687c5da6fSAndrey Kiselevbe at least as large as the value returned by
7787c5da6fSAndrey Kiselev<i>TIFFTileSize</i>.</p>
780dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
790dcb9ef1SAndrey Kiselev<p>The library attempts to hide bit- and byte-ordering
800dcb9ef1SAndrey Kiselevdifferences between the image and the native machine by
810dcb9ef1SAndrey Kiselevconverting data to the native machine order. Bit reversal is
820dcb9ef1SAndrey Kiselevdone if the <i>FillOrder</i> tag is opposite to the native
830dcb9ef1SAndrey Kiselevmachine bit order. 16- and 32-bit samples are automatically
840dcb9ef1SAndrey Kiselevbyte-swapped if the file was written with a byte order
850dcb9ef1SAndrey Kiselevopposite to the native machine byte order,</p>
860dcb9ef1SAndrey Kiselev</td>
870dcb9ef1SAndrey Kiselev</table>
8887c5da6fSAndrey Kiselev<a name="RETURN VALUES"></a>
8987c5da6fSAndrey Kiselev<h2>RETURN VALUES</h2>
900dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
910dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
920dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
930dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
940dcb9ef1SAndrey Kiselev<td width="8%"></td>
950dcb9ef1SAndrey Kiselev<td width="91%">
960dcb9ef1SAndrey Kiselev<p>The actual number of bytes of data that were placed in
970dcb9ef1SAndrey Kiselev<i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns
980dcb9ef1SAndrey Kiselev&minus;1 if an error was encountered.</p>
990dcb9ef1SAndrey Kiselev</td>
1000dcb9ef1SAndrey Kiselev</table>
10187c5da6fSAndrey Kiselev<a name="DIAGNOSTICS"></a>
10287c5da6fSAndrey Kiselev<h2>DIAGNOSTICS</h2>
1030dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1040dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
1050dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
1060dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
1070dcb9ef1SAndrey Kiselev<td width="8%"></td>
1080dcb9ef1SAndrey Kiselev<td width="91%">
1090dcb9ef1SAndrey Kiselev<p>All error messages are directed to the
1100dcb9ef1SAndrey Kiselev<b>TIFFError</b>(3TIFF) routine.</p>
1110dcb9ef1SAndrey Kiselev</td>
1120dcb9ef1SAndrey Kiselev</table>
11387c5da6fSAndrey Kiselev<a name="SEE ALSO"></a>
11487c5da6fSAndrey Kiselev<h2>SEE ALSO</h2>
1150dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1160dcb9ef1SAndrey Kiselev<table width="100%" border=0 rules="none" frame="void"
1170dcb9ef1SAndrey Kiselev       cols="2" cellspacing="0" cellpadding="0">
1180dcb9ef1SAndrey Kiselev<tr valign="top" align="left">
1190dcb9ef1SAndrey Kiselev<td width="8%"></td>
1200dcb9ef1SAndrey Kiselev<td width="91%">
1210dcb9ef1SAndrey Kiselev<p><b>TIFFOpen</b>(3TIFF), <b>TIFFReadRawTile</b>(3TIFF),
1220dcb9ef1SAndrey Kiselev<b>TIFFReadTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
1230dcb9ef1SAndrey Kiselev<!-- INDENTATION -->
1240dcb9ef1SAndrey Kiselev<p>Libtiff library home page:
125*d4dd6cccSBob Friesenhahn<b>http://www.simplesystems.org/libtiff/</b></p>
1260dcb9ef1SAndrey Kiselev</td>
1270dcb9ef1SAndrey Kiselev</table>
12887c5da6fSAndrey Kiselev<hr>
12987c5da6fSAndrey Kiselev</body>
13087c5da6fSAndrey Kiselev</html>
131