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