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