Update libogg documentation to 1.3.3.
[xiph-mirror.git] / ogg / doc / libogg / oggpack_buffer.html
blob0b5aa69cf4fe8c50d176e965c4aeaa0ec17051ab
1 <html>
3 <head>
4 <title>libogg - datatype - oggpack_buffer</title>
5 <link rel=stylesheet href="style.css" type="text/css">
6 </head>
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
10 <tr>
11 <td><p class=tiny>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>
13 </tr>
14 </table>
16 <h1>oggpack_buffer</h1>
18 <p><i>declared in "ogg/ogg.h"</i></p>
20 <p>
21 The oggpack_buffer struct is used with libogg's bitpacking functions. You should never need to directly access anything in this structure.
22 <p>
24 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
25 <tr bgcolor=#cccccc>
26 <td>
27 <pre><b>
28 typedef struct {
29 long endbyte;
30 int endbit;
32 unsigned char *buffer;
33 unsigned char *ptr;
34 long storage;
35 } oggpack_buffer;
36 </b></pre>
37 </td>
38 </tr>
39 </table>
41 <h3>Relevant Struct Members</h3>
42 <dl>
43 <dt><i>buffer</i></dt>
44 <dd>Pointer to data being manipulated.</dd>
45 <dt><i>ptr</i></dt>
46 <dd>Location pointer to mark which data has been read.</dd>
47 <dt><i>storage</i></dt>
48 <dd>Size of buffer.</i></dt>
49 </dl>
52 <br><br>
53 <hr noshade>
54 <table border=0 width=100%>
55 <tr valign=top>
56 <td><p class=tiny>copyright &copy; 2000-2017 Xiph.Org Foundation</p></td>
57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
58 </tr><tr>
59 <td><p class=tiny>libogg documentation</p></td>
60 <td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>
61 </tr>
62 </table>
64 </body>
66 </html>