src/tiff/man/TIFFWriteRawStrip.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 TIFFWriteRawstrip 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 TIFFWriteRawStrip \- write a strip of raw data to an open
  28 .SM TIFF
  29 file
  30 .SH SYNOPSIS
  31 .B "#include <tiffio.h>"
  32 .sp
  33 .BI "tsize_t TIFFWriteRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  34 .SH DESCRIPTION
  35 Append
  36 .I size
  37 bytes of raw data to the specified strip.
  38 .SH NOTES
  39 The strip number must be valid according to the current settings of the
  40 .I ImageLength
  41 and
  42 .I RowsPerStrip
  43 tags.
  44 An image may be dynamically grown by increasing the value of
  45 .I ImageLength
  46 prior to each call to
  47 .IR TIFFWriteRawStrip .
  48 .SH "RETURN VALUES"
  49 \-1 is returned if an error occurred.
  50 Otherwise, the value of
  51 .IR size
  52 is returned.
  53 .SH DIAGNOSTICS
  54 All error messages are directed to the
  55 .BR TIFFError (3TIFF)
  56 routine.
  57 .PP
  58 \fB%s: File not open for writing\fP.
  59 The file was opened for reading, not writing.
  60 .PP
  61 \fBCan not write scanlines to a tiled image\fP. The image is assumed to be
  62 organized in tiles because the
  63 .I TileWidth
  64 and
  65 .I TileLength
  66 tags have been set with
  67 .BR TIFFSetField (3TIFF).
  68 .PP
  69 \fB%s: Must set "ImageWidth" before writing data\fP.
  70 The image's width has not be set before the first write.
  71 See
  72 .BR TIFFSetField (3TIFF)
  73 for information on how to do this.
  74 .PP
  75 \fB%s: Must set "PlanarConfiguration" before writing data\fP.
  76 The organization of data has not be defined before the first write.
  77 See
  78 .BR TIFFSetField (3TIFF)
  79 for information on how to do this.
  80 .PP
  81 \fB%s: No space for strip arrays"\fP.
  82 There was not enough space for the arrays that hold strip
  83 offsets and byte counts.
  84 .PP
  85 \fB%s: Strip %d out of range, max %d\fP.
  86 The specified strip is not a valid strip according to the
  87 currently specified image dimensions.
  88 .SH "SEE ALSO"
  89 .BR TIFFOpen (3TIFF),
  90 .BR TIFFWriteEncodedStrip (3TIFF),
  91 .BR TIFFWriteScanline (3TIFF),
  92 .BR libtiff (3TIFF)
  93 .PP
  94 Libtiff library home page:
  95 .BR http://www.remotesensing.org/libtiff/