| DIR: /usr/share/doc/libtiff-devel/html/man /usr/share/doc/libtiff-devel/html/man/ |
| Current File : /usr/share/doc/libtiff-devel/html/man/TIFFReadTile.3tiff.html |
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Sun Nov 2 19:00:00 2025 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>TIFFReadTile</title>
</head>
<body>
<h1 align="center">TIFFReadTile</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>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFReadTile
− read and decode a tile of data from an open
<small>TIFF</small> file</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<tiffio.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>tsize_t
TIFFReadTile(TIFF *</b><i>tif</i><b>, tdata_t</b>
<i>buf</i><b>, uint32_t</b> <i>x</i><b>, uint32_t</b>
<i>y</i><b>, uint32_t</b> <i>z</i><b>, tsample_t</b>
<i>sample</i><b>)</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Return the data
for the tile <i>containing</i> the specified coordinates.
The data placed in <i>buf</i> are returned decompressed and,
typically, in the native byte- and bit-ordering, but are
otherwise packed (see further below). The buffer must be
large enough to hold an entire tile of data. Applications
should call the routine <i>TIFFTileSize</i> to find out the
size (in bytes) of a tile buffer. The <i>x</i> and <i>y</i>
parameters are always used by <i>TIFFReadTile</i>. The
<i>z</i> parameter is used if the image is deeper than 1
slice (<i>ImageDepth</i>>1). The <i>sample</i> parameter
is used only if data are organized in separate planes
(<i>PlanarConfiguration</i>=2).</p>
<h2>NOTES
<a name="NOTES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">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>
<h2>RETURN VALUES
<a name="RETURN VALUES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadTile</i>
returns −1 if it detects an error; otherwise the
number of bytes in the decoded tile is returned.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <b>TIFFError</b>(3TIFF)
routine.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFCheckTile</b>(3TIFF),
<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF),
<b>TIFFReadEncodedTile</b>(3TIFF),
<b>TIFFReadRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.simplesystems.org/libtiff/</b></p>
<hr>
</body>
</html>
|