libtiff/html/man/TIFFtile.3t.html
1999-11-23 04:29:23 +00:00

184 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML><HEAD><TITLE>Manpage of TIFFTILE</TITLE>
</HEAD><BODY BGCOLOR=WHITE><FONT FACE="helvetica, sans, arial">
<H1>TIFFTILE</H1>
Section: Misc. Reference Manual Pages (3T)<BR>Updated: February 14, 1992<BR><A HREF="#index">Index</A>
<BR><A HREF="index.html">Return to Main Contents</A>
<HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
TIFFTileSize,
TIFFTileRowSize,
TIFFVTileSize,
TIFFDefaultTileSize,
TIFFComputeTile,
TIFFCheckTile,
TIFFNumberOfTiles
- tile-related utility routines
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:/usr/include/tiffio.h">tiffio.h</A>&gt;</B>
<B>void TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th)</B>
<B>tsize_t TIFFTileSize(TIFF* tif)</B>
<B>tsize_t TIFFTileRowSize(TIFF* tif)</B>
<B>tsize_t TIFFVTileSize(TIFF* tif, uint32 nrows)</B>
<B>ttile_t TIFFComputeTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)</B>
<B>int TIFFCheckTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)</B>
<B>ttile_t TIFFNumberOfTiles(TIFF* tif)</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<I>TIFFDefaultTileSize</I>
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
<FONT SIZE="-1">TIFF</FONT>
specification.
<P>
<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>
<I>TIFFVTileSize</I>
returns the number of bytes in a row-aligned tile with
<I>nrows</I>
of data.
<P>
<I>TIFFTileRowSize</I>
returns the number of bytes of a row of data in a tile.
<P>
<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>&gt;1).
The
<I>sample</I>
parameter is used only if data are organized in separate planes (<I>PlanarConfiguration</I>=2).
<P>
<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>
<I>TIFFNumberOfTiles</I>
returns the number of tiles in the image.
<A NAME="lbAE">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
None.
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="libtiff.3t.html">libtiff</A></I>(3T),
<I><A HREF="TIFFReadEncodedTile.3t.html">TIFFReadEncodedTile</A></I>(3T),
<I><A HREF="TIFFReadRawTile.3t.html">TIFFReadRawTile</A></I>(3T),
<I><A HREF="TIFFReadTile.3t.html">TIFFReadTile</A></I>(3T),
<I><A HREF="TIFFWriteEncodedTile.3t.html">TIFFWriteEncodedTile</A></I>(3T),
<I><A HREF="TIFFWriteRawTile.3t.html">TIFFWriteRawTile</A></I>(3T),
<I><A HREF="TIFFWriteTile.3t.html">TIFFWriteTile</A></I>(3T)
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAF">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="index.html">man2html</A>,
using the manual pages.<BR>
Time: 01:31:39 GMT, November 23, 1999
</BODY>
</HTML>