Current Directory: /usr/share/doc/libtiff-devel/html/man
Viewing File: /usr/share/doc/libtiff-devel/html/man/TIFFtile.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>TIFFTILE</title>
</head>
<body>
<h1 align="center">TIFFTILE</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</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">TIFFTileSize,
TIFFTileRowSize, TIFFVTileSize, TIFFDefaultTileSize,
TIFFComputeTile, TIFFCheckTile, TIFFNumberOfTiles −
tile-related utility routines</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>void
TIFFDefaultTileSize(TIFF *</b><i>tif</i><b>, uint32_t
*</b><i>tw</i><b>, uint32_t *</b><i>th</i><b>) <br>
tsize_t TIFFTileSize(TIFF *</b><i>tif</i><b>) <br>
tsize_t TIFFTileRowSize(TIFF *</b><i>tif</i><b>) <br>
tsize_t TIFFVTileSize(TIFF *</b><i>tif</i><b>, uint32_t</b>
<i>nrows</i><b>) <br>
ttile_t TIFFComputeTile(TIFF *</b><i>tif</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>)
<br>
int TIFFCheckTile(TIFF *</b><i>tif</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>) <br>
ttile_t TIFFNumberOfTiles(TIFF *</b><i>tif</i><b>)</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFDefaultTileSize</i></b>
returns the pixel width and height of a reasonable-sized
tile; suitable for setting up the <i>TileWidth</i> and
<i>TileLength</i> tags. If the <i>tw</i> and <i>th</i>
values passed in are non-zero, then they are adjusted to
reflect any compression-specific requirements. The returned
width and height are constrained to be a multiple of 16
pixels to conform with the <small>TIFF</small>
specification.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFTileSize</i>
returns the equivalent size for a tile of data as it would
be returned in a call to <i>TIFFReadTile</i> or as it would
be expected in a call to <i>TIFFWriteTile</i>.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFVTileSize</i>
returns the number of bytes in a row-aligned tile with
<i>nrows</i> of data.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFTileRowSize</i>
returns the number of bytes of a row of data in a tile.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFComputeTile</i>
returns the tile that contains the specified coordinates. A
valid tile is always returned; out-of-range coordinate
values are clamped to the bounds of the image. The <i>x</i>
and <i>y</i> parameters are always used in calculating a
tile. 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>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFCheckTile</i>
returns a non-zero value if the supplied coordinates are
within the bounds of the image and zero otherwise. The
<i>x</i> parameter is checked against the value of the
<i>ImageWidth</i> tag. The <i>y</i> parameter is checked
against the value of the <i>ImageLength</i> tag. The
<i>z</i> parameter is checked against the value of the
<i>ImageDepth</i> tag (if defined). The <i>sample</i>
parameter is checked against the value of the
<i>SamplesPerPixel</i> parameter if the data are organized
in separate planes.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFNumberOfTiles</i>
returns the number of tiles in the image.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">None.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFReadEncodedTile</b>(3TIFF),
<b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF),
<b>TIFFWriteEncodedTile</b>(3TIFF),
<b>TIFFWriteRawTile</b>(3TIFF), <b>TIFFWriteTile</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>