]> git.saurik.com Git - wxWidgets.git/blame - src/tiff/html/man/TIFFstrip.3tiff.html
typo fix
[wxWidgets.git] / src / tiff / html / man / TIFFstrip.3tiff.html
CommitLineData
8414a40c
VZ
1<!-- Creator : groff version 1.18.1 -->
2<!-- CreationDate: Mon Mar 13 18:03:10 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>TIFFSTRIP</title>
8</head>
9<body>
10
11<h1 align=center>TIFFSTRIP</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="#DIAGNOSTICS">DIAGNOSTICS</a><br>
16<a href="#SEE ALSO">SEE ALSO</a><br>
17
18<hr>
19<a name="NAME"></a>
20<h2>NAME</h2>
21<!-- INDENTATION -->
22<table width="100%" border=0 rules="none" frame="void"
23 cols="2" cellspacing="0" cellpadding="0">
24<tr valign="top" align="left">
25<td width="8%"></td>
26<td width="91%">
27<p>TIFFDefaultStripSize, TIFFStripSize, TIFFVStripSize,
28TIFFRawStripSize, TIFFComputeStrip, TIFFNumberOfStrips
29&minus; strip-related utility routines</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>uint32 TIFFDefaultStripSize(TIFF *</b><i>tif</i><b>,
43uint32</b> <i>estimate</i><b>)<br>
44tsize_t TIFFStripSize(TIFF *</b><i>tif</i><b>)<br>
45tsize_t TIFFVStripSize(TIFF *</b><i>tif</i><b>, uint32</b>
46<i>nrows</i><b>)<br>
47tsize_t TIFFRawStripSize(TIFF *</b><i>tif</i><b>,
48tstrip_t</b> <i>strip</i><b>)<br>
49tstrip_t TIFFComputeStrip(TIFF *</b><i>tif</i><b>,
50uint32</b> <i>row</i><b>, tsample_t</b>
51<i>sample</i><b>)<br>
52tstrip_t TIFFNumberOfStrips(TIFF *</b><i>tif</i><b>)</b></p>
53</td>
54</table>
55<a name="DESCRIPTION"></a>
56<h2>DESCRIPTION</h2>
57<!-- INDENTATION -->
58<table width="100%" border=0 rules="none" frame="void"
59 cols="2" cellspacing="0" cellpadding="0">
60<tr valign="top" align="left">
61<td width="8%"></td>
62<td width="91%">
63<p><i>TIFFDefaultStripSize</i> returns the number of rows
64for a reasonable-sized strip according to the current
65settings of the <i>ImageWidth</i>, <i>BitsPerSample</i>,
66<i>SamplesPerPixel</i>, tags and any compression-specific
67requirements. If the <i>estimate</i> parameter, if non-zero,
68then it is taken as an estimate of the desired strip size
69and adjusted according to any compression-specific
70requirements. The value returned by this function is
71typically used to define the <i>RowsPerStrip</i> tag. In
72lieu of any unusual requirements <i>TIFFDefaultStripSize</i>
73tries to create strips that have approximately 8 kilobytes
74of uncompressed data.</p>
75<!-- INDENTATION -->
76<p><i>TIFFStripSize</i> returns the equivalent size for a
77strip of data as it would be returned in a call to
78<i>TIFFReadEncodedStrip</i> or as it would be expected in a
79call to <i>TIFFWriteEncodedStrip</i>.</p>
80<!-- INDENTATION -->
81<p><i>TIFFVStripSize</i> returns the number of bytes in a
82strip with <i>nrows</i> rows of data.</p>
83<!-- INDENTATION -->
84<p><i>TIFFRawStripSize</i> returns the number of bytes in a
85raw strip (i.e. not decoded).</p>
86<!-- INDENTATION -->
87<p><i>TIFFComputeStrip</i> returns the strip that contains
88the specified coordinates. A valid strip is always returned;
89out-of-range coordinate values are clamped to the bounds of
90the image. The <i>row</i> parameter is always used in
91calculating a strip. The <i>sample</i> parameter is used
92only if data are organized in separate planes
93(<i>PlanarConfiguration</i>=2).</p>
94<!-- INDENTATION -->
95<p><i>TIFFNumberOfStrips</i> returns the number of strips in
96the image.</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>None.</p>
108</td>
109</table>
110<a name="SEE ALSO"></a>
111<h2>SEE ALSO</h2>
112<!-- INDENTATION -->
113<table width="100%" border=0 rules="none" frame="void"
114 cols="2" cellspacing="0" cellpadding="0">
115<tr valign="top" align="left">
116<td width="8%"></td>
117<td width="91%">
118<p><b>TIFFReadEncodedStrip</b>(3TIFF),
119<b>TIFFReadRawStrip</b>(3TIFF),
120<b>TIFFWriteEncodedStrip</b>(3TIFF),
121<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF),</p>
122<!-- INDENTATION -->
123<p>Libtiff library home page:
124<b>http://www.remotesensing.org/libtiff/</b></p>
125</td>
126</table>
127<hr>
128</body>
129</html>