Disable symbols visibility support for the Clang compiler.
[wxWidgets.git] / src / tiff / html / man / TIFFbuffer.3tiff.html
1 <!-- Creator : groff version 1.18.1 -->
2 <!-- CreationDate: Mon Mar 13 18:03:08 2006 -->
3 <html>
4 <head>
5 <meta name="generator" content="groff -Thtml, see www.gnu.org">
6 <meta name="Content-Style" content="text/css">
7 <title>TIFFBUFFER</title>
8 </head>
9 <body>
10
11 <h1 align=center>TIFFBUFFER</h1>
12 <a href="#NAME">NAME</a><br>
13 <a href="#SYNOPSIS">SYNOPSIS</a><br>
14 <a href="#DESCRIPTION">DESCRIPTION</a><br>
15 <a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
16 <a href="#SEE ALSO">SEE ALSO</a><br>
17
18 <hr>
19 <a name="NAME"></a>
20 <h2>NAME</h2>
21 <!-- INDENTATION -->
22 <table width="100%" border=0 rules="none" frame="void"
23 cols="2" cellspacing="0" cellpadding="0">
24 <tr valign="top" align="left">
25 <td width="8%"></td>
26 <td width="91%">
27 <p>TIFFReadBufferSetup, TIFFWriteBufferSetup &minus; I/O
28 buffering control routines</p>
29 </td>
30 </table>
31 <a name="SYNOPSIS"></a>
32 <h2>SYNOPSIS</h2>
33 <!-- INDENTATION -->
34 <table width="100%" border=0 rules="none" frame="void"
35 cols="2" cellspacing="0" cellpadding="0">
36 <tr valign="top" align="left">
37 <td width="8%"></td>
38 <td width="91%">
39 <pre><b>#include &lt;tiffio.h&gt;
40
41 int TIFFReadBufferSetup(TIFF *</b><i>tif</i><b>, tdata_t</b> <i>buffer</i><b>, tsize_t</b> <i>size</i><b>);
42 int TIFFWriteBufferSetup(TIFF *</b><i>tif</i><b>, tdata_t</b> <i>buffer</i><b>, tsize_t</b> <i>size</i><b>);
43 </b></pre>
44 </td>
45 </table>
46 <a name="DESCRIPTION"></a>
47 <h2>DESCRIPTION</h2>
48 <!-- INDENTATION -->
49
50 <table width="100%" border=0 rules="none" frame="void"
51 cols="2" cellspacing="0" cellpadding="0">
52 <tr valign="top" align="left">
53 <td width="8%"></td>
54 <td width="91%">
55 <p>The following routines are provided for client-control of
56 the I/O buffers used by the library. Applications need never
57 use these routines; they are provided only for
58 &lsquo;&lsquo;intelligent clients&rsquo;&rsquo; that wish to
59 optimize memory usage and/or eliminate potential copy
60 operations that can occur when working with images that have
61 data stored without compression.</p>
62 <!-- INDENTATION -->
63 <p><i>TIFFReadBufferSetup</i> sets up the data buffer used
64 to read raw (encoded) data from a file. If the specified
65 pointer is <small>NULL</small> (zero), then a buffer of the
66 appropriate size is allocated. Otherwise the caller must
67 guarantee that the buffer is large enough to hold any
68 individual strip of raw data. <i>TIFFReadBufferSetup</i>
69 returns a non-zero value if the setup was successful and
70 zero otherwise.</p>
71 <!-- INDENTATION -->
72 <p><i>TIFFWriteBufferSetup</i> sets up the data buffer used
73 to write raw (encoded) data to a file. If the specified
74 <i>size</i> is &minus;1 then the buffer size is selected to
75 hold a complete tile or strip, or at least 8 kilobytes,
76 whichever is greater. If the specified <i>buffer</i> is
77 <small>NULL</small> (zero), then a buffer of the appropriate
78 size is dynamically allocated. <i>TIFFWriteBufferSetup</i>
79 returns a non-zero value if the setup was successful and
80 zero otherwise.</p>
81 </td>
82 </table>
83 <a name="DIAGNOSTICS"></a>
84 <h2>DIAGNOSTICS</h2>
85 <!-- INDENTATION -->
86 <table width="100%" border=0 rules="none" frame="void"
87 cols="2" cellspacing="0" cellpadding="0">
88 <tr valign="top" align="left">
89 <td width="8%"></td>
90 <td width="91%">
91 <p><b>%s: No space for data buffer at scanline %ld</b>.
92 <i>TIFFReadBufferSetup</i> was unable to dynamically
93 allocate space for a data buffer.</p>
94 <!-- INDENTATION -->
95 <p><b>%s: No space for output buffer</b>.
96 <i>TIFFWriteBufferSetup</i> was unable to dynamically
97 allocate space for a data buffer.</p>
98 </td>
99 </table>
100 <a name="SEE ALSO"></a>
101 <h2>SEE ALSO</h2>
102 <!-- INDENTATION -->
103 <table width="100%" border=0 rules="none" frame="void"
104 cols="2" cellspacing="0" cellpadding="0">
105 <tr valign="top" align="left">
106 <td width="8%"></td>
107 <td width="91%">
108 <p><b>libtiff</b>(3TIFF)</p>
109 <!-- INDENTATION -->
110 <p>Libtiff library home page:
111 <b>http://www.remotesensing.org/libtiff/</b></p>
112 </td>
113 </table>
114 <hr>
115 </body>
116 </html>