]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/tiff/html/man/TIFFWriteEncodedStrip.3tiff.html
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
fix wxGTK1 compilation after wxTextEntry DoGetValue() change
[wxWidgets.git] / src / tiff / html / man / TIFFWriteEncodedStrip.3tiff.html
... / ...
CommitLineData
1<!-- Creator : groff version 1.18.1 -->
2<!-- CreationDate: Mon Mar 13 18:03:11 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>TIFFWriteEncodedStrip</title>
8</head>
9<body>
10
11<h1 align=center>TIFFWriteEncodedStrip</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>TIFFWritedEncodedStrip &minus; compress and write a
30strip 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 TIFFWriteEncodedStrip(TIFF
44*</b><i>tif</i><b>, tstrip_t</b> <i>strip</i><b>,
45tdata_t</b> <i>buf</i><b>, tsize_t</b>
46<i>size</i><b>)</b></big></p>
47</td>
48</table>
49<a name="DESCRIPTION"></a>
50<h2>DESCRIPTION</h2>
51<!-- INDENTATION -->
52<table width="100%" border=0 rules="none" frame="void"
53 cols="2" cellspacing="0" cellpadding="0">
54<tr valign="top" align="left">
55<td width="8%"></td>
56<td width="91%">
57<p><big>Compress <i>size</i> bytes of raw data from
58<i>buf</i> and write the result to the specified strip;
59replacing any previously written data. Note that the value
60of <i>strip</i> is a &lsquo;&lsquo;raw strip
61number.&rsquo;&rsquo; That is, the caller must take into
62account whether or not the data are organized in separate
63planes (<i>PlanarConfiguration</i>=2).</big></p>
64</td>
65</table>
66<a name="NOTES"></a>
67<h2>NOTES</h2>
68<!-- INDENTATION -->
69<table width="100%" border=0 rules="none" frame="void"
70 cols="2" cellspacing="0" cellpadding="0">
71<tr valign="top" align="left">
72<td width="8%"></td>
73<td width="91%">
74<p><big>The library writes encoded data using the native
75machine byte order. Correctly implemented</big> TIFF
76<big>readers are expected to do any necessary byte-swapping
77to correctly process image data with BitsPerSample greater
78than 8.</big></p>
79<!-- INDENTATION -->
80<p><big>The strip number must be valid according to the
81current settings of the <i>ImageLength</i> and
82<i>RowsPerStrip</i> tags. An image may be dynamically grown
83by increasing the value of <i>ImageLength</i> prior to each
84call to <i>TIFFWriteEncodedStrip</i>.</big></p>
85</td>
86</table>
87<a name="RETURN VALUES"></a>
88<h2>RETURN VALUES</h2>
89<!-- INDENTATION -->
90<table width="100%" border=0 rules="none" frame="void"
91 cols="2" cellspacing="0" cellpadding="0">
92<tr valign="top" align="left">
93<td width="8%"></td>
94<td width="91%">
95<p><big>&minus;1 is returned if an error was encountered.
96Otherwise, the value of <i>size</i> is returned.</big></p>
97</td>
98</table>
99<a name="DIAGNOSTICS"></a>
100<h2>DIAGNOSTICS</h2>
101<!-- INDENTATION -->
102<table width="100%" border=0 rules="none" frame="void"
103 cols="2" cellspacing="0" cellpadding="0">
104<tr valign="top" align="left">
105<td width="8%"></td>
106<td width="91%">
107<p><big>All error messages are directed to the
108<i>TIFFError</i>(3TIFF) routine.</big></p>
109<!-- INDENTATION -->
110<p><big><b>%s: File not open for writing</b>. The file was
111opened for reading, not writing.</big></p>
112<!-- INDENTATION -->
113<p><big><b>Can not write scanlines to a tiled image</b>. The
114image is assumed to be organized in tiles because the
115<i>TileWidth</i> and <i>TileLength</i> tags have been set
116with <i>TIFFSetField</i>(3TIFF).</big></p>
117<!-- INDENTATION -->
118<p><big><b>%s: Must set &quot;ImageWidth&quot; before
119writing data</b>. The image&rsquo;s width has not be set
120before the first write. See <i>TIFFSetField</i>(3TIFF) for
121information on how to do this.</big></p>
122<!-- INDENTATION -->
123<p><big><b>%s: Must set &quot;PlanarConfiguration&quot;
124before writing data</b>. The organization of data has not be
125defined before the first write. See
126<i>TIFFSetField</i>(3TIFF) for information on how to do
127this.</big></p>
128<!-- INDENTATION -->
129<p><big><b>%s: No space for strip arrays&quot;</b>. There
130was not enough space for the arrays that hold strip offsets
131and byte counts.</big></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><big><b>TIFFOpen</b>(3TIFF),
143<b>TIFFWriteScanline</b>(3TIFF),
144<b>TIFFWriteRawStrip</b>(3TIFF),
145<b>libtiff</b>(3TIFF)</big></p>
146<!-- INDENTATION -->
147<p><big>Libtiff library home page:
148<b>http://www.remotesensing.org/libtiff/</b></big></p>
149</td>
150</table>
151<hr>
152</body>
153</html>
wxWidgets (Impactor)