I386LINUX/util/I386LINUX/man/man3/TIFFbuffer.3t

   1 .\" $Header: /CVS_DB/Eos/util/I386LINUX/man/man3/TIFFbuffer.3t,v 1.1.1.1 2002/02/01 06:40:34 tacyas Exp $
   2 .\"
   3 .\" Copyright (c) 1995 Sam Leffler
   4 .\" Copyright (c) 1995 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 TIFFBUFFER 3T "October 15, 1995"
  27 .SH NAME
  28 TIFFReadBufferSetup,
  29 TIFFWriteBufferSetup
  30 \- I/O buffering control routines
  31 .SH SYNOPSIS
  32 .nf
  33 .B "#include <tiffio.h>"
  34 .B "int TIFFReadBufferSetup(TIFF*, tdata_t buffer, tsize_t size);"
  35 .B "int TIFFWriteBufferSetup(TIFF*, tdata_t buffer, tsize_t size);"
  36 .fi
  37 .SH DESCRIPTION
  38 The following routines are provided for client-control of the
  39 I/O buffers used by the library.
  40 Applications need never use these routines; they are provided only
  41 for ``intelligent clients'' that wish to optimize memory usage and/or
  42 eliminate potential copy operations that can occur when working with
  43 images that have data stored without compression.
  44 .PP
  45 .I TIFFReadBufferSetup
  46 sets up the data buffer used to read raw (encoded) data from a file.
  47 If the specified pointer is
  48 .SM NULL
  49 (zero), then a buffer of the appropriate size is allocated.
  50 Otherwise the caller must guarantee that the buffer is large
  51 enough to hold any individual strip of raw data.
  52 .I TIFFReadBufferSetup
  53 returns a non-zero value if the setup was successful and zero otherwise.
  54 .PP
  55 .I TIFFWriteBufferSetup
  56 sets up the data buffer used to write raw (encoded) data to a file.
  57 If the specified
  58 .I size
  59 is \-1 then the buffer size is selected to hold a complete
  60 tile or strip, or at least 8 kilobytes, whichever is greater.
  61 If the specified
  62 .I buffer
  63 is
  64 .SM NULL
  65 (zero), then a buffer of the appropriate size is dynamically allocated.
  66 .I TIFFWriteBufferSetup
  67 returns a non-zero value if the setup was successful and zero otherwise.
  68 .SH DIAGNOSTICS
  69 .BR "%s: No space for data buffer at scanline %ld" .
  70 .I TIFFReadBufferSetup
  71 was unable to dynamically allocate space for a data buffer.
  72 .PP
  73 .BR "%s: No space for output buffer" .
  74 .I TIFFWriteBufferSetup
  75 was unable to dynamically allocate space for a data buffer.
  76 .SH "SEE ALSO"
  77 .IR libtiff (3T)