src/tiff/man/TIFFsize.3tiff

   1 .\" $Id: TIFFsize.3tiff,v 1.2 2005-11-02 11:07:18 dron Exp $
   2 .\"
   3 .\" Copyright (c) 1988-1997 Sam Leffler
   4 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   5 .\"
   6 .\" Permission to use, copy, modify, distribute, and sell this software and
   7 .\" its documentation for any purpose is hereby granted without fee, provided
   8 .\" that (i) the above copyright notices and this permission notice appear in
   9 .\" all copies of the software and related documentation, and (ii) the names of
  10 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  11 .\" publicity relating to the software without the specific, prior written
  12 .\" permission of Sam Leffler and Silicon Graphics.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  16 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  17 .\"
  18 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  19 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  20 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  22 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  23 .\" OF THIS SOFTWARE.
  24 .\"
  25 .if n .po 0
  26 .TH TIFFSIZE 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFScanlineSize, TIFFRasterScanlineSize,
  29 \- return the size of various items associated with an open
  30 .SM TIFF
  31 file
  32 .SH SYNOPSIS
  33 .B "#include <tiffio.h>"
  34 .sp
  35 .BI "tsize_t TIFFRasterScanlineSize(TIFF *" tif ")"
  36 .br
  37 .BI "tsize_t TIFFScanlineSize(TIFF *" tif ")"
  38 .SH DESCRIPTION
  39 .I TIFFScanlineSize
  40 returns the size in bytes of a row of data as it would be returned in a call
  41 to
  42 .IR TIFFReadScanline ,
  43 or as it would be expected in a call to
  44 .IR TIFFWriteScanline .
  45 .PP
  46 .I TIFFRasterScanlineSize
  47 returns the size in bytes of a complete decoded and packed raster scanline.
  48 Note that this value may be different from the value returned by
  49 .I TIFFScanlineSize
  50 if data is stored as separate planes.
  51 .SH DIAGNOSTICS
  52 None.
  53 .SH "SEE ALSO"
  54 .BR TIFFOpen (3TIFF),
  55 .BR TIFFReadScanline (3TIFF),
  56 .BR libtiff (3TIFF)
  57 .PP
  58 Libtiff library home page:
  59 .BR http://www.remotesensing.org/libtiff/