src/tiff/man/TIFFWriteRawTile.3tiff

   1 .\" $Id: TIFFWriteRawTile.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 TIFFWriteRawtile 3TIFF "December 16, 1991" "libtiff"
  27 .SH NAME
  28 TIFFWriteRawTile \- write a tile of raw data to an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFWriteRawTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Append
  37 .I size
  38 bytes of raw data to the specified tile.
  39 .SH "RETURN VALUES"
  40 \-1 is returned if an error occurred. Otherwise, the value of
  41 .IR size
  42 is returned.
  43 .SH DIAGNOSTICS
  44 All error messages are directed to the
  45 .BR TIFFError (3TIFF)
  46 routine.
  47 .PP
  48 \fB%s: File not open for writing\fP.
  49 The file was opened for reading, not writing.
  50 .PP
  51 \fBCan not write tiles to a stripped image\fP.
  52 The image is assumed to be organized in strips because neither of the
  53 .I TileWidth
  54 or
  55 .I TileLength
  56 tags have been set with
  57 .BR TIFFSetField (3TIFF).
  58 .PP
  59 \fB%s: Must set "ImageWidth" before writing data\fP.
  60 The image's width has not be set before the first write.
  61 See
  62 .BR TIFFSetField (3TIFF)
  63 for information on how to do this.
  64 .PP
  65 \fB%s: Must set "PlanarConfiguration" before writing data\fP. The organization
  66 of data has not be defined before the first write. See
  67 .BR TIFFSetField (3TIFF)
  68 for information on how to do this.
  69 .PP
  70 \fB%s: No space for tile arrays"\fP.
  71 There was not enough space for the arrays that hold tile offsets and byte
  72 counts.
  73 .PP
  74 \fB%s: Specified tile %d out of range, max %d\fP.
  75 The specified tile is not valid according to the currently specified image
  76 dimensions.
  77 .SH "SEE ALSO"
  78 .BR TIFFOpen (3TIFF),
  79 .BR TIFFWriteEncodedTile (3TIFF),
  80 .BR TIFFWriteScanline (3TIFF),
  81 .BR libtiff (3TIFF)
  82 .PP
  83 Libtiff library home page:
  84 .BR http://www.remotesensing.org/libtiff/