libtiff/html/man/TIFFstrip.3tiff.html
Bob Friesenhahn c3402403ea * html/man/Makefile.am (htmldoc): Fix htmldoc rule so that it can
be used if build directory is not the same as source directory.
* man/{TIFFGetField.3tiff, man/TIFFSetField.3tiff}: Documented
TIFFTAG_PHOTOSHOP, TIFFTAG_RICHTIFFIPTC, and TIFFTAG_XMLPACKET,
and re-sorted tag names in alphabetical order.
2006-01-02 23:50:44 +00:00

131 lines
4.0 KiB
HTML

<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Mon Jan 2 17:41:46 2006 -->
<!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; }
pre { margin-top: 0; margin-bottom: 0; }
table { margin-top: 0; margin-bottom: 0; }
</style>
<title>TIFFSTRIP</title>
</head>
<body>
<h1 align=center>TIFFSTRIP</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>
<a name="NAME"></a>
<h2>NAME</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFDefaultStripSize,
TIFFStripSize, TIFFVStripSize, TIFFRawStripSize,
TIFFComputeStrip, TIFFNumberOfStrips &minus; strip-related
utility routines</p>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;tiffio.h&gt;</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>uint32
TIFFDefaultStripSize(TIFF *</b><i>tif</i><b>, uint32</b>
<i>estimate</i><b>) <br>
tsize_t TIFFStripSize(TIFF *</b><i>tif</i><b>) <br>
tsize_t TIFFVStripSize(TIFF *</b><i>tif</i><b>, uint32</b>
<i>nrows</i><b>) <br>
tsize_t TIFFRawStripSize(TIFF *</b><i>tif</i><b>,
tstrip_t</b> <i>strip</i><b>) <br>
tstrip_t TIFFComputeStrip(TIFF *</b><i>tif</i><b>,
uint32</b> <i>row</i><b>, tsample_t</b> <i>sample</i><b>)
<br>
tstrip_t TIFFNumberOfStrips(TIFF *</b><i>tif</i><b>)</b></p>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFDefaultStripSize</i>
returns the number of rows for a reasonable-sized strip
according to the current settings of the <i>ImageWidth</i>,
<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, tags and any
compression-specific requirements. If the <i>estimate</i>
parameter, if non-zero, then it is taken as an estimate of
the desired strip size and adjusted according to any
compression-specific requirements. The value returned by
this function is typically used to define the
<i>RowsPerStrip</i> tag. In lieu of any unusual requirements
<i>TIFFDefaultStripSize</i> tries to create strips that have
approximately 8 kilobytes of uncompressed data.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFStripSize</i>
returns the equivalent size for a strip of data as it would
be returned in a call to <i>TIFFReadEncodedStrip</i> or as
it would be expected in a call to
<i>TIFFWriteEncodedStrip</i>.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFVStripSize</i>
returns the number of bytes in a strip with <i>nrows</i>
rows of data.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFRawStripSize</i>
returns the number of bytes in a raw strip (i.e. not
decoded).</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFComputeStrip</i>
returns the strip that contains the specified coordinates. A
valid strip is always returned; out-of-range coordinate
values are clamped to the bounds of the image. The
<i>row</i> parameter is always used in calculating a strip.
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>TIFFNumberOfStrips</i>
returns the number of strips in the image.</p>
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
<p style="margin-left:11%; margin-top: 1em">None.</p>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFReadEncodedStrip</b>(3TIFF),
<b>TIFFReadRawStrip</b>(3TIFF),
<b>TIFFWriteEncodedStrip</b>(3TIFF),
<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF),</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.remotesensing.org/libtiff/</b></p>
<hr>
</body>
</html>