src/tiff/man/TIFFReadRawStrip.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 TIFFReadRawStrip 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 TIFFReadRawStrip \- return the undecoded contents of a strip of data from an
  28 open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFReadRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Read the contents of the specified strip into the (user supplied) data buffer.
  37 Note that the value of
  38 .I strip
  39 is a ``raw strip number.'' That is, the caller must take into account whether
  40 or not the data is organized in separate planes (\c
  41 .IR PlanarConfiguration =2).
  42 To read a full strip of data the data buffer should typically be at least as
  43 large as the number returned by
  44 .IR TIFFStripSize .
  45 .SH "RETURN VALUES"
  46 The actual number of bytes of data that were placed in
  47 .I buf
  48 is returned;
  49 .IR TIFFReadEncodedStrip
  50 returns \-1 if an error was encountered.
  51 .SH DIAGNOSTICS
  52 All error messages are directed to the
  53 .BR TIFFError (3TIFF)
  54 routine.
  55 .SH "SEE ALSO"
  56 .BR TIFFOpen (3TIFF),
  57 .BR TIFFReadEncodedStrip (3TIFF),
  58 .BR TIFFReadScanline (3TIFF),
  59 .BR TIFFStripSize (3TIFF),
  60 .BR libtiff (3TIFF)
  61 .PP
  62 Libtiff library home page:
  63 .BR http://www.remotesensing.org/libtiff/