[wxWidgets.git] / src / tiff / man / TIFFquery.3tiff

.\" $Id: TIFFquery.3tiff,v 1.1 2004-11-11 14:39:16 dron Exp $
.\"
.\" Copyright (c) 1988-1997 Sam Leffler
.\" Copyright (c) 1991-1997 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 3TIFF "October 29, 2004" "libtiff"
.SH NAME
TIFFCurrentRow,
TIFFCurrentStrip,
TIFFCurrentTile,
TIFFCurrentDirectory,
TIFFLastDirectory,
TIFFFileno,
TIFFFileName,
TIFFGetMode,
TIFFIsTiled,
TIFFIsByteSwapped,
TIFFIsUpSampled,
TIFFIsMSB2LSB,
TIFFGetVersion
\- query routines
.SH SYNOPSIS
.B "#include <tiffio.h>"
.sp
.BI "uint32 TIFFCurrentRow(TIFF* " tif ")"
.br
.BI "tstrip_t TIFFCurrentStrip(TIFF* " tif ")"
.br
.BI "ttile_t TIFFCurrentTile(TIFF* " tif ")"
.br
.BI "tdir_t TIFFCurrentDirectory(TIFF* " tif ")"
.br
.BI "int TIFFLastDirectory(TIFF* " tif ")"
.br
.BI "int TIFFFileno(TIFF* " tif ")"
.br
.BI "char* TIFFFileName(TIFF* " tif ")"
.br
.BI "int TIFFGetMode(TIFF* " tif ")"
.br
.BI "int TIFFIsTiled(TIFF* " tif ")"
.br
.BI "int TIFFIsByteSwapped(TIFF* " tif ")"
.br
.BI "int TIFFIsUpSampled(TIFF* " tif ")"
.br
.BI "int TIFFIsMSB2LSB(TIFF* " tif ")"
.br
.BI "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 TIFFLastDirectory
returns a non-zero value if the current directory is the last directory in the
file; otherwise zero is returned.
.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 TIFF file and local host byte-orders
are the same.  Note that TIFFReadTile(), TIFFReadStrip() and
TIFFReadScanline() functions already normally perform byte swapping to local
host order if needed.
.PP
.I TIFFIsUpSampled
returns a non-zero value if image data returned through the read interface
routines is being up-sampled. This can be useful to applications that want to
calculate I/O buffer sizes to reflect this usage (though the usual strip and
tile size routines already do this).
.PP
.I TIFFIsMSB2LSB
returns a non-zero value if the image data is being returned with bit 0 as the
most significant bit.
.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 libtiff (3TIFF),
.IR TIFFOpen (3TIFF),
.IR TIFFFdOpen (3TIFF)
Commit	Line	Data
80ed523f	1	.\" $Id: TIFFquery.3tiff,v 1.1 2004-11-11 14:39:16 dron Exp $
8414a40c VZ	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 3TIFF "October 29, 2004" "libtiff"
	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	TIFFGetVersion
	41	\- query routines
	42	.SH SYNOPSIS
	43	.B "#include <tiffio.h>"
	44	.sp
	45	.BI "uint32 TIFFCurrentRow(TIFF* " tif ")"
	46	.br
	47	.BI "tstrip_t TIFFCurrentStrip(TIFF* " tif ")"
	48	.br
	49	.BI "ttile_t TIFFCurrentTile(TIFF* " tif ")"
	50	.br
	51	.BI "tdir_t TIFFCurrentDirectory(TIFF* " tif ")"
	52	.br
	53	.BI "int TIFFLastDirectory(TIFF* " tif ")"
	54	.br
	55	.BI "int TIFFFileno(TIFF* " tif ")"
	56	.br
	57	.BI "char* TIFFFileName(TIFF* " tif ")"
	58	.br
	59	.BI "int TIFFGetMode(TIFF* " tif ")"
	60	.br
	61	.BI "int TIFFIsTiled(TIFF* " tif ")"
	62	.br
	63	.BI "int TIFFIsByteSwapped(TIFF* " tif ")"
	64	.br
	65	.BI "int TIFFIsUpSampled(TIFF* " tif ")"
66	.br
67	.BI "int TIFFIsMSB2LSB(TIFF* " tif ")"
68	.br
69	.BI "const char* TIFFGetVersion(void)"
70	.SH DESCRIPTION
71	The following routines return status information about an open
72	.SM TIFF
73	file.
74	.PP
75	.IR TIFFCurrentDirectory
76	returns the index of the current directory (directories are numbered starting
77	at 0). This number is suitable for use with the
78	.IR TIFFSetDirectory
79	routine.
80	.PP
81	.IR TIFFLastDirectory
82	returns a non-zero value if the current directory is the last directory in the
83	file; otherwise zero is returned.
84	.PP
85	.IR TIFFCurrentRow ,
86	.IR TIFFCurrentStrip ,
87	and
88	.IR TIFFCurrentTile ,
89	return the current row, strip, and tile, respectively, that is being read or
90	written. These values are updated each time a read or write is done.
91	.PP
92	.IR TIFFFileno
93	returns the underlying file descriptor used to access the
94	.SM TIFF
95	image in the filesystem.
96	.PP
97	.IR TIFFFileName
98	returns the pathname argument passed to
99	.IR TIFFOpen
100	or
101	.IR TIFFFdOpen .
102	.PP
103	.IR TIFFGetMode
104	returns the mode with which the underlying file was opened. On
105	.SM UNIX
106	systems, this is the value passed to the
107	.IR open (2)
108	system call.
109	.PP
110	.IR TIFFIsTiled
111	returns a non-zero value if the image data has a tiled organization. Zero is
112	returned if the image data is organized in strips.
113	.PP
114	.IR TIFFIsByteSwapped
115	returns a non-zero value if the image data was in a different byte-order than
116	the host machine. Zero is returned if the TIFF file and local host byte-orders
117	are the same. Note that TIFFReadTile(), TIFFReadStrip() and
118	TIFFReadScanline() functions already normally perform byte swapping to local
119	host order if needed.
120	.PP
121	.I TIFFIsUpSampled
122	returns a non-zero value if image data returned through the read interface
123	routines is being up-sampled. This can be useful to applications that want to
124	calculate I/O buffer sizes to reflect this usage (though the usual strip and
125	tile size routines already do this).
126	.PP
127	.I TIFFIsMSB2LSB
128	returns a non-zero value if the image data is being returned with bit 0 as the
129	most significant bit.
130	.PP
131	.IR TIFFGetVersion
132	returns an
133	.SM ASCII
134	string that has a version stamp for the
135	.SM TIFF
136	library software.
137	.SH DIAGNOSTICS
138	None.
139	.SH "SEE ALSO"
140	.IR libtiff (3TIFF),
141	.IR TIFFOpen (3TIFF),
142	.IR TIFFFdOpen (3TIFF)