?lang_form?
?lang_select?
?lang_submit?
?lang_endform?
{HEADER END}
{FILE START}
library
?curdirlinks? - Rev 6
?prevdifflink? - Blame - ?getfile?
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Procyon AVRlib: Generic Bit-Buffer Structure and Function Library (bitbuf.c)</title>
<link href="dox.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>Generic Bit-Buffer Structure and Function Library (bitbuf.c)<br>
<small>
[<a class="el" href="group__general.html">General Libraries</a>]</small>
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include "<a class="code" href="bitbuf_8h.html">bitbuf.h</a>"</span>
</pre></div> <dl compact><dt><b>Overview</b></dt><dd>This bit-buffer structure provides an easy and efficient way to store and process bits. You can create as many bit buffers as you like (within memory limits), and then use this common set of functions to access each buffer. Supported functions include sequential getting and storing of bits, array-like get, buffer flush (dump data), and reset-to-beginning. This buffer is not dynamically allocated, it has a user-defined fixed maximum size. </dd></dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>struct_BitBuf</b></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="bitbuf::BitBuf"></a>
typedef struct_BitBuf </td><td class="memItemRight" valign="bottom"><b>BitBuf</b></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="bitbuf::bitbufInit"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga1">bitbufInit</a> (BitBuf *bitBuffer, unsigned char *start, unsigned short bytesize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">initialize a buffer to start at a given address and have given size <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="bitbuf::bitbufGet"></a>
unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga2">bitbufGet</a> (BitBuf *bitBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the bit at the current position in the buffer <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="bitbuf::bitbufGetAtIndex"></a>
unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga3">bitbufGetAtIndex</a> (BitBuf *bitBuffer, unsigned short bitIndex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a bit at the specified index in the buffer (kind of like array access) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="bitbuf::bitbufStore"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga4">bitbufStore</a> (BitBuf *bitBuffer, unsigned char bit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">store a bit at the current position in the buffer <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="bitbuf::bitbufGetDataLength"></a>
unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga5">bitbufGetDataLength</a> (BitBuf *bitBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of bits in the buffer <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="bitbuf::bitbufReset"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga6">bitbufReset</a> (BitBuf *bitBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">resets the read/write position of the buffer to beginning <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="bitbuf::bitbufFlush"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga7">bitbufFlush</a> (BitBuf *bitBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">flush (clear) the contents of the buffer <br></td></tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:09 2006 for Procyon AVRlib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
{FILE END}
{FOOTER START}
Powered by WebSVN v2.8.3