summaryrefslogtreecommitdiffhomepage
path: root/ogg/doc/libogg/oggpack_read.html
diff options
context:
space:
mode:
Diffstat (limited to 'ogg/doc/libogg/oggpack_read.html')
-rw-r--r--ogg/doc/libogg/oggpack_read.html65
1 files changed, 65 insertions, 0 deletions
diff --git a/ogg/doc/libogg/oggpack_read.html b/ogg/doc/libogg/oggpack_read.html
new file mode 100644
index 0000000..a826916
--- /dev/null
+++ b/ogg/doc/libogg/oggpack_read.html
@@ -0,0 +1,65 @@
+<html>
+
+<head>
+<title>libogg - function - oggpack_read</title>
+<link rel=stylesheet href="style.css" type="text/css">
+</head>
+
+<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
+<table border=0 width=100%>
+<tr>
+<td><p class=tiny>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
+</tr>
+</table>
+
+<h1>oggpack_read</h1>
+
+<p><i>declared in "ogg/ogg.h";</i></p>
+
+<p>This function reads the requested number of bits from the buffer and advances the location pointer.
+<p>Before reading, the buffer should be initialized using <a href="oggpack_readinit.html">oggpack_readinit</a>.
+
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+long oggpack_read(oggpack_buffer *b,int bits);
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>b</i></dt>
+<dd>Pointer to an <a href="oggpack_buffer.html">oggpack_buffer</a> struct containing buffered data to be read.</dd>
+<dt><i>bits</i></dt>
+<dd>Number of bits to read.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+<i>n</i> represents the requested bits.</li>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 2000-2014 Xiph.Org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
+</tr><tr>
+<td><p class=tiny>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>