146 lines
5.3 KiB
HTML
146 lines
5.3 KiB
HTML
<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>
|
|
<!-- Creator : groff version 1.17.2 -->
|
|
<!-- CreationDate: Thu Nov 27 17:58:06 2003 -->
|
|
<a name="NAME"></a>
|
|
<h2>NAME</h2>
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
TIFFWritedEncodedStrip - compress and write a strip of data to an open <small>TIFF</small> file</td></table>
|
|
<a name="SYNOPSIS"></a>
|
|
<h2>SYNOPSIS</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>#include <tiffio.h><br>
|
|
tsize_t TIFFWriteEncodedStrip(TIFF* tif, tstrip_t strip,
|
|
tdata_t buf, tsize_t size)</b></td></table>
|
|
<a name="DESCRIPTION"></a>
|
|
<h2>DESCRIPTION</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
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 places (<i>PlanarConfiguration</i>=2).</td></table>
|
|
<a name="NOTES"></a>
|
|
<h2>NOTES</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
The library writes encoded data using the native machine
|
|
byte order. Correctly implemented <small>TIFF</small>
|
|
readers are expected to do any necessary byte-swapping to
|
|
correctly process image data with BitsPerSample greater than
|
|
8.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
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>.</td></table>
|
|
<a name="RETURN VALUES"></a>
|
|
<h2>RETURN VALUES</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
-1 is returned if an error was encountered. Otherwise, the
|
|
value of <i>size</i> is returned.</td></table>
|
|
<a name="DIAGNOSTICS"></a>
|
|
<h2>DIAGNOSTICS</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
All error messages are directed to the <i>TIFFError</i>(3T)
|
|
routine.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>%s: File not open for writing</b>. The file was opened
|
|
for reading, not writing.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<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>(3T).</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<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>(3T) for information on how to
|
|
do this.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<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>(3T)
|
|
for information on how to do this.</td></table>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<b>%s: No space for strip arrays"</b>. There was not
|
|
enough space for the arrays that hold strip offsets and byte
|
|
counts.</td></table>
|
|
<a name="SEE ALSO"></a>
|
|
<h2>SEE ALSO</h2>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="10%"></td><td width="90%">
|
|
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
|
|
<i>TIFFWriteScanline</i>(3T),
|
|
<i>TIFFWriteRawStrip</i>(3T)</td></table>
|
|
<hr>
|
|
</body>
|
|
</html>
|