TIFFtile.3tiff revision 13623
10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
10139N/A<!ENTITY synp-tt "SYNOPSIS">
10139N/A<!ENTITY cmd "TIFFtile">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
10139N/A%gnomecommonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<?PubInc>
10139N/A<refentry id="TIFFtile-3tiff">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>TIFFtile</refentrytitle><manvolnum>3tiff</manvolnum>
10139N/A<refmiscinfo class="date">02 Apr 2004</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
10139N/A<indexterm><primary>TIFFtile</primary></indexterm><indexterm><primary>tile-related
10139N/Autility routines</primary></indexterm>
10139N/A<refnamediv id="TIFFtile-3tiff-name"><refdescriptor>TIFFtile</refdescriptor>
10139N/A<refname>TIFFTileSize</refname><refname>TIFFTileRowSize</refname><refname>
10139N/ATIFFVTileSize</refname><refname>TIFFDefaultTileSize</refname><refname>TIFFComputeTile
10139N/A</refname><refname>TIFFCheckTile</refname><refname>TIFFNumberOfTiles</refname>
10139N/A<refpurpose>tile-related utility routines</refpurpose></refnamediv>
10139N/A<refsect1 id="TIFFtile-3tiff-synp"><title>&synp-tt;</title>
10139N/A<programlisting>#include &lt;tiffio.h>
10139N/Avoid TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th)
10139N/Atsize_t TIFFTileSize(TIFF* tif)
10139N/Atsize_t TIFFTileRowSize(TIFF* tif)
10139N/Atsize_t TIFFVTileSize(TIFF* tif, uint32 nrows)
10139N/Attile_t TIFFComputeTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)
10139N/Aint TIFFCheckTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t sample)
10139N/Attile_t TIFFNumberOfTiles(TIFF* tif)</programlisting>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFtile-3tiff-desc"><title>&desc-tt;</title>
10139N/A<para><literal>TIFFDefaultTileSize</literal> returns the pixel width and height
10139N/Aof a reasonable-sized tile, suitable for setting up the <literal>TileWidth
10139N/A</literal> and <literal>TileLength</literal> tags. If the <replaceable>tw
10139N/A</replaceable> and <replaceable>th</replaceable> values passed in are non-zero,
10139N/Athen they are adjusted to reflect any compression-specific requirements. The
10139N/Areturned width and height are constrained to be a multiple of 16 pixels, to
10139N/Aconform with the TIFF specification.</para>
10139N/A<para><literal>TIFFTileSize</literal> returns the equivalent size for a tile
10139N/Aof data as it would be returned in a call to <literal>TIFFReadTile</literal>
10139N/Aor as it would be expected in a call to <literal>TIFFWriteTile</literal>.
10139N/A</para>
10139N/A<para><literal>TIFFVTileSize</literal> returns the number of bytes in a row-aligned
10139N/Atile with <literal>nrows</literal> of data.</para>
10139N/A<para><literal>TIFFTileRowSize</literal> returns the number of bytes of a
10139N/Arow of data in a tile.</para>
10139N/A<para><literal>TIFFComputeTile</literal> returns the tile that contains the
10139N/Aspecified coordinates. A valid tile is always returned. Out-of-range coordinate
10139N/Avalues are clamped to the bounds of the image. The <literal>x</literal> and <literal>
10139N/Ay</literal> parameters are always used in calculating a tile. The <literal>
10139N/Az</literal> parameter is used if the image is deeper than 1 slice (ImageDepth>1).
10139N/AThe <literal>sample</literal> parameter is used only if data is organized
10139N/Ain separate planes (PlanarConfiguration=2).</para>
10139N/A<para><literal>TIFFCheckTile</literal> returns a non-zero value if the supplied
10139N/Acoordinates are within the bounds of the image, and zero otherwise. The <literal>
10139N/Ax</literal> parameter is checked against the value of the ImageWidth tag.
10139N/AThe <literal>y</literal> parameter is checked against the value of the <literal>
10139N/AImageLength</literal> tag. The <literal>z</literal> parameter is checked against
10139N/Athe value of the <literal>ImageDepth</literal> tag (if defined). The <literal>
10139N/Asample</literal> parameter is checked against the value of the <literal>SamplesPerPixel
10139N/A</literal> parameter if the data is organized in separate planes.</para>
10139N/A<para><literal>TIFFNumberOfTiles</literal> returns the number of tiles in
10139N/Athe image.</para>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFtile-3tiff-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
10139N/A<row><entry><para>Availability</para></entry><entry><para>SUNWTiff</para></entry>
10139N/A</row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
13623N/Acolname="COLSPEC1"><para>Uncommitted</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFtile-3tiff-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
10139N/A<para><citerefentry><refentrytitle>libtiff</refentrytitle><manvolnum>3</manvolnum>
10139N/A</citerefentry>, <citerefentry><refentrytitle>TIFFReadEncodedTile</refentrytitle>
10139N/A<manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>
10139N/ATIFFReadRawTile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
10139N/A<refentrytitle>TIFFReadTile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
10139N/A<refentrytitle>TIFFWriteEncodedTile</refentrytitle><manvolnum>3tiff</manvolnum>
10139N/A</citerefentry>, <citerefentry><refentrytitle>TIFFWriteRawTile</refentrytitle>
10139N/A<manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>
10139N/ATIFFWrite<?Pub Caret>Tile</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry></para>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFtile-3tiff-note"><title>&note-tt;</title>
10139N/A<para>This man page was originally written by Sam Leffler. Updated by Breda
10139N/AMcColgan, Sun Microsystems Inc., 2004.</para>
10139N/A</refsect1>
10139N/A</refentry>
10139N/A<?Pub *0000006263>