src/SDL2/external/tiff-4.0.3/man/TIFFWriteEncodedStrip.3tiff

   1 .\" $Id: TIFFWriteEncodedStrip.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 TIFFWriteEncodedStrip 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFWritedEncodedStrip \- compress and write a strip of data to an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFWriteEncodedStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Compress
  37 .I size
  38 bytes of raw data from
  39 .I buf
  40 and write the result to the specified strip; replacing any previously written
  41 data. Note that the value of
  42 .I strip
  43 is a ``raw strip number.'' That is, the caller must take into account whether
  44 or not the data are organized in separate planes (\c
  45 .IR PlanarConfiguration =2).
  46 .SH NOTES
  47 The library writes encoded data using the native machine byte order. Correctly
  48 implemented
  49 .SM TIFF
  50 readers are expected to do any necessary byte-swapping to correctly process
  51 image data with BitsPerSample greater than 8.
  52 .PP
  53 The strip number must be valid according to the current settings of the
  54 .I ImageLength
  55 and
  56 .I RowsPerStrip
  57 tags.
  58 An image may be dynamically grown by increasing the value of
  59 .I ImageLength
  60 prior to each call to
  61 .IR TIFFWriteEncodedStrip .
  62 .SH "RETURN VALUES"
  63 \-1 is returned if an error was encountered. Otherwise, the value of
  64 .IR size
  65 is returned.
  66 .SH DIAGNOSTICS
  67 All error messages are directed to the
  68 .IR TIFFError (3TIFF)
  69 routine.
  70 .PP
  71 \fB%s: File not open for writing\fP. The file was opened for reading, not
  72 writing.
  73 .PP
  74 \fBCan not write scanlines to a tiled image\fP. The image is assumed to be
  75 organized in tiles because the
  76 .I TileWidth
  77 and
  78 .I TileLength
  79 tags have been set with
  80 .IR TIFFSetField (3TIFF).
  81 .PP
  82 \fB%s: Must set "ImageWidth" before writing data\fP.
  83 The image's width has not be set before the first write. See
  84 .IR TIFFSetField (3TIFF)
  85 for information on how to do this.
  86 .PP
  87 \fB%s: Must set "PlanarConfiguration" before writing data\fP.
  88 The organization of data has not be defined before the first write. See
  89 .IR TIFFSetField (3TIFF)
  90 for information on how to do this.
  91 .PP
  92 \fB%s: No space for strip arrays"\fP.
  93 There was not enough space for the arrays that hold strip offsets and byte
  94 counts.
  95 .SH "SEE ALSO"
  96 .BR TIFFOpen (3TIFF),
  97 .BR TIFFWriteScanline (3TIFF),
  98 .BR TIFFWriteRawStrip (3TIFF),
  99 .BR libtiff (3TIFF)
 100 .PP
 101 Libtiff library home page:
 102 .BR http://www.remotesensing.org/libtiff/