| | 1 | <!-- Creator : groff version 1.18.1 --> |
| | 2 | <!-- CreationDate: Mon Mar 13 18:03:09 2006 --> |
| | 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>TIFFReadEncodedTile</title> |
| | 8 | </head> |
| | 9 | <body> |
| | 10 | |
| | 11 | <h1 align=center>TIFFReadEncodedTile</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>TIFFReadEncodedTile − read and decode a tile of |
| | 30 | data from an 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>int TIFFReadEncodedTile(TIFF *</b><i>tif</i><b>, |
| | 44 | u_long</b> <i>tile</i><b>, u_char *</b><i>buf</i><b>, |
| | 45 | u_long</b> <i>size</i><b>)</b></p> |
| | 46 | </td> |
| | 47 | </table> |
| | 48 | <a name="DESCRIPTION"></a> |
| | 49 | <h2>DESCRIPTION</h2> |
| | 50 | <!-- INDENTATION --> |
| | 51 | <table width="100%" border=0 rules="none" frame="void" |
| | 52 | cols="2" cellspacing="0" cellpadding="0"> |
| | 53 | <tr valign="top" align="left"> |
| | 54 | <td width="8%"></td> |
| | 55 | <td width="91%"> |
| | 56 | <p>Read the specified tile of data and place up to |
| | 57 | <i>size</i> bytes of decompressed information in the (user |
| | 58 | supplied) data buffer.</p> |
| | 59 | </td> |
| | 60 | </table> |
| | 61 | <a name="NOTES"></a> |
| | 62 | <h2>NOTES</h2> |
| | 63 | <!-- INDENTATION --> |
| | 64 | <table width="100%" border=0 rules="none" frame="void" |
| | 65 | cols="2" cellspacing="0" cellpadding="0"> |
| | 66 | <tr valign="top" align="left"> |
| | 67 | <td width="8%"></td> |
| | 68 | <td width="91%"> |
| | 69 | <p>The value of <i>tile</i> is a ‘‘raw tile |
| | 70 | number.’’ That is, the caller must take into |
| | 71 | account whether or not the data are organized in separate |
| | 72 | planes (<i>PlanarConfiguration</i>=2). |
| | 73 | <i>TIFFComputeTile</i> automatically does this when |
| | 74 | converting an (x,y,z,sample) coordinate quadruple to a tile |
| | 75 | number. To read a full tile of data the data buffer should |
| | 76 | be at least as large as the value returned by |
| | 77 | <i>TIFFTileSize</i>.</p> |
| | 78 | <!-- INDENTATION --> |
| | 79 | <p>The library attempts to hide bit- and byte-ordering |
| | 80 | differences between the image and the native machine by |
| | 81 | converting data to the native machine order. Bit reversal is |
| | 82 | done if the <i>FillOrder</i> tag is opposite to the native |
| | 83 | machine bit order. 16- and 32-bit samples are automatically |
| | 84 | byte-swapped if the file was written with a byte order |
| | 85 | opposite to the native machine byte order,</p> |
| | 86 | </td> |
| | 87 | </table> |
| | 88 | <a name="RETURN VALUES"></a> |
| | 89 | <h2>RETURN VALUES</h2> |
| | 90 | <!-- INDENTATION --> |
| | 91 | <table width="100%" border=0 rules="none" frame="void" |
| | 92 | cols="2" cellspacing="0" cellpadding="0"> |
| | 93 | <tr valign="top" align="left"> |
| | 94 | <td width="8%"></td> |
| | 95 | <td width="91%"> |
| | 96 | <p>The actual number of bytes of data that were placed in |
| | 97 | <i>buf</i> is returned; <i>TIFFReadEncodedTile</i> returns |
| | 98 | −1 if an error was encountered.</p> |
| | 99 | </td> |
| | 100 | </table> |
| | 101 | <a name="DIAGNOSTICS"></a> |
| | 102 | <h2>DIAGNOSTICS</h2> |
| | 103 | <!-- INDENTATION --> |
| | 104 | <table width="100%" border=0 rules="none" frame="void" |
| | 105 | cols="2" cellspacing="0" cellpadding="0"> |
| | 106 | <tr valign="top" align="left"> |
| | 107 | <td width="8%"></td> |
| | 108 | <td width="91%"> |
| | 109 | <p>All error messages are directed to the |
| | 110 | <b>TIFFError</b>(3TIFF) routine.</p> |
| | 111 | </td> |
| | 112 | </table> |
| | 113 | <a name="SEE ALSO"></a> |
| | 114 | <h2>SEE ALSO</h2> |
| | 115 | <!-- INDENTATION --> |
| | 116 | <table width="100%" border=0 rules="none" frame="void" |
| | 117 | cols="2" cellspacing="0" cellpadding="0"> |
| | 118 | <tr valign="top" align="left"> |
| | 119 | <td width="8%"></td> |
| | 120 | <td width="91%"> |
| | 121 | <p><b>TIFFOpen</b>(3TIFF), <b>TIFFReadRawTile</b>(3TIFF), |
| | 122 | <b>TIFFReadTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> |
| | 123 | <!-- INDENTATION --> |
| | 124 | <p>Libtiff library home page: |
| | 125 | <b>http://www.remotesensing.org/libtiff/</b></p> |
| | 126 | </td> |
| | 127 | </table> |
| | 128 | <hr> |
| | 129 | </body> |
| | 130 | </html> |
projects / wxWidgets.git / blame_incremental