TIFFstrip.3tiff revision 13623
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!--ArborText, Inc., 1988-1999, v.4002-->
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!ENTITY % commonents SYSTEM "smancommon.ent">
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith%gnomecommonents;
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!ENTITY % booktitles SYSTEM "booktitles.ent">
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!-- %Z%%M% %I% %E% SMI; -->
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmeta><refentrytitle>TIFFstrip</refentrytitle><manvolnum>3tiff</manvolnum>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmiscinfo class="date">02 Apr 2004</refmiscinfo>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmiscinfo class="software">&release;</refmiscinfo>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmiscinfo class="arch">generic</refmiscinfo>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<indexterm><primary>TIFFstrip</primary></indexterm><indexterm><primary>strip-related
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refnamediv id="TIFFstrip-3tiff-name"><refdescriptor>TIFFstrip</refdescriptor>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refname>TIFFDefaultStripSize</refname><refname>TIFFStripSize</refname><refname>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David GoldsmithTIFFVStripSize</refname><refname>TIFFComputeStrip</refname><refname>TIFFNumberOfStrips
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</refname><refpurpose>strip-related utility routines</refpurpose></refnamediv>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refsect1 id="TIFFstrip-3tiff-synp"><title>&synp-tt;</title>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithuint32 TIFFDefaultStripSize(TIFF* tif, uint32 estimate)
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithtsize_t TIFFStripSize(TIFF* tif)
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithtsize_t TIFFVStripSize(TIFF* tif, uint32 nrows)
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithtstrip_t TIFFComputeStrip(TIFF* tif, uint32 row, tsample_t sample)
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithtstrip_t TIFFNumberOfStrips(TIFF* tif)</programlisting>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refsect1 id="TIFFstrip-3tiff-desc"><title>&desc-tt;</title>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><literal>TIFFDefaultStripSize</literal> returns the number of rows for
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmitha reasonable-sized strip according to the current settings of the <literal>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David GoldsmithImageWidth</literal>, <literal>BitsPerSample</literal>, and <literal>SamplesPerPixel
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</literal> tags, and any compression-specific requirements. If the <literal>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithestimate</literal> parameter is non-zero, then it is taken as an estimate
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithof the desired strip size and adjusted according to any compression-specific
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithrequirements. The value returned by this function is typically used to define
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmiththe <literal>RowsPerStrip</literal> tag. In lieu of any unusual requirements, <literal>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David GoldsmithTIFFDefaultStripSize</literal> tries to create strips that have approximately
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith8 kilobytes of uncompressed data.</para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><literal>TIFFStripSize</literal> returns the equivalent size for a strip
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithof data as it would be returned in a call to <literal>TIFFReadEncodedStrip
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</literal> or as it would be expected in a call to <literal>TIFFWriteEncodedStrip
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><literal>TIFFVStripSize</literal> returns the number of bytes in a strip
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithwith <literal>nrows</literal> rows of data.</para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><literal>TIFFComputeStrip</literal> returns the strip that contains
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmiththe specified coordinates. A valid strip is always returned. Out-of-range
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithcoordinate values are clamped to the bounds of the image. The <literal>row
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</literal> parameter is always used in calculating a strip. The <literal>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithsample</literal> parameter is used only if data is organized in separate planes
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith(PlanarConfiguration=2).</para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><literal>TIFFNumberOfStrips</literal> returns the number of strips in
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmiththe image.</para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refsect1 id="TIFFstrip-3tiff-attr"><title>&attr-tt;</title>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithfor descriptions of the following attributes:</para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithvalign="middle">ATTRIBUTE VALUE</entry></row>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<row><entry><para>Availability</para></entry><entry><para>SUNWTiff</para></entry>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmithcolname="COLSPEC1"><para>Uncommitted</para></entry></row>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</informaltable>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refsect1 id="TIFFstrip-3tiff-also"><title>&also-tt;</title>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!--Reference to another man page-->
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!--Reference to a Help manual-->
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<!--Reference to a book.-->
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para><citerefentry><refentrytitle>libtiff</refentrytitle><manvolnum>3</manvolnum>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</citerefentry>,<?Pub Caret1> <citerefentry><refentrytitle>TIFFReadEncodedStrip
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refentrytitle>TIFFReadRawStrip</refentrytitle><manvolnum>3tiff</manvolnum>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith</citerefentry>, <citerefentry><refentrytitle>TIFFWriteEncodedStrip</refentrytitle>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David GoldsmithTIFFWriteRawStrip</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry></para>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<refsect1 id="TIFFstrip-3tiff-note"><title>¬e-tt;</title>
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David Goldsmith<para>This man page was originally written by Sam Leffler. Updated by Breda
c1bef59b02d89a84c23d29663cc4e6d46148ebd2David GoldsmithMcColgan, Sun Microsystems Inc., 2004.</para>