diff options
author | Sam Leffler <sam@engr.sgi.com> | 1995-07-19 01:54:06 +0100 |
---|---|---|
committer | Roger Leigh <rleigh@codelibre.net> | 2022-06-22 18:34:33 +0100 |
commit | 9448a913ed3e137176b45c9b304271e47a6da035 (patch) | |
tree | 653e07d6a153c7a82e2fba11c67cc59f1513465e /man/query.3t | |
download | libtiff-git-3.4beta018.tar.gz |
v3.4beta018 releasev3.4beta018
Diffstat (limited to 'man/query.3t')
-rw-r--r-- | man/query.3t | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/man/query.3t b/man/query.3t new file mode 100644 index 00000000..33faf544 --- /dev/null +++ b/man/query.3t @@ -0,0 +1,114 @@ +.\" $Header: /usr/people/sam/tiff/man/RCS/query.3t,v 1.11 1995/07/07 23:29:04 sam Exp $ +.\" +.\" Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994 Sam Leffler +.\" Copyright (c) 1991, 1992, 1993, 1994 Silicon Graphics, Inc. +.\" +.\" Permission to use, copy, modify, distribute, and sell this software and +.\" its documentation for any purpose is hereby granted without fee, provided +.\" that (i) the above copyright notices and this permission notice appear in +.\" all copies of the software and related documentation, and (ii) the names of +.\" Sam Leffler and Silicon Graphics may not be used in any advertising or +.\" publicity relating to the software without the specific, prior written +.\" permission of Sam Leffler and Silicon Graphics. +.\" +.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, +.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY +.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. +.\" +.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR +.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, +.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, +.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF +.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE +.\" OF THIS SOFTWARE. +.\" +.if n .po 0 +.TH QUERY 3T "December 16, 1991" +.SH NAME +TIFFCurrentRow, TIFFCurrentStrip, TIFFCurrentTile, TIFFCurrentDirectory, TIFFFileno, TIFFFileName, TIFFGetMode, TIFFIsTiled, TIFFIsByteSwapped \- query routines +.SH SYNOPSIS +.B "#include <tiffio.h>" +.br +.B "uint32 TIFFCurrentRow(TIFF* tif)" +.br +.B "tstrip_t TIFFCurrentStrip(TIFF* tif)" +.br +.B "ttile_t TIFFCurrentTile(TIFF* tif)" +.br +.B "tdir_t TIFFCurrentDirectory(TIFF* tif)" +.br +.B "int TIFFFileno(TIFF* tif)" +.br +.B "char* TIFFFileName(TIFF* tif)" +.br +.B "int TIFFGetMode(TIFF* tif)" +.br +.B "int TIFFIsTiled(TIFF* tif)" +.br +.B "int TIFFIsByteSwapped(TIFF* tif)" +.br +.B "const char* TIFFGetVersion(void)" +.SH DESCRIPTION +The following routines return status information about an open +.SM TIFF +file. +.PP +.IR TIFFCurrentDirectory +returns the index of the current directory (directories +are numbered starting at 0). +This number is suitable for use with the +.IR TIFFSetDirectory +routine. +.PP +.IR TIFFCurrentRow , +.IR TIFFCurrentStrip , +and +.IR TIFFCurrentTile , +return the current row, strip, and tile, respectively, +that is being read or written. +These values are updated each time a read or write is done. +.PP +.IR TIFFFileno +returns the underlying file descriptor used to access the +.SM TIFF +image in the filesystem. +.PP +.IR TIFFFileName +returns the pathname argument passed to +.IR TIFFOpen +or +.IR TIFFFdOpen . +.PP +.IR TIFFGetMode +returns the mode with which the underlying file was opened. +On +.SM UNIX +systems, this is the value passed to the +.IR open (2) +system call. +.PP +.IR TIFFIsTiled +returns a non-zero value if the image data has +a tiled organization. +Zero is returned if the image data is organized in strips. +.PP +.IR TIFFIsByteSwapped +returns a non-zero value if the image data was in a different +byte-order than the host machine. +Zero is returned if the image data and local host byte-orders +are the same. +Data samples that are more than 8 bits wide must be byte-swapped +by the application. +.PP +.IR TIFFGetVersion +returns an +.SM ASCII +string that has a version stamp for the +.SM TIFF +library software. +.SH DIAGNOSTICS +None. +.SH "SEE ALSO" +.IR intro (3T), +.IR TIFFOpen (3T), +.IR TIFFFdOpen (3T) |