src/tiff/man/TIFFbuffer.3tiff

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