1<!-- Creator     : groff version 1.19.2 -->
2<!-- CreationDate: Mon Jan  2 17:41:48 2006 -->
3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4"http://www.w3.org/TR/html4/loose.dtd">
5<html>
6<head>
7<meta name="generator" content="groff -Thtml, see www.gnu.org">
8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9<meta name="Content-Style" content="text/css">
10<style type="text/css">
11       p     { margin-top: 0; margin-bottom: 0; }
12       pre   { margin-top: 0; margin-bottom: 0; }
13       table { margin-top: 0; margin-bottom: 0; }
14</style>
15<title>TIFFWriteEncodedTile</title>
16
17</head>
18<body>
19
20<h1 align=center>TIFFWriteEncodedTile</h1>
21
22<a href="#NAME">NAME</a><br>
23<a href="#SYNOPSIS">SYNOPSIS</a><br>
24<a href="#DESCRIPTION">DESCRIPTION</a><br>
25<a href="#NOTES">NOTES</a><br>
26<a href="#RETURN VALUES">RETURN VALUES</a><br>
27<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
28<a href="#SEE ALSO">SEE ALSO</a><br>
29
30<hr>
31
32
33<a name="NAME"></a>
34<h2>NAME</h2>
35
36
37
38<p style="margin-left:11%; margin-top: 1em">TIFFWritedEncodedTile
39&minus; compress and write a tile of data to an open
40<small>TIFF</small> file</p>
41
42<a name="SYNOPSIS"></a>
43<h2>SYNOPSIS</h2>
44
45
46<p style="margin-left:11%; margin-top: 1em"><b>#include
47&lt;tiffio.h&gt;</b></p>
48
49<p style="margin-left:11%; margin-top: 1em"><b>tsize_t
50TIFFWriteEncodedTile(TIFF *</b><i>tif</i><b>, ttile_t</b>
51<i>tile</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b>
52<i>size</i><b>)</b></p>
53
54<a name="DESCRIPTION"></a>
55<h2>DESCRIPTION</h2>
56
57
58<p style="margin-left:11%; margin-top: 1em">Compress
59<i>size</i> bytes of raw data from <i>buf</i> and
60<b>append</b> the result to the end of the specified tile.
61Note that the value of <i>tile</i> is a &lsquo;&lsquo;raw
62tile number.&rsquo;&rsquo; That is, the caller must take
63into account whether or not the data are organized in
64separate places (<i>PlanarConfiguration</i>=2).
65<i>TIFFComputeTile</i> automatically does this when
66converting an (x,y,z,sample) coordinate quadruple to a tile
67number.</p>
68
69<a name="NOTES"></a>
70<h2>NOTES</h2>
71
72
73<p style="margin-left:11%; margin-top: 1em">The library
74writes encoded data using the native machine byte order.
75Correctly implemented <small>TIFF</small> readers are
76expected to do any necessary byte-swapping to correctly
77process image data with BitsPerSample greater than 8.</p>
78
79<a name="RETURN VALUES"></a>
80<h2>RETURN VALUES</h2>
81
82
83<p style="margin-left:11%; margin-top: 1em">&minus;1 is
84returned if an error was encountered. Otherwise, the value
85of <i>size</i> is returned.</p>
86
87<a name="DIAGNOSTICS"></a>
88<h2>DIAGNOSTICS</h2>
89
90
91<p style="margin-left:11%; margin-top: 1em">All error
92messages are directed to the <b>TIFFError</b>(3TIFF)
93routine.</p>
94
95<p style="margin-left:11%; margin-top: 1em"><b>%s: File not
96open for writing</b>. The file was opened for reading, not
97writing.</p>
98
99<p style="margin-left:11%; margin-top: 1em"><b>Can not
100write tiles to a stripped image</b>. The image is assumed to
101be organized in strips because neither of the
102<i>TileWidth</i> or <i>TileLength</i> tags have been set
103with <b>TIFFSetField</b>(3TIFF).</p>
104
105<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set
106&quot;ImageWidth&quot; before writing data</b>. The
107image&rsquo;s width has not be set before the first write.
108See <b>TIFFSetField</b>(3TIFF) for information on how to do
109this.</p>
110
111<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set
112&quot;PlanarConfiguration&quot; before writing data</b>. The
113organization of data has not be defined before the first
114write. See <b>TIFFSetField</b>(3TIFF) for information on how
115to do this.</p>
116
117<p style="margin-left:11%; margin-top: 1em"><b>%s: No space
118for tile arrays&quot;</b>. There was not enough space for
119the arrays that hold tile offsets and byte counts.</p>
120
121<a name="SEE ALSO"></a>
122<h2>SEE ALSO</h2>
123
124
125
126<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
127<b>TIFFWriteTile</b>(3TIFF), <b>TIFFWriteRawTile</b>(3TIFF),
128<b>libtiff</b>(3TIFF)</p>
129
130<p style="margin-left:11%; margin-top: 1em">Libtiff library
131home page: <b>http://www.remotesensing.org/libtiff/</b></p>
132<hr>
133</body>
134</html>
135