summaryrefslogtreecommitdiff
path: root/doc/static/man/TIFFquery.3tiff.html
blob: 8af961f37cb855ce189a33cae1421d786c5a8ea8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!-- Creator     : groff version 1.22.4 -->
<!-- CreationDate: Sat Jun  4 16:23:26 2022 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<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>


<h2>NAME
<a name="NAME"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em">TIFFCurrentRow,
TIFFCurrentStrip, TIFFCurrentTile, TIFFCurrentDirectory,
TIFFLastDirectory, TIFFFileno, TIFFFileName, TIFFGetMode,
TIFFIsTiled, TIFFIsByteSwapped, TIFFIsUpSampled,
TIFFIsMSB2LSB, TIFFGetVersion &minus; query routines</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;tiffio.h&gt;</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>uint32_t
TIFFCurrentRow(TIFF*</b> <i>tif</i><b>) <br>
tstrip_t TIFFCurrentStrip(TIFF*</b> <i>tif</i><b>) <br>
ttile_t TIFFCurrentTile(TIFF*</b> <i>tif</i><b>) <br>
tdir_t TIFFCurrentDirectory(TIFF*</b> <i>tif</i><b>) <br>
int TIFFLastDirectory(TIFF*</b> <i>tif</i><b>) <br>
int TIFFFileno(TIFF*</b> <i>tif</i><b>) <br>
char* TIFFFileName(TIFF*</b> <i>tif</i><b>) <br>
int TIFFGetMode(TIFF*</b> <i>tif</i><b>) <br>
int TIFFIsTiled(TIFF*</b> <i>tif</i><b>) <br>
int TIFFIsByteSwapped(TIFF*</b> <i>tif</i><b>) <br>
int TIFFIsUpSampled(TIFF*</b> <i>tif</i><b>) <br>
int TIFFIsMSB2LSB(TIFF*</b> <i>tif</i><b>) <br>
const char* TIFFGetVersion(void)</b></p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The following
routines return status information about an open
<small>TIFF</small> file.</p>


<p style="margin-left:11%; margin-top: 1em"><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.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFLastDirectory</i>
returns a non-zero value if the current directory is the
last directory in the file; otherwise zero is returned.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFCurrentRow</i>,
<i>TIFFCurrentStrip</i>, and <i>TIFFCurrentTile</i>, 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.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFFileno</i>
returns the underlying file descriptor used to access the
<small>TIFF</small> image in the filesystem.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFFileName</i>
returns the pathname argument passed to <i>TIFFOpen</i> or
<i>TIFFFdOpen</i>.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetMode</i>
returns the mode with which the underlying file was opened.
On <small>UNIX</small> systems, this is the value passed to
the <i>open</i>(2) system call.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsTiled</i>
returns a non-zero value if the image data has a tiled
organization. Zero is returned if the image data is
organized in strips.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsByteSwapped</i>
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(), TIFFReadEncodedStrip() and
TIFFReadScanline() functions already normally perform byte
swapping to local host order if needed.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsUpSampled</i>
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).</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsMSB2LSB</i>
returns a non-zero value if the image data is being returned
with bit 0 as the most significant bit.</p>


<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetVersion</i>
returns an <small>ASCII</small> string that has a version
stamp for the <small>TIFF</small> library software.</p>

<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">None.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><i>libtiff</i>(3TIFF),
<i>TIFFOpen</i>(3TIFF), <i>TIFFFdOpen</i>(3TIFF)</p>
<hr>
</body>
</html>