src/tiff/man/TIFFsize.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 TIFFSIZE 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 TIFFScanlineSize, TIFFRasterScanlineSize,
  28 \- return the size of various items associated with an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFRasterScanlineSize(TIFF *" tif ")"
  35 .br
  36 .BI "tsize_t TIFFScanlineSize(TIFF *" tif ")"
  37 .SH DESCRIPTION
  38 .I TIFFScanlineSize
  39 returns the size in bytes of a row of data as it would be returned in a call
  40 to
  41 .IR TIFFReadScanline ,
  42 or as it would be expected in a call to
  43 .IR TIFFWriteScanline .
  44 .PP
  45 .I TIFFRasterScanlineSize
  46 returns the size in bytes of a complete decoded and packed raster scanline.
  47 Note that this value may be different from the value returned by
  48 .I TIFFScanlineSize
  49 if data is stored as separate planes.
  50 .SH DIAGNOSTICS
  51 None.
  52 .SH "SEE ALSO"
  53 .BR TIFFOpen (3TIFF),
  54 .BR TIFFReadScanline (3TIFF),
  55 .BR libtiff (3TIFF)
  56 .PP
  57 Libtiff library home page:
  58 .BR http://www.remotesensing.org/libtiff/