TIFFReadRGBATile - read and decode an image tile into a fixed-format raster
Contents
Copyright
1988-2022, LibTIFF contributors
4.7 Apr 30, 2025 TIFFREADRGBATILE(3tiff)
Description
TIFFReadRGBATile() reads a single tile of a tile-based image into memory, storing the result in the user
supplied RGBA raster. The raster is assumed to be an array of TileWidth × TileLength 32-bit entries,
where TileWidth is the width of a tile (TIFFTAG_TILEWIDTH) and TileLength is the height of a tile
(TIFFTAG_TILELENGTH).
TIFFReadRGBATileExt() provides the parameter stop_on_error. Its behaviour is described at
TIFFReadRGBAImage.
The x and y values are the offsets from the top left corner to the top left corner of the tile to be
read. They must be an exact multiple of the tile width and length.
Note that the raster is assume to be organized such that the pixel at location (x, y) is raster [ y ×
width + x ]; with the raster origin in the lower-lefthandcorner of the tile. That is bottom to top
organization. Edge tiles which partly fall off the image will be filled out with appropriate zeroed
areas.
Raster pixels are 8-bit packed red, green, blue, alpha samples. The macros TIFFGetR, TIFFGetG, TIFFGetB,
and TIFFGetA should be used to access individual samples. Images without Associated Alpha matting
information have a constant Alpha of 1.0 (255).
See the TIFFRGBAImage page for more details on how various image types are converted to RGBA values.
Diagnostics
All error messages are directed to the TIFFErrorExtR() routine.
"Sorry,cannothandle%d-bitpictures":
The image had BitsPerSample other than 1, 2, 4, 8, or 16.
"Sorry,cannothandle%d-channelimages":
The image had SamplesPerPixel other than 1, 3, or 4.
Missingneeded"PhotometricInterpretation"tag:
The image did not have a tag that describes how to display the data.
No"PhotometricInterpretation"tag,assumingRGB:
The image was missing a tag that describes how to display it, but because it has 3 or 4 samples/pixel,
it is assumed to be RGB.
No"PhotometricInterpretation"tag,assumingmin-is-black:
The image was missing a tag that describes how to display it, but because it has 1 sample/pixel, it is
assumed to be a grayscale or bilevel image.
"Nospaceforphotometricconversiontable":
There was insufficient memory for a table used to convert image samples to 8-bit RGB.
Missingrequired"Colormap"tag:
A Palette image did not have a required Colormap tag.
"Nospacefortilebuffer":
There was insufficient memory to allocate an i/o buffer.
"Nospaceforstripbuffer":
There was insufficient memory to allocate an i/o buffer.
"Cannothandleformat":
The image has a format (combination of BitsPerSample, SamplesPerPixel, and PhotometricInterpretation)
that TIFFReadRGBAImage() can not handle.
"NospaceforB&Wmappingtable":
There was insufficient memory to allocate a table used to map grayscale data to RGB.
"NospaceforPalettemappingtable":
There was insufficient memory to allocate a table used to map data to 8-bit RGB.
Name
TIFFReadRGBATile - read and decode an image tile into a fixed-format raster
Notes
Samples must be either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel must be either 1, 3, or 4
(i.e. SamplesPerPixel - ExtraSamples).
Palette image colormaps that appear to be incorrectly written as 8-bit values are automatically scaled to
16-bits.
TIFFReadRGBATile() is just a wrapper around the more general TIFFRGBAImage facilities. It's main
advantage over the similar TIFFReadRGBAImage() function is that for large images a single buffer capable
of holding the whole image doesn't need to be allocated, only enough for one tile. The
TIFFReadRGBAStrip() function does a similar operation for stripped images.
Return Values
1 is returned if the image was successfully read and converted. Otherwise, 0 is returned if an error was
encountered.
See Also
TIFFOpen (3tiff), TIFFRGBAImage (3tiff), TIFFReadRGBAImage (3tiff), TIFFReadRGBAStrip (3tiff), libtiff
(3tiff)
Synopsis
#include <tiffio.h>
intTIFFReadRGBATile(TIFF*tif,uint32_tx,uint32_ty,uint32_t*raster)intTIFFReadRGBATileExt(TIFF*tif,uint32_tcol,uint32_trow,uint32_t*raster,intstop_on_error)