src/tiff/man/TIFFWriteTile.3tiff

   1 .\" $Id: TIFFWriteTile.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 TIFFWriteTile 3TIFF "November 29, 1999" "libtiff"
  27 .SH NAME
  28 TIFFWriteTile \- encode and write a tile of data to an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFWriteTile(TIFF *" tif ", tdata_t " buf ", uint32 " x ", uint32 " y ", uint32 " z ", tsample_t " sample ")"
  35 .SH DESCRIPTION
  36 Write the data for the tile
  37 .I containing
  38 the specified coordinates. The data in
  39 .I buf
  40 are is (potentially) compressed, and written to the indicated file, normally
  41 being appended to the end of the file. The buffer must be contain an entire
  42 tile of data. Applications should call the routine
  43 .IR TIFFTileSize
  44 to find out the size (in bytes) of a tile buffer. The
  45 .I x
  46 and
  47 .I y
  48 parameters are always used by
  49 .IR TIFFWriteTile .
  50 The
  51 .I z
  52 parameter is used if the image is deeper than 1 slice (\c
  53 .IR ImageDepth >1).
  54 The
  55 .I sample
  56 parameter is used only if data are organized in separate planes (\c
  57 .IR PlanarConfiguration =2).
  58 .SH "RETURN VALUES"
  59 .IR TIFFWriteTile
  60 returns \-1 if it detects an error; otherwise the number of bytes in the tile
  61 is returned.
  62 .SH DIAGNOSTICS
  63 All error messages are directed to the
  64 .BR TIFFError (3TIFF)
  65 routine.
  66 .SH "SEE ALSO"
  67 .BR TIFFCheckTile (3TIFF),
  68 .BR TIFFComputeTile (3TIFF),
  69 .BR TIFFOpen (3TIFF),
  70 .BR TIFFReadTile (3TIFF),
  71 .BR TIFFWriteScanline (3TIFF),
  72 .BR TIFFWriteEncodedTile (3TIFF),
  73 .BR TIFFWriteRawTile (3TIFF),
  74 .BR libtiff (3TIFF)
  75 .PP
  76 Libtiff library home page:
  77 .BR http://www.remotesensing.org/libtiff/