src/tiff/man/TIFFReadTile.3tiff

   1 .\"
   2 .\" Copyright (c) 1988-1997 Sam Leffler
   3 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH TIFFReadTile 3TIFF "December 16, 1991" "libtiff"
  26 .SH NAME
  27 TIFFReadTile \- read and decode a tile of data from an open
  28 .SM TIFF
  29 file
  30 .SH SYNOPSIS
  31 .B "#include <tiffio.h>"
  32 .sp
  33 .BI "tsize_t TIFFReadTile(TIFF *" tif ", tdata_t " buf ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
  34 .SH DESCRIPTION
  35 Return the data for the tile
  36 .I containing
  37 the specified coordinates. The data placed in
  38 .I buf
  39 are returned decompressed and, typically, in the native byte- and
  40 bit-ordering, but are otherwise packed (see further below). The buffer must be
  41 large enough to hold an entire tile of data. Applications should call the
  42 routine
  43 .IR TIFFTileSize
  44 to find out the size (in bytes) of a tile buffer. The
  45 .I x
  46 and
  47 .I y
  48 parameters are always used by
  49 .IR TIFFReadTile .
  50 The
  51 .I z
  52 parameter is used if the image is deeper than 1 slice (\c
  53 .IR ImageDepth >1).
  54 The
  55 .I sample
  56 parameter is used only if data are organized in separate planes (\c
  57 .IR PlanarConfiguration =2).
  58 .SH NOTES
  59 The library attempts to hide bit- and byte-ordering differences between the
  60 image and the native machine by converting data to the native machine order.
  61 Bit reversal is done if the
  62 .I FillOrder
  63 tag is opposite to the native machine bit order. 16- and 32-bit samples are
  64 automatically byte-swapped if the file was written with a byte order opposite
  65 to the native machine byte order,
  66 .SH "RETURN VALUES"
  67 .IR TIFFReadTile
  68 returns \-1 if it detects an error; otherwise the number of bytes in the
  69 decoded tile is returned.
  70 .SH DIAGNOSTICS
  71 All error messages are directed to the
  72 .BR TIFFError (3TIFF)
  73 routine.
  74 .SH "SEE ALSO"
  75 .BR TIFFCheckTile (3TIFF),
  76 .BR TIFFComputeTile (3TIFF),
  77 .BR TIFFOpen (3TIFF),
  78 .BR TIFFReadEncodedTile (3TIFF),
  79 .BR TIFFReadRawTile (3TIFF),
  80 .BR libtiff (3TIFF)
  81 .PP
  82 Libtiff library home page:
  83 .BR http://www.remotesensing.org/libtiff/