src/tiff/html/man/TIFFquery.3tiff.html

   1 <!-- Creator     : groff version 1.18.1 -->
   2 <!-- CreationDate: Mon Mar 13 18:03:09 2006 -->
   3 <html>
   4 <head>
   5 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   6 <meta name="Content-Style" content="text/css">
   7 <title>QUERY</title>
   8 </head>
   9 <body>
  10
  11 <h1 align=center>QUERY</h1>
  12 <a href="#NAME">NAME</a><br>
  13 <a href="#SYNOPSIS">SYNOPSIS</a><br>
  14 <a href="#DESCRIPTION">DESCRIPTION</a><br>
  15 <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
  16 <a href="#SEE ALSO">SEE ALSO</a><br>
  17
  18 <hr>
  19 <a name="NAME"></a>
  20 <h2>NAME</h2>
  21 <!-- INDENTATION -->
  22 <table width="100%" border=0 rules="none" frame="void"
  23        cols="2" cellspacing="0" cellpadding="0">
  24 <tr valign="top" align="left">
  25 <td width="8%"></td>
  26 <td width="91%">
  27 <p>TIFFCurrentRow, TIFFCurrentStrip, TIFFCurrentTile,
  28 TIFFCurrentDirectory, TIFFLastDirectory, TIFFFileno,
  29 TIFFFileName, TIFFGetMode, TIFFIsTiled, TIFFIsByteSwapped,
  30 TIFFIsUpSampled, TIFFIsMSB2LSB, TIFFGetVersion &minus; query
  31 routines</p>
  32 </td>
  33 </table>
  34 <a name="SYNOPSIS"></a>
  35 <h2>SYNOPSIS</h2>
  36 <!-- INDENTATION -->
  37 <table width="100%" border=0 rules="none" frame="void"
  38        cols="2" cellspacing="0" cellpadding="0">
  39 <tr valign="top" align="left">
  40 <td width="8%"></td>
  41 <td width="91%">
  42 <p><b>#include &lt;tiffio.h&gt;</b></p>
  43 <!-- INDENTATION -->
  44 <p><b>uint32 TIFFCurrentRow(TIFF*</b> <i>tif</i><b>)<br>
  45 tstrip_t TIFFCurrentStrip(TIFF*</b> <i>tif</i><b>)<br>
  46 ttile_t TIFFCurrentTile(TIFF*</b> <i>tif</i><b>)<br>
  47 tdir_t TIFFCurrentDirectory(TIFF*</b> <i>tif</i><b>)<br>
  48 int TIFFLastDirectory(TIFF*</b> <i>tif</i><b>)<br>
  49 int TIFFFileno(TIFF*</b> <i>tif</i><b>)<br>
  50 char* TIFFFileName(TIFF*</b> <i>tif</i><b>)<br>
  51 int TIFFGetMode(TIFF*</b> <i>tif</i><b>)<br>
  52 int TIFFIsTiled(TIFF*</b> <i>tif</i><b>)<br>
  53 int TIFFIsByteSwapped(TIFF*</b> <i>tif</i><b>)<br>
  54 int TIFFIsUpSampled(TIFF*</b> <i>tif</i><b>)<br>
  55 int TIFFIsMSB2LSB(TIFF*</b> <i>tif</i><b>)<br>
  56 const char* TIFFGetVersion(void)</b></p>
  57 </td>
  58 </table>
  59 <a name="DESCRIPTION"></a>
  60 <h2>DESCRIPTION</h2>
  61 <!-- INDENTATION -->
  62 <table width="100%" border=0 rules="none" frame="void"
  63        cols="2" cellspacing="0" cellpadding="0">
  64 <tr valign="top" align="left">
  65 <td width="8%"></td>
  66 <td width="91%">
  67 <p>The following routines return status information about an
  68 open <small>TIFF</small> file.</p>
  69 <!-- INDENTATION -->
  70 <p><i>TIFFCurrentDirectory</i> returns the index of the
  71 current directory (directories are numbered starting at 0).
  72 This number is suitable for use with the
  73 <i>TIFFSetDirectory</i> routine.</p>
  74 <!-- INDENTATION -->
  75 <p><i>TIFFLastDirectory</i> returns a non-zero value if the
  76 current directory is the last directory in the file;
  77 otherwise zero is returned.</p>
  78 <!-- INDENTATION -->
  79 <p><i>TIFFCurrentRow</i>, <i>TIFFCurrentStrip</i>, and
  80 <i>TIFFCurrentTile</i>, return the current row, strip, and
  81 tile, respectively, that is being read or written. These
  82 values are updated each time a read or write is done.</p>
  83 <!-- INDENTATION -->
  84 <p><i>TIFFFileno</i> returns the underlying file descriptor
  85 used to access the <small>TIFF</small> image in the
  86 filesystem.</p>
  87 <!-- INDENTATION -->
  88 <p><i>TIFFFileName</i> returns the pathname argument passed
  89 to <i>TIFFOpen</i> or <i>TIFFFdOpen</i>.</p>
  90 <!-- INDENTATION -->
  91 <p><i>TIFFGetMode</i> returns the mode with which the
  92 underlying file was opened. On <small>UNIX</small> systems,
  93 this is the value passed to the <i>open</i>(2) system
  94 call.</p>
  95 <!-- INDENTATION -->
  96 <p><i>TIFFIsTiled</i> returns a non-zero value if the image
  97 data has a tiled organization. Zero is returned if the image
  98 data is organized in strips.</p>
  99 <!-- INDENTATION -->
 100 <p><i>TIFFIsByteSwapped</i> returns a non-zero value if the
 101 image data was in a different byte-order than the host
 102 machine. Zero is returned if the TIFF file and local host
 103 byte-orders are the same. Note that TIFFReadTile(),
 104 TIFFReadStrip() and TIFFReadScanline() functions already
 105 normally perform byte swapping to local host order if
 106 needed.</p>
 107 <!-- INDENTATION -->
 108 <p><i>TIFFIsUpSampled</i> returns a non-zero value if image
 109 data returned through the read interface routines is being
 110 up-sampled. This can be useful to applications that want to
 111 calculate I/O buffer sizes to reflect this usage (though the
 112 usual strip and tile size routines already do this).</p>
 113 <!-- INDENTATION -->
 114 <p><i>TIFFIsMSB2LSB</i> returns a non-zero value if the
 115 image data is being returned with bit 0 as the most
 116 significant bit.</p>
 117 <!-- INDENTATION -->
 118 <p><i>TIFFGetVersion</i> returns an <small>ASCII</small>
 119 string that has a version stamp for the <small>TIFF</small>
 120 library software.</p>
 121 </td>
 122 </table>
 123 <a name="DIAGNOSTICS"></a>
 124 <h2>DIAGNOSTICS</h2>
 125 <!-- INDENTATION -->
 126 <table width="100%" border=0 rules="none" frame="void"
 127        cols="2" cellspacing="0" cellpadding="0">
 128 <tr valign="top" align="left">
 129 <td width="8%"></td>
 130 <td width="91%">
 131 <p>None.</p>
 132 </td>
 133 </table>
 134 <a name="SEE ALSO"></a>
 135 <h2>SEE ALSO</h2>
 136 <!-- INDENTATION -->
 137 <table width="100%" border=0 rules="none" frame="void"
 138        cols="2" cellspacing="0" cellpadding="0">
 139 <tr valign="top" align="left">
 140 <td width="8%"></td>
 141 <td width="91%">
 142 <p><i>libtiff</i>(3TIFF), <i>TIFFOpen</i>(3TIFF),
 143 <i>TIFFFdOpen</i>(3TIFF)</p>
 144 </td>
 145 </table>
 146 <hr>
 147 </body>
 148 </html>