1<!-- Creator : groff version 1.18.1 --> 2<!-- CreationDate: Sat Feb 24 18:37:17 2007 --> 3<html> 4<head> 5<meta name="generator" content="groff -Thtml, see www.gnu.org"> 6<meta name="Content-Style" content="text/css"> 7<title>TIFFReadTile</title> 8</head> 9<body> 10 11<h1 align=center>TIFFReadTile</h1> 12<a href="#NAME">NAME</a><br> 13<a href="#SYNOPSIS">SYNOPSIS</a><br> 14<a href="#DESCRIPTION">DESCRIPTION</a><br> 15<a href="#NOTES">NOTES</a><br> 16<a href="#RETURN VALUES">RETURN VALUES</a><br> 17<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> 18<a href="#SEE ALSO">SEE ALSO</a><br> 19 20<hr> 21<a name="NAME"></a> 22<h2>NAME</h2> 23<!-- INDENTATION --> 24<table width="100%" border=0 rules="none" frame="void" 25 cols="2" cellspacing="0" cellpadding="0"> 26<tr valign="top" align="left"> 27<td width="8%"></td> 28<td width="91%"> 29<p>TIFFReadTile − read and decode a tile of data from 30an open <small>TIFF</small> file</p> 31</td> 32</table> 33<a name="SYNOPSIS"></a> 34<h2>SYNOPSIS</h2> 35<!-- INDENTATION --> 36<table width="100%" border=0 rules="none" frame="void" 37 cols="2" cellspacing="0" cellpadding="0"> 38<tr valign="top" align="left"> 39<td width="8%"></td> 40<td width="91%"> 41<p><b>#include <tiffio.h></b></p> 42<!-- INDENTATION --> 43<p><b>tsize_t TIFFReadTile(TIFF *</b><i>tif</i><b>, 44tdata_t</b> <i>buf</i><b>, uint32</b> <i>x</i><b>, 45uint32</b> <i>y</i><b>, uint32</b> <i>z</i><b>, 46tsample_t</b> <i>sample</i><b>)</b></p> 47</td> 48</table> 49<a name="DESCRIPTION"></a> 50<h2>DESCRIPTION</h2> 51<!-- INDENTATION --> 52<table width="100%" border=0 rules="none" frame="void" 53 cols="2" cellspacing="0" cellpadding="0"> 54<tr valign="top" align="left"> 55<td width="8%"></td> 56<td width="91%"> 57<p>Return the data for the tile <i>containing</i> the 58specified coordinates. The data placed in <i>buf</i> are 59returned decompressed and, typically, in the native byte- 60and bit-ordering, but are otherwise packed (see further 61below). The buffer must be large enough to hold an entire 62tile of data. Applications should call the routine 63<i>TIFFTileSize</i> to find out the size (in bytes) of a 64tile buffer. The <i>x</i> and <i>y</i> parameters are always 65used by <i>TIFFReadTile</i>. The <i>z</i> parameter is used 66if the image is deeper than 1 slice 67(<i>ImageDepth</i>>1). The <i>sample</i> parameter is 68used only if data are organized in separate planes 69(<i>PlanarConfiguration</i>=2).</p> 70</td> 71</table> 72<a name="NOTES"></a> 73<h2>NOTES</h2> 74<!-- INDENTATION --> 75<table width="100%" border=0 rules="none" frame="void" 76 cols="2" cellspacing="0" cellpadding="0"> 77<tr valign="top" align="left"> 78<td width="8%"></td> 79<td width="91%"> 80<p>The library attempts to hide bit- and byte-ordering 81differences between the image and the native machine by 82converting data to the native machine order. Bit reversal is 83done if the <i>FillOrder</i> tag is opposite to the native 84machine bit order. 16- and 32-bit samples are automatically 85byte-swapped if the file was written with a byte order 86opposite to the native machine byte order,</p> 87</td> 88</table> 89<a name="RETURN VALUES"></a> 90<h2>RETURN VALUES</h2> 91<!-- INDENTATION --> 92<table width="100%" border=0 rules="none" frame="void" 93 cols="2" cellspacing="0" cellpadding="0"> 94<tr valign="top" align="left"> 95<td width="8%"></td> 96<td width="91%"> 97<p><i>TIFFReadTile</i> returns −1 if it detects an 98error; otherwise the number of bytes in the decoded tile is 99returned.</p> 100</td> 101</table> 102<a name="DIAGNOSTICS"></a> 103<h2>DIAGNOSTICS</h2> 104<!-- INDENTATION --> 105<table width="100%" border=0 rules="none" frame="void" 106 cols="2" cellspacing="0" cellpadding="0"> 107<tr valign="top" align="left"> 108<td width="8%"></td> 109<td width="91%"> 110<p>All error messages are directed to the 111<b>TIFFError</b>(3TIFF) routine.</p> 112</td> 113</table> 114<a name="SEE ALSO"></a> 115<h2>SEE ALSO</h2> 116<!-- INDENTATION --> 117<table width="100%" border=0 rules="none" frame="void" 118 cols="2" cellspacing="0" cellpadding="0"> 119<tr valign="top" align="left"> 120<td width="8%"></td> 121<td width="91%"> 122<p><b>TIFFCheckTile</b>(3TIFF), 123<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF), 124<b>TIFFReadEncodedTile</b>(3TIFF), 125<b>TIFFReadRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> 126<!-- INDENTATION --> 127<p>Libtiff library home page: 128<b>http://www.simplesystems.org/libtiff/</b></p> 129</td> 130</table> 131<hr> 132</body> 133</html> 134