TIFFREADENCODEDTILE(3tiff) LibTIFF TIFFREADENCODEDTILE(3tiff)
TIFFReadEncodedTile - read and decode a tile of data from an open
TIFF file
#include <tiffio.h>
tmsize_t TIFFReadEncodedTile(TIFF *tif, uint32_t tile, void *buf,
tmsize_t size)
Read the specified tile of data and place up to size bytes of
decompressed information in the (user supplied) data buffer.
The value of tile is a "raw tile number". That is, the caller must
take into account whether or not the data are organized in separate
planes (PlanarConfiguration = 2). TIFFComputeTile() automatically
does this when converting an (x,y,z,sample) coordinate quadruple to a
tile number. To read a full tile of data the data buffer should be at
least as large as the value returned by TIFFTileSize().
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 done if the FillOrder tag is
opposite to the native machine bit order. 16- and 32-bit samples are
automatically byte-swapped if the file was written with a byte order
opposite to the native machine byte order.
The actual number of bytes of data that were placed in buf is
returned; TIFFReadEncodedTile() returns -1 if an error was
encountered.
All error messages are directed to the TIFFErrorExtR() routine.
TIFFOpen (3tiff), TIFFReadRawTile (3tiff), TIFFReadTile (3tiff),
TIFFReadEncodedStrip (3tiff), libtiff (3tiff)
LibTIFF contributors
1988-2025, LibTIFF contributors
4.7 March 7, 2026 TIFFREADENCODEDTILE(3tiff)
NAME
TIFFReadEncodedTile - read and decode a tile of data from an open
TIFF file
SYNOPSIS
#include <tiffio.h>
tmsize_t TIFFReadEncodedTile(TIFF *tif, uint32_t tile, void *buf,
tmsize_t size)
DESCRIPTION
Read the specified tile of data and place up to size bytes of
decompressed information in the (user supplied) data buffer.
NOTES
The value of tile is a "raw tile number". That is, the caller must
take into account whether or not the data are organized in separate
planes (PlanarConfiguration = 2). TIFFComputeTile() automatically
does this when converting an (x,y,z,sample) coordinate quadruple to a
tile number. To read a full tile of data the data buffer should be at
least as large as the value returned by TIFFTileSize().
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 done if the FillOrder tag is
opposite to the native machine bit order. 16- and 32-bit samples are
automatically byte-swapped if the file was written with a byte order
opposite to the native machine byte order.
RETURN VALUES
The actual number of bytes of data that were placed in buf is
returned; TIFFReadEncodedTile() returns -1 if an error was
encountered.
DIAGNOSTICS
All error messages are directed to the TIFFErrorExtR() routine.
SEE ALSO
TIFFOpen (3tiff), TIFFReadRawTile (3tiff), TIFFReadTile (3tiff),
TIFFReadEncodedStrip (3tiff), libtiff (3tiff)
AUTHOR
LibTIFF contributors
COPYRIGHT
1988-2025, LibTIFF contributors
4.7 March 7, 2026 TIFFREADENCODEDTILE(3tiff)