Blame man/TIFFquery.3tiff

Packit 7838c8
.\" $Id: TIFFquery.3tiff,v 1.1 2004-11-11 14:39:16 dron Exp $
Packit 7838c8
.\"
Packit 7838c8
.\" Copyright (c) 1988-1997 Sam Leffler
Packit 7838c8
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
Packit 7838c8
.\"
Packit 7838c8
.\" Permission to use, copy, modify, distribute, and sell this software and 
Packit 7838c8
.\" its documentation for any purpose is hereby granted without fee, provided
Packit 7838c8
.\" that (i) the above copyright notices and this permission notice appear in
Packit 7838c8
.\" all copies of the software and related documentation, and (ii) the names of
Packit 7838c8
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
Packit 7838c8
.\" publicity relating to the software without the specific, prior written
Packit 7838c8
.\" permission of Sam Leffler and Silicon Graphics.
Packit 7838c8
.\" 
Packit 7838c8
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
Packit 7838c8
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
Packit 7838c8
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
Packit 7838c8
.\" 
Packit 7838c8
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
Packit 7838c8
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
Packit 7838c8
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
Packit 7838c8
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
Packit 7838c8
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
Packit 7838c8
.\" OF THIS SOFTWARE.
Packit 7838c8
.\"
Packit 7838c8
.if n .po 0
Packit 7838c8
.TH QUERY 3TIFF "October 29, 2004" "libtiff"
Packit 7838c8
.SH NAME
Packit 7838c8
TIFFCurrentRow,
Packit 7838c8
TIFFCurrentStrip,
Packit 7838c8
TIFFCurrentTile,
Packit 7838c8
TIFFCurrentDirectory,
Packit 7838c8
TIFFLastDirectory,
Packit 7838c8
TIFFFileno,
Packit 7838c8
TIFFFileName,
Packit 7838c8
TIFFGetMode,
Packit 7838c8
TIFFIsTiled,
Packit 7838c8
TIFFIsByteSwapped,
Packit 7838c8
TIFFIsUpSampled,
Packit 7838c8
TIFFIsMSB2LSB,
Packit 7838c8
TIFFGetVersion
Packit 7838c8
\- query routines
Packit 7838c8
.SH SYNOPSIS
Packit 7838c8
.B "#include <tiffio.h>"
Packit 7838c8
.sp
Packit 7838c8
.BI "uint32 TIFFCurrentRow(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "tstrip_t TIFFCurrentStrip(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "ttile_t TIFFCurrentTile(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "tdir_t TIFFCurrentDirectory(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFLastDirectory(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFFileno(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "char* TIFFFileName(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFGetMode(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFIsTiled(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFIsByteSwapped(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFIsUpSampled(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "int TIFFIsMSB2LSB(TIFF* " tif ")"
Packit 7838c8
.br
Packit 7838c8
.BI "const char* TIFFGetVersion(void)"
Packit 7838c8
.SH DESCRIPTION
Packit 7838c8
The following routines return status information about an open
Packit 7838c8
.SM TIFF
Packit 7838c8
file.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFCurrentDirectory
Packit 7838c8
returns the index of the current directory (directories are numbered starting
Packit 7838c8
at 0). This number is suitable for use with the
Packit 7838c8
.IR TIFFSetDirectory
Packit 7838c8
routine.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFLastDirectory
Packit 7838c8
returns a non-zero value if the current directory is the last directory in the
Packit 7838c8
file; otherwise zero is returned.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFCurrentRow ,
Packit 7838c8
.IR TIFFCurrentStrip ,
Packit 7838c8
and
Packit 7838c8
.IR TIFFCurrentTile ,
Packit 7838c8
return the current row, strip, and tile, respectively, that is being read or
Packit 7838c8
written. These values are updated each time a read or write is done.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFFileno
Packit 7838c8
returns the underlying file descriptor used to access the 
Packit 7838c8
.SM TIFF
Packit 7838c8
image in the filesystem.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFFileName
Packit 7838c8
returns the pathname argument passed to
Packit 7838c8
.IR TIFFOpen
Packit 7838c8
or
Packit 7838c8
.IR TIFFFdOpen .
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFGetMode
Packit 7838c8
returns the mode with which the underlying file was opened. On
Packit 7838c8
.SM UNIX
Packit 7838c8
systems, this is the value passed to the
Packit 7838c8
.IR open (2)
Packit 7838c8
system call.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFIsTiled
Packit 7838c8
returns a non-zero value if the image data has a tiled organization. Zero is
Packit 7838c8
returned if the image data is organized in strips.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFIsByteSwapped
Packit 7838c8
returns a non-zero value if the image data was in a different byte-order than
Packit 7838c8
the host machine. Zero is returned if the TIFF file and local host byte-orders
Packit 7838c8
are the same.  Note that TIFFReadTile(), TIFFReadStrip() and
Packit 7838c8
TIFFReadScanline() functions already normally perform byte swapping to local
Packit 7838c8
host order if needed.
Packit 7838c8
.PP
Packit 7838c8
.I TIFFIsUpSampled
Packit 7838c8
returns a non-zero value if image data returned through the read interface
Packit 7838c8
routines is being up-sampled. This can be useful to applications that want to
Packit 7838c8
calculate I/O buffer sizes to reflect this usage (though the usual strip and
Packit 7838c8
tile size routines already do this).
Packit 7838c8
.PP
Packit 7838c8
.I TIFFIsMSB2LSB
Packit 7838c8
returns a non-zero value if the image data is being returned with bit 0 as the
Packit 7838c8
most significant bit.
Packit 7838c8
.PP
Packit 7838c8
.IR TIFFGetVersion
Packit 7838c8
returns an
Packit 7838c8
.SM ASCII
Packit 7838c8
string that has a version stamp for the 
Packit 7838c8
.SM TIFF
Packit 7838c8
library software.
Packit 7838c8
.SH DIAGNOSTICS
Packit 7838c8
None.
Packit 7838c8
.SH "SEE ALSO"
Packit 7838c8
.IR libtiff (3TIFF),
Packit 7838c8
.IR TIFFOpen (3TIFF),
Packit 7838c8
.IR TIFFFdOpen (3TIFF)