TIFFReadTile(3tiff) Introduction to Library Functions TIFFReadTile(3tiff)
NAME
TIFFReadTile - read and decode a tile of data from an open TIFF file
SYNOPSIS
#include <tiffio.h>
tsize_t TIFFReadTile(TIFF* tif, tdata_t buf, uint32 x,
uint32 y, uint32 z, tsample_t sample)
DESCRIPTION
Return the data for the tile containing the specified coordinates. The data is returned decompressed and in the native byte- and bit-order-
ing, but is otherwise packed as described below. The buffer must be large enough to hold an entire tile of data. Applications should call
the routine TIFFTileSize to find out the size in bytes of a tile buffer. The x and y parameters are always used by TIFFReadTile. The z
parameter is used if the image is deeper than 1 slice (ImageDepth>1). The sample parameter is used only if data is organized in separate
planes (PlanarConfiguration=2).
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 performed if the FillOrder tag is opposite to the native machine bit order. 16- and 32-bit samples are auto-
matically byte-swapped if the file was written with a byte order opposite to the native machine byte order.
All error messages are directed to the TIFFError(3tiff) routine.
RETURN VALUES
Returns -1 if an error was encountered. Otherwise, returns the number of bytes in the decoded tile.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Availability |SUNWTiff |
+-----------------------------+-----------------------------+
|Interface stability |External |
+-----------------------------+-----------------------------+
SEE ALSO
libtiff(3), TIFFCheckTile(3tiff), TIFFComputeTile(3tiff), TIFFOpen(3tiff), TIFFReadEncodedTile(3tiff), TIFFReadRawTile(3tiff)
NOTES
This man page was originally written by Sam Leffler. Updated by Breda McColgan, Sun Microsystems Inc., 2004.
SunOS 5.10 05 Apr 2004 TIFFReadTile(3tiff)