libtiff/html/man/TIFFbuffer.3t.html~
1999-11-23 04:29:23 +00:00

102 lines
2.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML><HEAD><TITLE>Manpage of TIFFBUFFER</TITLE>
</HEAD><BODY BGCOLOR=WHITE><FONT FACE="helvetica, sans, arial">
<H1>TIFFBUFFER</H1>
Section: Misc. Reference Manual Pages (3T)<BR>Updated: October 15, 1995<BR><A HREF="#index">Index</A>
<BR><A HREF="index.html">Return to Main Contents</A>
<HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
TIFFReadBufferSetup,
TIFFWriteBufferSetup
- I/O buffering control routines
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:/usr/include/tiffio.h">tiffio.h</A>&gt;</B>
<B>int TIFFReadBufferSetup(TIFF*, tdata_t buffer, tsize_t size);</B>
<B>int TIFFWriteBufferSetup(TIFF*, tdata_t buffer, tsize_t size);</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The following routines are provided for client-control of the
I/O buffers used by the library.
Applications need never use these routines; they are provided only
for ``intelligent clients'' that wish to optimize memory usage and/or
eliminate potential copy operations that can occur when working with
images that have data stored without compression.
<P>
<I>TIFFReadBufferSetup</I>
sets up the data buffer used to read raw (encoded) data from a file.
If the specified pointer is
<FONT SIZE="-1">NULL</FONT>
(zero), then a buffer of the appropriate size is allocated.
Otherwise the caller must guarantee that the buffer is large
enough to hold any individual strip of raw data.
<I>TIFFReadBufferSetup</I>
returns a non-zero value if the setup was successful and zero otherwise.
<P>
<I>TIFFWriteBufferSetup</I>
sets up the data buffer used to write raw (encoded) data to a file.
If the specified
<I>size</I>
is -1 then the buffer size is selected to hold a complete
tile or strip, or at least 8 kilobytes, whichever is greater.
If the specified
<I>buffer</I>
is
<FONT SIZE="-1">NULL</FONT>
(zero), then a buffer of the appropriate size is dynamically allocated.
<I>TIFFWriteBufferSetup</I>
returns a non-zero value if the setup was successful and zero otherwise.
<A NAME="lbAE">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
<B>%s: No space for data buffer at scanline %ld</B>.
<I>TIFFReadBufferSetup</I>
was unable to dynamically allocate space for a data buffer.
<P>
<B>%s: No space for output buffer</B>.
<I>TIFFWriteBufferSetup</I>
was unable to dynamically allocate space for a data buffer.
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="http:/cgi-bin/man2html?libtiff+3t">libtiff</A></I>(3T)
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAF">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="index.html">man2html</A>,
using the manual pages.<BR>
Time: 01:31:39 GMT, November 23, 1999
</BODY>
</HTML>