src/tiff/man/TIFFReadEncodedStrip.3tiff

   1 .\"
   2 .\" Copyright (c) 1988-1997 Sam Leffler
   3 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH TIFFReadEncodedStrip 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 TIFFReadEncodedStrip \- read and decode a strip of data from an open
  28 .SM TIFF
  29 file
  30 .SH SYNOPSIS
  31 .B "#include <tiffio.h>"
  32 .sp
  33 .BI "tsize_t TIFFReadEncodedStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  34 .SH DESCRIPTION
  35 Read the specified strip of data and place up to
  36 .I size
  37 bytes of decompressed information in the (user supplied) data buffer.
  38 .SH NOTES
  39 The value of
  40 .I strip
  41 is a ``raw strip number.''
  42 That is, the caller must take into account whether or not the data are
  43 organized in separate planes (\c
  44 .IR PlanarConfiguration =2).
  45 To read a full strip of data the data buffer should typically be at least as
  46 large as the number returned by
  47 .BR TIFFStripSize (3TIFF).
  48 If the -1 passed in
  49 .I size
  50 parameter, the whole strip will be read. You should be sure you have enough
  51 space allocated for the buffer.
  52 .PP
  53 The library attempts to hide bit- and byte-ordering differences between the
  54 image and the native machine by converting data to the native machine order.
  55 Bit reversal is done if the
  56 .I FillOrder
  57 tag is opposite to the native machine bit order. 16- and 32-bit samples are
  58 automatically byte-swapped if the file was written with a byte order opposite
  59 to the native machine byte order,
  60 .SH "RETURN VALUES"
  61 The actual number of bytes of data that were placed in
  62 .I buf
  63 is returned;
  64 .IR TIFFReadEncodedStrip
  65 returns \-1 if an error was encountered.
  66 .SH DIAGNOSTICS
  67 All error messages are directed to the
  68 .BR TIFFError (3TIFF)
  69 routine.
  70 .SH "SEE ALSO"
  71 .BR TIFFOpen (3TIFF),
  72 .BR TIFFReadRawStrip (3TIFF),
  73 .BR TIFFReadScanline (3TIFF),
  74 .BR libtiff (3TIFF)
  75 .PP
  76 Libtiff library home page:
  77 .BR http://www.remotesensing.org/libtiff/