src/tiff/man/TIFFbuffer.3tiff

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