/usr/share/doc/libtiff-devel/html/man
<!-- Creator : groff version 1.18.1 --> <!-- CreationDate: Sat Feb 24 18:37:17 2007 --> <html> <head> <meta name="generator" content="groff -Thtml, see www.gnu.org"> <meta name="Content-Style" content="text/css"> <title>TIFFReadScanline</title> </head> <body> <h1 align=center>TIFFReadScanline</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="#BUGS">BUGS</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>TIFFReadScanline − read and decode a scanline of data from an open <small>TIFF</small> file</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><b>#include <tiffio.h></b></p> <!-- INDENTATION --> <p><b>int TIFFReadScanline(TIFF *</b><i>tif</i><b>, tdata_t</b> <i>buf</i><b>, uint32_t</b> <i>row</i><b>, tsample_t</b> <i>sample</i><b>)</b></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>Read the data for the specified row into the (user supplied) data buffer <i>buf</i>. The data are returned decompressed and, in the native byte- and bit-ordering, but are otherwise packed (see further below). The buffer must be large enough to hold an entire scanline of data. Applications should call the routine <i>TIFFScanlineSize</i> to find out the size (in bytes) of a scanline buffer. The <i>row</i> parameter is always used by <i>TIFFReadScanline</i>; the <i>sample</i> parameter is used only if data are organized in separate planes (<i>PlanarConfiguration</i>=2).</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>The library attempts to hide bit- and byte-ordering 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 opposite to the native machine byte order,</p> <!-- INDENTATION --> <p>In C++ the <i>sample</i> parameter defaults to 0.</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><i>TIFFReadScanline</i> returns −1 if it detects an error; otherwise 1 is returned.</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>All error messages are directed to the <i>TIFFError</i>(3TIFF) routine.</p> <!-- INDENTATION --> <p><b>Compression algorithm does not support random access</b>. Data was requested in a non-sequential order from a file that uses a compression algorithm and that has <i>RowsPerStrip</i> greater than one. That is, data in the image is stored in a compressed form, and with multiple rows packed into a strip. In this case, the library does not support random access to the data. The data should either be accessed sequentially, or the file should be converted so that each strip is made up of one row of data.</p> </td> </table> <a name="BUGS"></a> <h2>BUGS</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>Reading subsampled YCbCR data does not work correctly because, for <i>PlanarConfiguration</i>=2 the size of a scanline is not calculated on a per-sample basis, and for <i>PlanarConfiguration</i>=1 the library does not unpack the block-interleaved samples; use the strip- and tile-based interfaces to read these formats.</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><b>TIFFOpen</b>(3TIFF), <b>TIFFReadEncodedStrip</b>(3TIFF), <b>TIFFReadRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> <!-- INDENTATION --> <p>Libtiff library home page: <b>http://www.simplesystems.org/libtiff/</b></p> </td> </table> <hr> </body> </html>
.
Edit
..
Edit
CMakeLists.txt
Edit
HtmlDoc.cmake
Edit
TIFFClose.3tiff.html
Edit
TIFFDataWidth.3tiff.html
Edit
TIFFError.3tiff.html
Edit
TIFFFieldDataType.3tiff.html
Edit
TIFFFieldName.3tiff.html
Edit
TIFFFieldPassCount.3tiff.html
Edit
TIFFFieldReadCount.3tiff.html
Edit
TIFFFieldTag.3tiff.html
Edit
TIFFFieldWriteCount.3tiff.html
Edit
TIFFFlush.3tiff.html
Edit
TIFFGetField.3tiff.html
Edit
TIFFOpen.3tiff.html
Edit
TIFFPrintDirectory.3tiff.html
Edit
TIFFRGBAImage.3tiff.html
Edit
TIFFReadDirectory.3tiff.html
Edit
TIFFReadEncodedStrip.3tiff.html
Edit
TIFFReadEncodedTile.3tiff.html
Edit
TIFFReadRGBAImage.3tiff.html
Edit
TIFFReadRGBAStrip.3tiff.html
Edit
TIFFReadRGBATile.3tiff.html
Edit
TIFFReadRawStrip.3tiff.html
Edit
TIFFReadRawTile.3tiff.html
Edit
TIFFReadScanline.3tiff.html
Edit
TIFFReadTile.3tiff.html
Edit
TIFFSetDirectory.3tiff.html
Edit
TIFFSetField.3tiff.html
Edit
TIFFWarning.3tiff.html
Edit
TIFFWriteDirectory.3tiff.html
Edit
TIFFWriteEncodedStrip.3tiff.html
Edit
TIFFWriteEncodedTile.3tiff.html
Edit
TIFFWriteRawStrip.3tiff.html
Edit
TIFFWriteRawTile.3tiff.html
Edit
TIFFWriteScanline.3tiff.html
Edit
TIFFWriteTile.3tiff.html
Edit
TIFFbuffer.3tiff.html
Edit
TIFFcodec.3tiff.html
Edit
TIFFcolor.3tiff.html
Edit
TIFFmemory.3tiff.html
Edit
TIFFquery.3tiff.html
Edit
TIFFsize.3tiff.html
Edit
TIFFstrip.3tiff.html
Edit
TIFFswab.3tiff.html
Edit
TIFFtile.3tiff.html
Edit
fax2ps.1.html
Edit
fax2tiff.1.html
Edit
index.html
Edit
libtiff.3tiff.html
Edit
pal2rgb.1.html
Edit
ppm2tiff.1.html
Edit
raw2tiff.1.html
Edit
tiff2bw.1.html
Edit
tiff2pdf.1.html
Edit
tiff2ps.1.html
Edit
tiff2rgba.1.html
Edit
tiffcmp.1.html
Edit
tiffcp.1.html
Edit
tiffcrop.1.html
Edit
tiffdither.1.html
Edit
tiffdump.1.html
Edit
tiffinfo.1.html
Edit
tiffmedian.1.html
Edit
tiffset.1.html
Edit
tiffsplit.1.html
Edit