blob: 71b8e2acaf3614b2063ebea127825665d50c4151 (
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
|
<!-- 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>TIFFReadEncodedStrip</title>
</head>
<body>
<h1 align="center">TIFFReadEncodedStrip</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#NOTES">NOTES</a><br>
<a href="#RETURN VALUES">RETURN VALUES</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">TIFFReadEncodedStrip
− read and decode a strip of data from an open
<small>TIFF</small> file</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<tiffio.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>tmsize_t
TIFFReadEncodedStrip(TIFF *</b><i>tif</i><b>, uint32_t</b>
<i>strip</i><b>, void *</b><i>buf</i><b>, tmsize_t</b>
<i>size</i><b>)</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Read the
specified strip of data and place up to <i>size</i> bytes of
decompressed information in the (user supplied) data
buffer.</p>
<h2>NOTES
<a name="NOTES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The value of
<i>strip</i> is a ‘‘raw strip
number.’’ That is, the caller must take into
account whether or not the data are organized in separate
planes (<i>PlanarConfiguration</i>=2). To read a full strip
of data the data buffer should typically be at least as
large as the number returned by <b>TIFFStripSize</b>(3TIFF).
If the -1 passed in <i>size</i> parameter, the whole strip
will be read. You should be sure you have enough space
allocated for the buffer.</p>
<p style="margin-left:11%; margin-top: 1em">The library
attempts to hide bit- and byte-ordering differences between
the image and the native machine by converting data to the
native machine order. Bit reversal is done if the
<i>FillOrder</i> tag is opposite to the native machine bit
order. 16- and 32-bit samples are automatically byte-swapped
if the file was written with a byte order opposite to the
native machine byte order,</p>
<h2>RETURN VALUES
<a name="RETURN VALUES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The actual
number of bytes of data that were placed in <i>buf</i> is
returned; <i>TIFFReadEncodedStrip</i> returns −1 if an
error was encountered.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <b>TIFFError</b>(3TIFF)
routine.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
<b>TIFFReadRawStrip</b>(3TIFF),
<b>TIFFReadScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.simplesystems.org/libtiff/</b></p>
<hr>
</body>
</html>
|
