| | 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>TIFFReadEncodedStrip</title> |
| | 8 | </head> |
| | 9 | <body> |
| | 10 | |
| | 11 | <h1 align=center>TIFFReadEncodedStrip</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><big>TIFFReadEncodedStrip − read and decode a strip |
| | 30 | of data from an open</big> TIFF <big>file</big></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><big><b>#include <tiffio.h></b></big></p> |
| | 42 | <!-- INDENTATION --> |
| | 43 | <p><big><b>tsize_t TIFFReadEncodedStrip(TIFF |
| | 44 | *</b><i>tif</i><b>, tstrip_t</b> <i>strip</i><b>, |
| | 45 | tdata_t</b> <i>buf</i><b>, tsize_t</b> |
| | 46 | <i>size</i><b>)</b></big></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><big>Read the specified strip of data and place up to |
| | 58 | <i>size</i> bytes of decompressed information in the (user |
| | 59 | supplied) data buffer.</big></p> |
| | 60 | </td> |
| | 61 | </table> |
| | 62 | <a name="NOTES"></a> |
| | 63 | <h2>NOTES</h2> |
| | 64 | <!-- INDENTATION --> |
| | 65 | <table width="100%" border=0 rules="none" frame="void" |
| | 66 | cols="2" cellspacing="0" cellpadding="0"> |
| | 67 | <tr valign="top" align="left"> |
| | 68 | <td width="8%"></td> |
| | 69 | <td width="91%"> |
| | 70 | <p><big>The value of <i>strip</i> is a ‘‘raw |
| | 71 | strip number.’’ That is, the caller must take |
| | 72 | into account whether or not the data are organized in |
| | 73 | separate planes (<i>PlanarConfiguration</i>=2). To read a |
| | 74 | full strip of data the data buffer should typically be at |
| | 75 | least as large as the number returned by |
| | 76 | <b>TIFFStripSize</b>(3TIFF). If the -1 passed in <i>size</i> |
| | 77 | parameter, the whole strip will be read. You should be sure |
| | 78 | you have enough space allocated for the buffer.</big></p> |
| | 79 | <!-- INDENTATION --> |
| | 80 | <p><big>The library attempts to hide bit- and byte-ordering |
| | 81 | differences between the image and the native machine by |
| | 82 | converting data to the native machine order. Bit reversal is |
| | 83 | done if the <i>FillOrder</i> tag is opposite to the native |
| | 84 | machine bit order. 16- and 32-bit samples are automatically |
| | 85 | byte-swapped if the file was written with a byte order |
| | 86 | opposite to the native machine byte order,</big></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><big>The actual number of bytes of data that were placed |
| | 98 | in <i>buf</i> is returned; <i>TIFFReadEncodedStrip</i> |
| | 99 | returns −1 if an error was encountered.</big></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><big>All error messages are directed to the |
| | 111 | <b>TIFFError</b>(3TIFF) routine.</big></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><big><b>TIFFOpen</b>(3TIFF), |
| | 123 | <b>TIFFReadRawStrip</b>(3TIFF), |
| | 124 | <b>TIFFReadScanline</b>(3TIFF), |
| | 125 | <b>libtiff</b>(3TIFF)</big></p> |
| | 126 | <!-- INDENTATION --> |
| | 127 | <p><big>Libtiff library home page: |
| | 128 | <b>http://www.remotesensing.org/libtiff/</b></big></p> |
| | 129 | </td> |
| | 130 | </table> |
| | 131 | <hr> |
| | 132 | </body> |
| | 133 | </html> |
projects / wxWidgets.git / blame_incremental