.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TIFFREADTILE" "3tiff" "Sep 08, 2023" "4.6" "LibTIFF"
.SH NAME
TIFFReadTile \- read and decode a tile of data from an open TIFF file
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#include <tiffio.h>
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tsize_t  TIFFReadTile(TIFF  *tif, tdata_t  buf, uint32_t  x, uint32_t  y, uint32_t  z, tsample_t  sample) 
.UNINDENT
.SH DESCRIPTION
.sp
Return the data for the tile \fIcontaining\fP the specified coordinates. The
data placed in \fIbuf\fP are returned decompressed and, typically, in the
native byte\- and bit\-ordering, but are otherwise packed (see further
below). The buffer must be large enough to hold an entire tile of data.
Applications should call the routine \fI\%TIFFTileSize()\fP to find out
the size (in bytes) of a tile buffer. The \fIx\fP and \fIy\fP parameters are
always used by \fI\%TIFFReadTile()\fP\&.  The \fIz\fP parameter is used if the
image is deeper than 1 slice (\fBImageDepth\fP > 1).  The \fIsample\fP
parameter is used only if data are organized in separate planes (
\fBPlanarConfiguration\fP = 2).
.SH NOTES
.sp
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 \fBFillOrder\fP 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.
.SH RETURN VALUES
.sp
\fI\%TIFFReadTile()\fP returns \-1 if it detects an error; otherwise the
number of bytes in the decoded tile is returned.
.SH DIAGNOSTICS
.sp
All error messages are directed to the \fI\%TIFFErrorExtR()\fP routine.
.SH SEE ALSO
.sp
\fI\%TIFFtile\fP (3tiff),
\fI\%TIFFOpen\fP (3tiff),
\fI\%TIFFReadEncodedTile\fP (3tiff),
\fI\%TIFFReadRawTile\fP (3tiff),
\fI\%libtiff\fP (3tiff)
.SH AUTHOR
LibTIFF contributors
.SH COPYRIGHT
1988-2022, LibTIFF contributors
.\" Generated by docutils manpage writer.
.