summaryrefslogtreecommitdiff
path: root/man/TIFFstrip.3t
diff options
context:
space:
mode:
authormike <mike>1999-07-27 21:50:26 +0000
committermike <mike>1999-07-27 21:50:26 +0000
commiteee9461f2dad9f0d44b5e0444d9fc2079368cc87 (patch)
tree0d2948bd5610d1fa6b8124c344c4b409c820ec41 /man/TIFFstrip.3t
downloadlibtiff-eee9461f2dad9f0d44b5e0444d9fc2079368cc87.tar.gz
Initial revision
Diffstat (limited to 'man/TIFFstrip.3t')
-rw-r--r--man/TIFFstrip.3t96
1 files changed, 96 insertions, 0 deletions
diff --git a/man/TIFFstrip.3t b/man/TIFFstrip.3t
new file mode 100644
index 00000000..28273cb4
--- /dev/null
+++ b/man/TIFFstrip.3t
@@ -0,0 +1,96 @@
+.\" $Header: /cvs/maptools/cvsroot/libtiff/man/Attic/TIFFstrip.3t,v 1.1 1999-07-27 21:50:27 mike Exp $
+.\"
+.\" Copyright (c) 1992-1997 Sam Leffler
+.\" Copyright (c) 1992-1997 Silicon Graphics, Inc.
+.\"
+.\" Permission to use, copy, modify, distribute, and sell this software and
+.\" its documentation for any purpose is hereby granted without fee, provided
+.\" that (i) the above copyright notices and this permission notice appear in
+.\" all copies of the software and related documentation, and (ii) the names of
+.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
+.\" publicity relating to the software without the specific, prior written
+.\" permission of Sam Leffler and Silicon Graphics.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
+.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
+.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
+.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+.\" OF THIS SOFTWARE.
+.\"
+.if n .po 0
+.TH TIFFSTRIP 3T "October 15, 1995"
+.SH NAME
+TIFFDefaultStripSize,
+TIFFStripSize,
+TIFFVStripSize,
+TIFFComputeStrip,
+TIFFNumberOfStrips
+\- strip-related utility routines
+.SH SYNOPSIS
+.nf
+.B "#include <tiffio.h>"
+.B "uint32 TIFFDefaultStripSize(TIFF* tif, uint32 estimate)"
+.B "tsize_t TIFFStripSize(TIFF* tif)"
+.B "tsize_t TIFFVStripSize(TIFF* tif, uint32 nrows)"
+.B "tstrip_t TIFFComputeStrip(TIFF* tif, uint32 row, tsample_t sample)"
+.B "tstrip_t TIFFNumberOfStrips(TIFF* tif)"
+.fi
+.SH DESCRIPTION
+.I TIFFDefaultStripSize
+returns the number of rows for a reasonable-sized strip according
+to the current settings of the
+.IR ImageWidth ,
+.IR BitsPerSample ,
+.IR SamplesPerPixel ,
+tags and any compression-specific requirements.
+If the
+.I estimate
+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
+tag.
+In lieu of any unusual requirements
+.I TIFFDefaultStripSize
+tries to create strips that have approximately
+8 kilobytes of uncompressed data.
+.PP
+.IR TIFFStripSize
+returns the equivalent size for a strip of data as it would
+be returned in a call to
+.IR TIFFReadEncodedStrip
+or as it would be expected in a call to
+.IR TIFFWriteEncodedStrip .
+.PP
+.I TIFFVStripSize
+returns the number of bytes in a strip with
+.I nrows
+rows of data.
+.PP
+.IR TIFFComputeStrip
+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
+parameter is always used in calculating a strip.
+The
+.I sample
+parameter is used only if data are organized in separate planes (\c
+.IR PlanarConfiguration =2).
+.PP
+.IR TIFFNumberOfStrips
+returns the number of strips in the image.
+.SH DIAGNOSTICS
+None.
+.SH "SEE ALSO"
+.IR libtiff (3T),
+.IR TIFFReadEncodedStrip (3T),
+.IR TIFFReadRawStrip (3T),
+.IR TIFFWriteEncodedStrip (3T),
+.IR TIFFWriteRawStrip (3T)