]> git.saurik.com Git - wxWidgets.git/blob - src/tiff/html/man/TIFFWriteEncodedTile.3tiff.html
projects / wxWidgets.git / blob
? search:


5e85f6ddbe453bbff755042374ad7df25e17600b
[wxWidgets.git] / src / tiff / html / man / TIFFWriteEncodedTile.3tiff.html
1 <!-- Creator : groff version 1.18.1 -->
2 <!-- CreationDate: Sat Feb 24 18:37:18 2007 -->
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>TIFFWriteEncodedTile</title>
8 </head>
9 <body>
10
11 <h1 align=center>TIFFWriteEncodedTile</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="#NOTES">NOTES</a><br>
16 <a href="#RETURN VALUES">RETURN VALUES</a><br>
17 <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
18 <a href="#SEE ALSO">SEE ALSO</a><br>
19
20 <hr>
21 <a name="NAME"></a>
22 <h2>NAME</h2>
23 <!-- INDENTATION -->
24 <table width="100%" border=0 rules="none" frame="void"
25 cols="2" cellspacing="0" cellpadding="0">
26 <tr valign="top" align="left">
27 <td width="8%"></td>
28 <td width="91%">
29 <p><big>TIFFWritedEncodedTile &minus; compress and write a
30 tile of data to an open</big> TIFF <big>file</big></p>
31 </td>
32 </table>
33 <a name="SYNOPSIS"></a>
34 <h2>SYNOPSIS</h2>
35 <!-- INDENTATION -->
36 <table width="100%" border=0 rules="none" frame="void"
37 cols="2" cellspacing="0" cellpadding="0">
38 <tr valign="top" align="left">
39 <td width="8%"></td>
40 <td width="91%">
41 <p><big><b>#include &lt;tiffio.h&gt;</b></big></p>
42 <!-- INDENTATION -->
43 <p><big><b>tsize_t TIFFWriteEncodedTile(TIFF
44 *</b><i>tif</i><b>, ttile_t</b> <i>tile</i><b>, tdata_t</b>
45 <i>buf</i><b>, tsize_t</b> <i>size</i><b>)</b></big></p>
46 </td>
47 </table>
48 <a name="DESCRIPTION"></a>
49 <h2>DESCRIPTION</h2>
50 <!-- INDENTATION -->
51 <table width="100%" border=0 rules="none" frame="void"
52 cols="2" cellspacing="0" cellpadding="0">
53 <tr valign="top" align="left">
54 <td width="8%"></td>
55 <td width="91%">
56 <p><big>Compress <i>size</i> bytes of raw data from
57 <i>buf</i> and <b>append</b> the result to the end of the
58 specified tile. Note that the value of <i>tile</i> is a
59 &lsquo;&lsquo;raw tile number.&rsquo;&rsquo; That is, the
60 caller must take into account whether or not the data are
61 organized in separate places (<i>PlanarConfiguration</i>=2).
62 <i>TIFFComputeTile</i> automatically does this when
63 converting an (x,y,z,sample) coordinate quadruple to a tile
64 number.</big></p>
65 </td>
66 </table>
67 <a name="NOTES"></a>
68 <h2>NOTES</h2>
69 <!-- INDENTATION -->
70 <table width="100%" border=0 rules="none" frame="void"
71 cols="2" cellspacing="0" cellpadding="0">
72 <tr valign="top" align="left">
73 <td width="8%"></td>
74 <td width="91%">
75 <p><big>The library writes encoded data using the native
76 machine byte order. Correctly implemented</big> TIFF
77 <big>readers are expected to do any necessary byte-swapping
78 to correctly process image data with BitsPerSample greater
79 than 8.</big></p>
80 </td>
81 </table>
82 <a name="RETURN VALUES"></a>
83 <h2>RETURN VALUES</h2>
84 <!-- INDENTATION -->
85 <table width="100%" border=0 rules="none" frame="void"
86 cols="2" cellspacing="0" cellpadding="0">
87 <tr valign="top" align="left">
88 <td width="8%"></td>
89 <td width="91%">
90 <p><big>&minus;1 is returned if an error was encountered.
91 Otherwise, the value of <i>size</i> is returned.</big></p>
92 </td>
93 </table>
94 <a name="DIAGNOSTICS"></a>
95 <h2>DIAGNOSTICS</h2>
96 <!-- INDENTATION -->
97 <table width="100%" border=0 rules="none" frame="void"
98 cols="2" cellspacing="0" cellpadding="0">
99 <tr valign="top" align="left">
100 <td width="8%"></td>
101 <td width="91%">
102 <p><big>All error messages are directed to the
103 <b>TIFFError</b>(3TIFF) routine.</big></p>
104 <!-- INDENTATION -->
105 <p><big><b>%s: File not open for writing</b>. The file was
106 opened for reading, not writing.</big></p>
107 <!-- INDENTATION -->
108 <p><big><b>Can not write tiles to a stripped image</b>. The
109 image is assumed to be organized in strips because neither
110 of the <i>TileWidth</i> or <i>TileLength</i> tags have been
111 set with <b>TIFFSetField</b>(3TIFF).</big></p>
112 <!-- INDENTATION -->
113 <p><big><b>%s: Must set &quot;ImageWidth&quot; before
114 writing data</b>. The image&rsquo;s width has not be set
115 before the first write. See <b>TIFFSetField</b>(3TIFF) for
116 information on how to do this.</big></p>
117 <!-- INDENTATION -->
118 <p><big><b>%s: Must set &quot;PlanarConfiguration&quot;
119 before writing data</b>. The organization of data has not be
120 defined before the first write. See
121 <b>TIFFSetField</b>(3TIFF) for information on how to do
122 this.</big></p>
123 <!-- INDENTATION -->
124 <p><big><b>%s: No space for tile arrays&quot;</b>. There was
125 not enough space for the arrays that hold tile offsets and
126 byte counts.</big></p>
127 </td>
128 </table>
129 <a name="SEE ALSO"></a>
130 <h2>SEE ALSO</h2>
131 <!-- INDENTATION -->
132 <table width="100%" border=0 rules="none" frame="void"
133 cols="2" cellspacing="0" cellpadding="0">
134 <tr valign="top" align="left">
135 <td width="8%"></td>
136 <td width="91%">
137 <p><big><b>TIFFOpen</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF),
138 <b>TIFFWriteRawTile</b>(3TIFF),
139 <b>libtiff</b>(3TIFF)</big></p>
140 <!-- INDENTATION -->
141 <p><big>Libtiff library home page:
142 <b>http://www.remotesensing.org/libtiff/</b></big></p>
143 </td>
144 </table>
145 <hr>
146 </body>
147 </html>
wxWidgets (Impactor)