<!-- Creator : groff version 1.18.1 --> | |
<!-- CreationDate: Fri Jul 13 17:43:17 2007 --> | |
<html> | |
<head> | |
<meta name="generator" content="groff -Thtml, see www.gnu.org"> | |
<meta name="Content-Style" content="text/css"> | |
<title>TIFFWriteEncodedStrip</title> | |
</head> | |
<body> | |
<h1 align=center>TIFFWriteEncodedStrip</h1> | |
<a href="#NAME">NAME</a><br> | |
<a href="#SYNOPSIS">SYNOPSIS</a><br> | |
<a href="#DESCRIPTION">DESCRIPTION</a><br> | |
<a href="#NOTES">NOTES</a><br> | |
<a href="#RETURN VALUES">RETURN VALUES</a><br> | |
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> | |
<a href="#SEE ALSO">SEE ALSO</a><br> | |
<hr> | |
<a name="NAME"></a> | |
<h2>NAME</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big>TIFFWritedEncodedStrip − compress and write a | |
strip of data to an open</big> TIFF <big>file</big></p> | |
</td> | |
</table> | |
<a name="SYNOPSIS"></a> | |
<h2>SYNOPSIS</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big><b>#include <tiffio.h></b></big></p> | |
<!-- INDENTATION --> | |
<p><big><b>tsize_t TIFFWriteEncodedStrip(TIFF | |
*</b><i>tif</i><b>, tstrip_t</b> <i>strip</i><b>, | |
tdata_t</b> <i>buf</i><b>, tsize_t</b> | |
<i>size</i><b>)</b></big></p> | |
</td> | |
</table> | |
<a name="DESCRIPTION"></a> | |
<h2>DESCRIPTION</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big>Compress <i>size</i> bytes of raw data from | |
<i>buf</i> and write the result to the specified strip; | |
replacing any previously written data. Note that the value | |
of <i>strip</i> is a ‘‘raw strip | |
number.’’ That is, the caller must take into | |
account whether or not the data are organized in separate | |
planes (<i>PlanarConfiguration</i>=2).</big></p> | |
</td> | |
</table> | |
<a name="NOTES"></a> | |
<h2>NOTES</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big>The library writes encoded data using the native | |
machine byte order. Correctly implemented</big> TIFF | |
<big>readers are expected to do any necessary byte-swapping | |
to correctly process image data with BitsPerSample greater | |
than 8.</big></p> | |
<!-- INDENTATION --> | |
<p><big>The strip number must be valid according to the | |
current settings of the <i>ImageLength</i> and | |
<i>RowsPerStrip</i> tags. An image may be dynamically grown | |
by increasing the value of <i>ImageLength</i> prior to each | |
call to <i>TIFFWriteEncodedStrip</i>.</big></p> | |
</td> | |
</table> | |
<a name="RETURN VALUES"></a> | |
<h2>RETURN VALUES</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big>−1 is returned if an error was encountered. | |
Otherwise, the value of <i>size</i> is returned.</big></p> | |
</td> | |
</table> | |
<a name="DIAGNOSTICS"></a> | |
<h2>DIAGNOSTICS</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big>All error messages are directed to the | |
<i>TIFFError</i>(3TIFF) routine.</big></p> | |
<!-- INDENTATION --> | |
<p><big><b>%s: File not open for writing</b>. The file was | |
opened for reading, not writing.</big></p> | |
<!-- INDENTATION --> | |
<p><big><b>Can not write scanlines to a tiled image</b>. The | |
image is assumed to be organized in tiles because the | |
<i>TileWidth</i> and <i>TileLength</i> tags have been set | |
with <i>TIFFSetField</i>(3TIFF).</big></p> | |
<!-- INDENTATION --> | |
<p><big><b>%s: Must set "ImageWidth" before | |
writing data</b>. The image’s width has not be set | |
before the first write. See <i>TIFFSetField</i>(3TIFF) for | |
information on how to do this.</big></p> | |
<!-- INDENTATION --> | |
<p><big><b>%s: Must set "PlanarConfiguration" | |
before writing data</b>. The organization of data has not be | |
defined before the first write. See | |
<i>TIFFSetField</i>(3TIFF) for information on how to do | |
this.</big></p> | |
<!-- INDENTATION --> | |
<p><big><b>%s: No space for strip arrays"</b>. There | |
was not enough space for the arrays that hold strip offsets | |
and byte counts.</big></p> | |
</td> | |
</table> | |
<a name="SEE ALSO"></a> | |
<h2>SEE ALSO</h2> | |
<!-- INDENTATION --> | |
<table width="100%" border=0 rules="none" frame="void" | |
cols="2" cellspacing="0" cellpadding="0"> | |
<tr valign="top" align="left"> | |
<td width="8%"></td> | |
<td width="91%"> | |
<p><big><b>TIFFOpen</b>(3TIFF), | |
<b>TIFFWriteScanline</b>(3TIFF), | |
<b>TIFFWriteRawStrip</b>(3TIFF), | |
<b>libtiff</b>(3TIFF)</big></p> | |
<!-- INDENTATION --> | |
<p><big>Libtiff library home page: | |
<b>http://www.remotesensing.org/libtiff/</b></big></p> | |
</td> | |
</table> | |
<hr> | |
</body> | |
</html> |