2002-10-07 09:47:36 -04:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
|
|
|
<meta name="Content-Style" content="text/css">
|
|
|
|
|
<title>TIFFReadEncodedStrip</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h1 align=center>TIFFReadEncodedStrip</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>
|
2003-11-27 10:07:01 -05:00
|
|
|
<!-- Creator : groff version 1.17.2 -->
|
|
|
|
|
<!-- CreationDate: Thu Nov 27 17:58:01 2003 -->
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="NAME"></a>
|
|
|
|
|
<h2>NAME</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
TIFFReadEncodedStrip - read and decode a strip of data from an open <small>TIFF</small> file</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="SYNOPSIS"></a>
|
|
|
|
|
<h2>SYNOPSIS</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>#include <tiffio.h><br>
|
2002-10-07 09:47:36 -04:00
|
|
|
tsize_t TIFFReadEncodedStrip(TIFF* tif, tstrip_t strip,
|
2003-11-27 10:07:01 -05:00
|
|
|
tdata_t buf, tsize_t size)</b></td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="DESCRIPTION"></a>
|
|
|
|
|
<h2>DESCRIPTION</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
Read the specified strip of data and place up to <i>size</i>
|
|
|
|
|
bytes of decompressed information in the (user supplied)
|
|
|
|
|
data buffer.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="NOTES"></a>
|
|
|
|
|
<h2>NOTES</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
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). To read a full strip of data
|
|
|
|
|
the data buffer should typically be at least as large as the
|
|
|
|
|
number returned by <i>TIFFStripSize</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%">
|
|
|
|
|
The library attempts to hide bit- and byte-ordering
|
2002-10-07 09:47:36 -04:00
|
|
|
differences between the image and the native machine by
|
|
|
|
|
converting data to the native machine order. Bit reversal is
|
|
|
|
|
done if the <i>FillOrder</i> tag is opposite to the native
|
|
|
|
|
machine bit order. 16- and 32-bit samples are automatically
|
|
|
|
|
byte-swapped if the file was written with a byte order
|
2003-11-27 10:07:01 -05:00
|
|
|
opposite to the native machine byte order,</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="RETURN VALUES"></a>
|
|
|
|
|
<h2>RETURN VALUES</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
The actual number of bytes of data that were placed in
|
|
|
|
|
<i>buf</i> is returned; <i>TIFFReadEncodedStrip</i> returns
|
|
|
|
|
-1 if an error was encountered.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="DIAGNOSTICS"></a>
|
|
|
|
|
<h2>DIAGNOSTICS</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
All error messages are directed to the <i>TIFFError</i>(3T)
|
|
|
|
|
routine.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="SEE ALSO"></a>
|
|
|
|
|
<h2>SEE ALSO</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
|
2002-10-07 09:47:36 -04:00
|
|
|
<i>TIFFReadRawStrip</i>(3T),
|
2003-11-27 10:07:01 -05:00
|
|
|
<i>TIFFReadScanline</i>(3T)</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<hr>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
