2002-10-07 09:47:36 -04:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
|
|
|
<meta name="Content-Style" content="text/css">
|
|
|
|
|
<title>TIFFReadEncodedTile</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h1 align=center>TIFFReadEncodedTile</h1>
|
|
|
|
|
<a href="#NAME">NAME</a><br>
|
|
|
|
|
<a href="#SYNOPSIS">SYNOPSIS</a><br>
|
|
|
|
|
<a href="#DESCRIPTION">DESCRIPTION</a><br>
|
|
|
|
|
<a href="#NOTES">NOTES</a><br>
|
|
|
|
|
<a href="#RETURN VALUES">RETURN VALUES</a><br>
|
|
|
|
|
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
|
|
|
|
|
<a href="#SEE ALSO">SEE ALSO</a><br>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<!-- Creator : groff version 1.18 -->
|
|
|
|
|
<!-- CreationDate: Mon Oct 7 17:36:17 2002 -->
|
|
|
|
|
<a name="NAME"></a>
|
|
|
|
|
<h2>NAME</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p>TIFFReadEncodedTile − read and decode a tile of
|
|
|
|
|
data from an open <small>TIFF</small> file</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="SYNOPSIS"></a>
|
|
|
|
|
<h2>SYNOPSIS</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p><b>#include <tiffio.h><br>
|
|
|
|
|
int TIFFReadEncodedTile(TIFF* tif, u_long tile, u_char* buf,
|
|
|
|
|
u_long size)</b></p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="DESCRIPTION"></a>
|
|
|
|
|
<h2>DESCRIPTION</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p>Read the specified tile of data and place up to
|
|
|
|
|
<i>size</i> bytes of decompressed information in the (user
|
|
|
|
|
supplied) data buffer.</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="NOTES"></a>
|
|
|
|
|
<h2>NOTES</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p>The value of <i>tile</i> is a ‘‘raw tile
|
|
|
|
|
number.’’ That is, the caller must take into
|
|
|
|
|
account whether or not the data are organized in separate
|
|
|
|
|
planes (<i>PlanarConfiguration</i>=2).
|
|
|
|
|
<i>TIFFComputeTile</i> automatically does this when
|
|
|
|
|
converting an (x,y,z,sample) coordinate quadruple to a tile
|
|
|
|
|
number. To read a full tile of data the data buffer should
|
|
|
|
|
be at least as large as the value returned by
|
|
|
|
|
<i>TIFFTileSize</i>.</p>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p>The library attempts to hide bit- and byte-ordering
|
|
|
|
|
differences between the image and the native machine by
|
|
|
|
|
converting data to the native machine order. Bit reversal is
|
|
|
|
|
done if the <i>FillOrder</i> tag is opposite to the native
|
|
|
|
|
machine bit order. 16- and 32-bit samples are automatically
|
|
|
|
|
byte-swapped if the file was written with a byte order
|
|
|
|
|
opposite to the native machine byte order,</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="RETURN VALUES"></a>
|
|
|
|
|
<h2>RETURN VALUES</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p>The actual number of bytes of data that were placed in
|
|
|
|
|
<i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns
|
|
|
|
|
−1 if an error was encountered.</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="DIAGNOSTICS"></a>
|
|
|
|
|
<h2>DIAGNOSTICS</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p>All error messages are directed to the
|
|
|
|
|
<i>TIFFError</i>(3T) routine.</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<a name="SEE ALSO"></a>
|
|
|
|
|
<h2>SEE ALSO</h2>
|
|
|
|
|
<!-- INDENTATION -->
|
|
|
|
|
<p><table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="8%"></td>
|
|
|
|
|
<td width="91%">
|
|
|
|
|
<p><i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
|
|
|
|
|
<i>TIFFReadRawTile</i>(3T), <i>TIFFReadTile</i>(3T)</p>
|
|
|
|
|
</td>
|
|
|
|
|
</table></p>
|
|
|
|
|
<hr>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
