]> git.saurik.com Git - wxWidgets.git/blame - src/tiff/html/man/TIFFWriteTile.3tiff.html
fixed messed up indentation
[wxWidgets.git] / src / tiff / html / man / TIFFWriteTile.3tiff.html
CommitLineData
8414a40c
VZ
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>TIFFWriteTile</title>
8</head>
9<body>
10
11<h1 align=center>TIFFWriteTile</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="#RETURN VALUES">RETURN VALUES</a><br>
16<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
17<a href="#SEE ALSO">SEE ALSO</a><br>
18
19<hr>
20<a name="NAME"></a>
21<h2>NAME</h2>
22<!-- INDENTATION -->
23<table width="100%" border=0 rules="none" frame="void"
24 cols="2" cellspacing="0" cellpadding="0">
25<tr valign="top" align="left">
26<td width="8%"></td>
27<td width="91%">
28<p>TIFFWriteTile &minus; encode and write a tile of data to
29an open <small>TIFF</small> file</p>
30</td>
31</table>
32<a name="SYNOPSIS"></a>
33<h2>SYNOPSIS</h2>
34<!-- INDENTATION -->
35<table width="100%" border=0 rules="none" frame="void"
36 cols="2" cellspacing="0" cellpadding="0">
37<tr valign="top" align="left">
38<td width="8%"></td>
39<td width="91%">
40<p><b>#include &lt;tiffio.h&gt;</b></p>
41<!-- INDENTATION -->
42<p><b>tsize_t TIFFWriteTile(TIFF *</b><i>tif</i><b>,
43tdata_t</b> <i>buf</i><b>, uint32</b> <i>x</i><b>,
44uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>,
45tsample_t</b> <i>sample</i><b>)</b></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>Write the data for the tile <i>containing</i> the
57specified coordinates. The data in <i>buf</i> are is
58(potentially) compressed, and written to the indicated file,
59normally being appended to the end of the file. The buffer
60must be contain an entire tile of data. Applications should
61call the routine <i>TIFFTileSize</i> to find out the size
62(in bytes) of a tile buffer. The <i>x</i> and <i>y</i>
63parameters are always used by <i>TIFFWriteTile</i>. The
64<i>z</i> parameter is used if the image is deeper than 1
65slice (<i>ImageDepth</i>&gt;1). The <i>sample</i> parameter
66is used only if data are organized in separate planes
67(<i>PlanarConfiguration</i>=2).</p>
68</td>
69</table>
70<a name="RETURN VALUES"></a>
71<h2>RETURN VALUES</h2>
72<!-- INDENTATION -->
73<table width="100%" border=0 rules="none" frame="void"
74 cols="2" cellspacing="0" cellpadding="0">
75<tr valign="top" align="left">
76<td width="8%"></td>
77<td width="91%">
78<p><i>TIFFWriteTile</i> returns &minus;1 if it detects an
79error; otherwise the number of bytes in the tile is
80returned.</p>
81</td>
82</table>
83<a name="DIAGNOSTICS"></a>
84<h2>DIAGNOSTICS</h2>
85<!-- INDENTATION -->
86<table width="100%" border=0 rules="none" frame="void"
87 cols="2" cellspacing="0" cellpadding="0">
88<tr valign="top" align="left">
89<td width="8%"></td>
90<td width="91%">
91<p>All error messages are directed to the
92<b>TIFFError</b>(3TIFF) routine.</p>
93</td>
94</table>
95<a name="SEE ALSO"></a>
96<h2>SEE ALSO</h2>
97<!-- INDENTATION -->
98<table width="100%" border=0 rules="none" frame="void"
99 cols="2" cellspacing="0" cellpadding="0">
100<tr valign="top" align="left">
101<td width="8%"></td>
102<td width="91%">
103<p><b>TIFFCheckTile</b>(3TIFF),
104<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF),
105<b>TIFFReadTile</b>(3TIFF), <b>TIFFWriteScanline</b>(3TIFF),
106<b>TIFFWriteEncodedTile</b>(3TIFF),
107<b>TIFFWriteRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
108<!-- INDENTATION -->
109<p>Libtiff library home page:
110<b>http://www.remotesensing.org/libtiff/</b></p>
111</td>
112</table>
113<hr>
114</body>
115</html>