I386LINUX/util/I386LINUX/man/man3/TIFFquery.3t

   1 .\" $Header: /CVS_DB/Eos/util/I386LINUX/man/man3/TIFFquery.3t,v 1.1.1.1 2002/02/01 06:40:35 tacyas 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 QUERY 3T "October 15, 1995"
  27 .SH NAME
  28 TIFFCurrentRow,
  29 TIFFCurrentStrip,
  30 TIFFCurrentTile,
  31 TIFFCurrentDirectory,
  32 TIFFLastDirectory,
  33 TIFFFileno,
  34 TIFFFileName,
  35 TIFFGetMode,
  36 TIFFIsTiled,
  37 TIFFIsByteSwapped,
  38 TIFFIsUpSampled,
  39 TIFFIsMSB2LSB
  40 \- query routines
  41 .SH SYNOPSIS
  42 .nf
  43 .B "#include <tiffio.h>"
  44 .B "uint32 TIFFCurrentRow(TIFF* tif)"
  45 .B "tstrip_t TIFFCurrentStrip(TIFF* tif)"
  46 .B "ttile_t TIFFCurrentTile(TIFF* tif)"
  47 .B "tdir_t TIFFCurrentDirectory(TIFF* tif)"
  48 .B "int TIFFLastDirectory(TIFF* tif)"
  49 .B "int TIFFFileno(TIFF* tif)"
  50 .B "char* TIFFFileName(TIFF* tif)"
  51 .B "int TIFFGetMode(TIFF* tif)"
  52 .B "int TIFFIsTiled(TIFF* tif)"
  53 .B "int TIFFIsByteSwapped(TIFF* tif)"
  54 .B "int TIFFIsUpSampled(TIFF* tif)"
  55 .B "int TIFFIsMSB2LSB(TIFF* tif)"
  56 .B "const char* TIFFGetVersion(void)"
  57 .fi
  58 .SH DESCRIPTION
  59 The following routines return status information about an open
  60 .SM TIFF
  61 file.
  62 .PP
  63 .IR TIFFCurrentDirectory
  64 returns the index of the current directory (directories
  65 are numbered starting at 0).
  66 This number is suitable for use with the
  67 .IR TIFFSetDirectory
  68 routine.
  69 .PP
  70 .IR TIFFLastDirectory
  71 returns a non-zero value if the current directory is the
  72 last directory in the file;
  73 otherwise zero is returned.
  74 .PP
  75 .IR TIFFCurrentRow ,
  76 .IR TIFFCurrentStrip ,
  77 and
  78 .IR TIFFCurrentTile ,
  79 return the current row, strip, and tile, respectively,
  80 that is being read or written.
  81 These values are updated each time a read or write is done.
  82 .PP
  83 .IR TIFFFileno
  84 returns the underlying file descriptor used to access the
  85 .SM TIFF
  86 image in the filesystem.
  87 .PP
  88 .IR TIFFFileName
  89 returns the pathname argument passed to
  90 .IR TIFFOpen
  91 or
  92 .IR TIFFFdOpen .
  93 .PP
  94 .IR TIFFGetMode
  95 returns the mode with which the underlying file was opened.
  96 On
  97 .SM UNIX
  98 systems, this is the value passed to the
  99 .IR open (2)
 100 system call.
 101 .PP
 102 .IR TIFFIsTiled
 103 returns a non-zero value if the image data has
 104 a tiled organization.
 105 Zero is returned if the image data is organized in strips.
 106 .PP
 107 .IR TIFFIsByteSwapped
 108 returns a non-zero value if the image data was in a different
 109 byte-order than the host machine.
 110 Zero is returned if the image data and local host byte-orders
 111 are the same.
 112 Data samples that are more than 8 bits wide must be byte-swapped
 113 by the application.
 114 .PP
 115 .I TIFFIsUpSampled
 116 returns a non-zero value if image data returned through the
 117 read interface routines is being up-sampled.
 118 This can be useful to applications that want to calculate
 119 I/O buffer sizes to reflect this usage (though the usual
 120 strip and tile size routines already do this).
 121 .PP
 122 .I TIFFIsMSB2LSB
 123 returns a non-zero value if the image data is being returned with
 124 bit 0 as the most significant bit.
 125 .PP
 126 .IR TIFFGetVersion
 127 returns an
 128 .SM ASCII
 129 string that has a version stamp for the
 130 .SM TIFF
 131 library software.
 132 .SH DIAGNOSTICS
 133 None.
 134 .SH "SEE ALSO"
 135 .IR libtiff (3T),
 136 .IR TIFFOpen (3T),
 137 .IR TIFFFdOpen (3T)