libtiff/html/man/TIFFquery.3t.html

175 lines
6.3 KiB
HTML
Raw Normal View History

2002-10-07 09:47:36 -04:00
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<title>QUERY</title>
</head>
<body>
<h1 align=center>QUERY</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
2003-11-27 10:07:01 -05:00
<!-- Creator : groff version 1.17.2 -->
2003-12-21 16:47:11 -05:00
<!-- CreationDate: Mon Dec 22 00:39:23 2003 -->
2002-10-07 09:47:36 -04:00
<a name="NAME"></a>
<h2>NAME</h2>
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
TIFFCurrentRow, TIFFCurrentStrip, TIFFCurrentTile, TIFFCurrentDirectory, TIFFLastDirectory, TIFFFileno, TIFFFileName, TIFFGetMode, TIFFIsTiled, TIFFIsByteSwapped, TIFFIsUpSampled, TIFFIsMSB2LSB - query routines</td></table>
2002-10-07 09:47:36 -04:00
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
2002-10-07 09:47:36 -04:00
<pre><b>#include &lt;tiffio.h&gt;
uint32 TIFFCurrentRow(TIFF* tif)
tstrip_t TIFFCurrentStrip(TIFF* tif)
ttile_t TIFFCurrentTile(TIFF* tif)
tdir_t TIFFCurrentDirectory(TIFF* tif)
int TIFFLastDirectory(TIFF* tif)
int TIFFFileno(TIFF* tif)
char* TIFFFileName(TIFF* tif)
int TIFFGetMode(TIFF* tif)
int TIFFIsTiled(TIFF* tif)
int TIFFIsByteSwapped(TIFF* tif)
int TIFFIsUpSampled(TIFF* tif)
int TIFFIsMSB2LSB(TIFF* tif)
const char* TIFFGetVersion(void)
2003-11-27 10:07:01 -05:00
</b></pre></td></table>
2002-10-07 09:47:36 -04:00
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
The following routines return status information about an
open <small>TIFF</small> file.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFCurrentDirectory</i> returns the index of the current
directory (directories are numbered starting at 0). This
number is suitable for use with the <i>TIFFSetDirectory</i>
routine.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFLastDirectory</i> returns a non-zero value if the
2002-10-07 09:47:36 -04:00
current directory is the last directory in the file;
2003-11-27 10:07:01 -05:00
otherwise zero is returned.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFCurrentRow</i>, <i>TIFFCurrentStrip</i>, and
2002-10-07 09:47:36 -04:00
<i>TIFFCurrentTile</i>, return the current row, strip, and
tile, respectively, that is being read or written. These
2003-11-27 10:07:01 -05:00
values are updated each time a read or write is
done.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFFileno</i> returns the underlying file descriptor
2002-10-07 09:47:36 -04:00
used to access the <small>TIFF</small> image in the
2003-11-27 10:07:01 -05:00
filesystem.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFFileName</i> returns the pathname argument passed to
<i>TIFFOpen</i> or <i>TIFFFdOpen</i>.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFGetMode</i> returns the mode with which the
2002-10-07 09:47:36 -04:00
underlying file was opened. On <small>UNIX</small> systems,
this is the value passed to the <i>open</i>(2) system
2003-11-27 10:07:01 -05:00
call.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFIsTiled</i> returns a non-zero value if the image
2002-10-07 09:47:36 -04:00
data has a tiled organization. Zero is returned if the image
2003-11-27 10:07:01 -05:00
data is organized in strips.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFIsByteSwapped</i> returns a non-zero value if the
2002-10-07 09:47:36 -04:00
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
2003-11-27 10:07:01 -05:00
needed.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFIsUpSampled</i> returns a non-zero value if image
2002-10-07 09:47:36 -04:00
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
2003-11-27 10:07:01 -05:00
usual strip and tile size routines already do
this).</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFIsMSB2LSB</i> returns a non-zero value if the image
data is being returned with bit 0 as the most significant
bit.</td></table>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<i>TIFFGetVersion</i> returns an <small>ASCII</small> string
that has a version stamp for the <small>TIFF</small> library
software.</td></table>
2002-10-07 09:47:36 -04:00
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
None.</td></table>
2002-10-07 09:47:36 -04:00
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
2003-11-27 10:07:01 -05:00
<table width="100%" border=0 rules="none" frame="void"
2002-10-07 09:47:36 -04:00
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
2003-11-27 10:07:01 -05:00
<td width="10%"></td><td width="90%">
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
<i>TIFFFdOpen</i>(3T)</td></table>
2002-10-07 09:47:36 -04:00
<hr>
</body>
</html>