projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 80ed523f | 1 | .\" $Id: TIFFReadEncodedStrip.3tiff,v 1.2 2005-11-02 11:07:18 dron Exp $ |
| 8414a40c VZ |
2 | .\" |
| 3 | .\" Copyright (c) 1988-1997 Sam Leffler | |
| 4 | .\" Copyright (c) 1991-1997 Silicon Graphics, Inc. | |
| 5 | .\" | |
| 6 | .\" Permission to use, copy, modify, distribute, and sell this software and | |
| 7 | .\" its documentation for any purpose is hereby granted without fee, provided | |
| 8 | .\" that (i) the above copyright notices and this permission notice appear in | |
| 9 | .\" all copies of the software and related documentation, and (ii) the names of | |
| 10 | .\" Sam Leffler and Silicon Graphics may not be used in any advertising or | |
| 11 | .\" publicity relating to the software without the specific, prior written | |
| 12 | .\" permission of Sam Leffler and Silicon Graphics. | |
| 13 | .\" | |
| 14 | .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, | |
| 15 | .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY | |
| 16 | .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. | |
| 17 | .\" | |
| 18 | .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR | |
| 19 | .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, | |
| 20 | .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, | |
| 21 | .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF | |
| 22 | .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE | |
| 23 | .\" OF THIS SOFTWARE. | |
| 24 | .\" | |
| 25 | .if n .po 0 | |
| 26 | .TH TIFFReadEncodedStrip 3TIFF "October 15, 1995" "libtiff" | |
| 27 | .SH NAME | |
| 28 | TIFFReadEncodedStrip \- read and decode a strip of data from an open | |
| 29 | .SM TIFF | |
| 30 | file | |
| 31 | .SH SYNOPSIS | |
| 32 | .B "#include <tiffio.h>" | |
| 33 | .sp | |
| 34 | .BI "tsize_t TIFFReadEncodedStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")" | |
| 35 | .SH DESCRIPTION | |
| 36 | Read the specified strip of data and place up to | |
| 37 | .I size | |
| 38 | bytes of decompressed information in the (user supplied) data buffer. | |
| 39 | .SH NOTES | |
| 40 | The value of | |
| 41 | .I strip | |
| 42 | is a ``raw strip number.'' | |
| 43 | That is, the caller must take into account whether or not the data are | |
| 44 | organized in separate planes (\c | |
| 45 | .IR PlanarConfiguration =2). | |
| 46 | To read a full strip of data the data buffer should typically be at least as | |
| 47 | large as the number returned by | |
| 48 | .BR TIFFStripSize (3TIFF). | |
| 49 | If the -1 passed in | |
| 50 | .I size | |
| 51 | parameter, the whole strip will be read. You should be sure you have enough | |
| 52 | space allocated for the buffer. | |
| 53 | .PP | |
| 54 | The library attempts to hide bit- and byte-ordering differences between the | |
| 55 | image and the native machine by converting data to the native machine order. | |
| 56 | Bit reversal is done if the | |
| 57 | .I FillOrder | |
| 58 | tag is opposite to the native machine bit order. 16- and 32-bit samples are | |
| 59 | automatically byte-swapped if the file was written with a byte order opposite | |
| 60 | to the native machine byte order, | |
| 61 | .SH "RETURN VALUES" | |
| 62 | The actual number of bytes of data that were placed in | |
| 63 | .I buf | |
| 64 | is returned; | |
| 65 | .IR TIFFReadEncodedStrip | |
| 66 | returns \-1 if an error was encountered. | |
| 67 | .SH DIAGNOSTICS | |
| 68 | All error messages are directed to the | |
| 69 | .BR TIFFError (3TIFF) | |
| 70 | routine. | |
| 71 | .SH "SEE ALSO" | |
| 72 | .BR TIFFOpen (3TIFF), | |
| 73 | .BR TIFFReadRawStrip (3TIFF), | |
| 74 | .BR TIFFReadScanline (3TIFF), | |
| 75 | .BR libtiff (3TIFF) | |
| 76 | .PP | |
| 77 | Libtiff library home page: | |
| 78 | .BR http://www.remotesensing.org/libtiff/ |