src/tiff/man/TIFFReadEncodedTile.3tiff

   1 .\" $Id: TIFFReadEncodedTile.3tiff,v 1.3 2006-10-13 07:22:01 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 TIFFReadEncodedTile 3TIFF "October 13, 2006" "libtiff"
  27 .SH NAME
  28 TIFFReadEncodedTile \- 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 "int TIFFReadEncodedTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Read the specified tile of data and place up to
  37 .I size
  38 bytes of decompressed information in the (user supplied) data buffer.
  39 .SH NOTES
  40 The value of
  41 .I tile
  42 is a ``raw tile number.''
  43 That is, the caller must take into account whether or not the data are
  44 organized in separate planes (\c
  45 .IR PlanarConfiguration =2).
  46 .IR TIFFComputeTile
  47 automatically does this when converting an (x,y,z,sample) coordinate quadruple
  48 to a tile number. To read a full tile of data the data buffer should be at
  49 least as large as the value returned by
  50 .IR TIFFTileSize .
  51 .PP
  52 The library attempts to hide bit- and byte-ordering differences between the
  53 image and the native machine by converting data to the native machine order.
  54 Bit reversal is done if the
  55 .I FillOrder
  56 tag is opposite to the native machine bit order. 16- and 32-bit samples are
  57 automatically byte-swapped if the file was written with a byte order opposite
  58 to the native machine byte order,
  59 .SH "RETURN VALUES"
  60 The actual number of bytes of data that were placed in
  61 .I buf
  62 is returned;
  63 .IR TIFFReadEncodedTile
  64 returns \-1 if an error was encountered.
  65 .SH DIAGNOSTICS
  66 All error messages are directed to the
  67 .BR TIFFError (3TIFF)
  68 routine.
  69 .SH "SEE ALSO"
  70 .BR TIFFOpen (3TIFF),
  71 .BR TIFFReadRawTile (3TIFF),
  72 .BR TIFFReadTile (3TIFF),
  73 .BR libtiff (3TIFF)
  74 .PP
  75 Libtiff library home page:
  76 .BR http://www.remotesensing.org/libtiff/