src/tiff/man/TIFFReadTile.3tiff

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