TIFFtile.3tiff revision 13666
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
9eb499828dd875d229531b50d05f016b8a1f1dd9vboxsync<!--ArborText, Inc., 1988-1999, v.4002-->
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync<!--ARC : LSARC 2003/085 libtiff, libjpeg, and libpng-->
9eb499828dd875d229531b50d05f016b8a1f1dd9vboxsync%commonents;
cc4463d266cc5b433b63b2231570a9f77c126ab6vboxsync<!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
cc4463d266cc5b433b63b2231570a9f77c126ab6vboxsync%gnomecommonents;
cc4463d266cc5b433b63b2231570a9f77c126ab6vboxsync%booktitles;
9eb499828dd875d229531b50d05f016b8a1f1dd9vboxsync<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<!-- %Z%%M% %I% %E% SMI; -->
7529922bd11d7d1c38fbdc7bad6aec83eb2ec0advboxsync<refmeta><refentrytitle>TIFFtile</refentrytitle><manvolnum>3tiff</manvolnum>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<refmiscinfo class="software">&release;</refmiscinfo>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<indexterm><primary>TIFFtile</primary></indexterm><indexterm><primary>tile-related
bffb24521128f5183aafbef6542e7dacf20b5132vboxsync<refnamediv id="TIFFtile-3tiff-name"><refdescriptor>TIFFtile</refdescriptor>
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync<refname>TIFFTileSize</refname><refname>TIFFTileRowSize</refname><refname>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncTIFFVTileSize</refname><refname>TIFFDefaultTileSize</refname><refname>TIFFComputeTile
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync</refname><refname>TIFFCheckTile</refname><refname>TIFFNumberOfTiles</refname>
1deb4de12fed2ad1932401517862e6b5dc5466a3vboxsync<refpurpose>tile-related utility routines</refpurpose></refnamediv>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<refsect1 id="TIFFtile-3tiff-synp"><title>&synp-tt;</title>
3e66da17d5b68a6f1a06c60e88a7c9967b0ab2a4vboxsyncvoid TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th)
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsynctsize_t TIFFTileSize(TIFF* tif)
da6747c2419b9cea8b5e2c576a30a5de999a8ab3vboxsynctsize_t TIFFTileRowSize(TIFF* tif)
da6747c2419b9cea8b5e2c576a30a5de999a8ab3vboxsynctsize_t TIFFVTileSize(TIFF* tif, uint32 nrows)
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncttile_t TIFFComputeTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncint TIFFCheckTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsyncttile_t TIFFNumberOfTiles(TIFF* tif)</programlisting>
e8e770ce5a8f375c77b6047158833b5b3d2c055evboxsync<refsect1 id="TIFFtile-3tiff-desc"><title>&desc-tt;</title>
da6747c2419b9cea8b5e2c576a30a5de999a8ab3vboxsync<para><literal>TIFFDefaultTileSize</literal> returns the pixel width and height
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncof a reasonable-sized tile, suitable for setting up the <literal>TileWidth
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync</literal> and <literal>TileLength</literal> tags. If the <replaceable>tw
d02610fd604cc8ab4cccf7e3fa510c06cb728ff2vboxsync</replaceable> and <replaceable>th</replaceable> values passed in are non-zero,
8eb4989e815c8f374b965265ccf184d6ce17d9e8vboxsyncthen they are adjusted to reflect any compression-specific requirements. The
bffb24521128f5183aafbef6542e7dacf20b5132vboxsyncreturned width and height are constrained to be a multiple of 16 pixels, to
1deb4de12fed2ad1932401517862e6b5dc5466a3vboxsyncconform with the TIFF specification.</para>
e1f397485a50a958c625b4d709c052aa2687a4fbvboxsync<para><literal>TIFFTileSize</literal> returns the equivalent size for a tile
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncof data as it would be returned in a call to <literal>TIFFReadTile</literal>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncor as it would be expected in a call to <literal>TIFFWriteTile</literal>.
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<para><literal>TIFFVTileSize</literal> returns the number of bytes in a row-aligned
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<para><literal>TIFFTileRowSize</literal> returns the number of bytes of a
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncrow of data in a tile.</para>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<para><literal>TIFFComputeTile</literal> returns the tile that contains the
7529922bd11d7d1c38fbdc7bad6aec83eb2ec0advboxsyncspecified coordinates. A valid tile is always returned. Out-of-range coordinate
7529922bd11d7d1c38fbdc7bad6aec83eb2ec0advboxsyncvalues are clamped to the bounds of the image. The <literal>x</literal> and <literal>
7529922bd11d7d1c38fbdc7bad6aec83eb2ec0advboxsyncy</literal> parameters are always used in calculating a tile. The <literal>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncz</literal> parameter is used if the image is deeper than 1 slice (ImageDepth>1).
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncThe <literal>sample</literal> parameter is used only if data is organized
003bed4b86e46315aaef143a73c95eb8eee7fe78vboxsyncin separate planes (PlanarConfiguration=2).</para>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<para><literal>TIFFCheckTile</literal> returns a non-zero value if the supplied
939ffd583b0105c9cfab3570932faa41e0ccd563vboxsynccoordinates are within the bounds of the image, and zero otherwise. The <literal>
3baadeafd9922582dad9b32431362e6296417dd8vboxsyncx</literal> parameter is checked against the value of the ImageWidth tag.
939ffd583b0105c9cfab3570932faa41e0ccd563vboxsyncThe <literal>y</literal> parameter is checked against the value of the <literal>
f2ca52afeb0baed982c05e9d8591e0e4c7539dbdvboxsyncImageLength</literal> tag. The <literal>z</literal> parameter is checked against
4a4856069da3a44c647c802b7df4f0c9ae1ea179vboxsyncthe value of the <literal>ImageDepth</literal> tag (if defined). The <literal>
1deb4de12fed2ad1932401517862e6b5dc5466a3vboxsyncsample</literal> parameter is checked against the value of the <literal>SamplesPerPixel
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync</literal> parameter if the data is organized in separate planes.</para>
7844117ae695bae70a2f8f67fcbf5d44a74dce41vboxsync<para><literal>TIFFNumberOfTiles</literal> returns the number of tiles in
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsyncthe image.</para>
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<refsect1 id="TIFFtile-3tiff-attr"><title>&attr-tt;</title>
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
080867566ec24e954aac5664d20a8fb364be2ed1vboxsync<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsyncfor descriptions of the following attributes:</para>
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<row><entry><para>Availability</para></entry><entry><para>SUNWTiff</para></entry>
7c205843b5f25329b7bac4cb41e4c55a21c7aafevboxsync<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
b1212d1cdc6c9396aa851ef0a5388edce69806advboxsynccolname="COLSPEC1"><para>Uncommitted</para></entry></row>
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync</informaltable>
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<refsect1 id="TIFFtile-3tiff-also"><title>&also-tt;</title>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<!--Reference to another man page-->
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<!--Reference to a Help manual-->
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<!--Reference to a book.-->
2e79d47d2d6374acf3e3c06f2bb803b149c960acvboxsync<para><citerefentry><refentrytitle>libtiff</refentrytitle><manvolnum>3</manvolnum>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync</citerefentry>, <citerefentry><refentrytitle>TIFFReadEncodedTile</refentrytitle>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncTIFFReadRawTile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<refentrytitle>TIFFReadTile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<refentrytitle>TIFFWriteEncodedTile</refentrytitle><manvolnum>3tiff</manvolnum>
9448344dffd6329c43c735ae1ed5f45995e445e6vboxsync</citerefentry>, <citerefentry><refentrytitle>TIFFWriteRawTile</refentrytitle>
1deb4de12fed2ad1932401517862e6b5dc5466a3vboxsync<manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>
1deb4de12fed2ad1932401517862e6b5dc5466a3vboxsyncTIFFWrite<?Pub Caret>Tile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry></para>
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync<refsect1 id="TIFFtile-3tiff-note"><title>¬e-tt;</title>
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsync<para>This man page was originally written by Sam Leffler. Updated by Breda
6be66de4257f4f564e35f7b8ee57a282e3cf3e96vboxsyncMcColgan, Sun Microsystems Inc., 2004.</para>