Current Directory: /usr/share/doc/libtiff-devel/html/man
Viewing File: /usr/share/doc/libtiff-devel/html/man/TIFFWriteEncodedStrip.3tiff.html
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Sun Nov 2 19:00:00 2025 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<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>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFWritedEncodedStrip
− compress and write a strip of data to an open
<small>TIFF</small> file</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<tiffio.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><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></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">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).</p>
<h2>NOTES
<a name="NOTES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">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.</p>
<p style="margin-left:11%; margin-top: 1em">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>.</p>
<h2>RETURN VALUES
<a name="RETURN VALUES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">−1 is
returned if an error was encountered. Otherwise, the value
of <i>size</i> is returned.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <i>TIFFError</i>(3TIFF)
routine.</p>
<p style="margin-left:11%; margin-top: 1em"><b>%s: File not
open for writing</b>. The file was opened for reading, not
writing.</p>
<p style="margin-left:11%; margin-top: 1em"><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).</p>
<p style="margin-left:11%; margin-top: 1em"><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.</p>
<p style="margin-left:11%; margin-top: 1em"><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.</p>
<p style="margin-left:11%; margin-top: 1em"><b>%s: No space
for strip arrays"</b>. There was not enough space for
the arrays that hold strip offsets and byte counts.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
<b>TIFFWriteScanline</b>(3TIFF),
<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.simplesystems.org/libtiff/</b></p>
<hr>
</body>
</html>