src/tiff/man/TIFFReadRawTile.3tiff

   1 .\" $Id: TIFFReadRawTile.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 TIFFReadRawTile 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFReadRawTile \- return an undecoded 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 TIFFReadRawTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Read the contents of the specified tile into the (user supplied) data buffer.
  37 Note that the value of
  38 .I tile
  39 is a ``raw tile number.'' That is, the caller must take into account whether
  40 or not the data is organized in separate planes (\c
  41 .IR PlanarConfiguration =2).
  42 .I TIFFComputeTile
  43 automatically does this when converting an (x,y,z,sample) coordinate quadruple
  44 to a tile number. To read a full tile of data the data buffer should typically
  45 be at least as large as the value returned by
  46 .IR TIFFTileSize .
  47 .SH "RETURN VALUES"
  48 The actual number of bytes of data that were placed in
  49 .I buf
  50 is returned;
  51 .IR TIFFReadEncodedTile
  52 returns \-1 if an error was encountered.
  53 .SH DIAGNOSTICS
  54 All error messages are directed to the
  55 .BR TIFFError (3TIFF)
  56 routine.
  57 .SH "SEE ALSO"
  58 .BR TIFFOpen (3TIFF),
  59 .BR TIFFReadEncodedTile (3TIFF),
  60 .BR TIFFReadTile (3TIFF),
  61 .BR TIFFTileSize (3TIFF),
  62 .BR libtiff (3TIFF)
  63 .PP
  64 Libtiff library home page:
  65 .BR http://www.remotesensing.org/libtiff/