| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: bitbuf.h File Reference</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <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> |
||
| 8 | <h1>bitbuf.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 9 | |||
| 10 | <p> |
||
| 11 | Definition in file <a class="el" href="bitbuf_8h-source.html">bitbuf.h</a>. |
||
| 12 | <p> |
||
| 13 | |||
| 14 | <p> |
||
| 15 | <a href="bitbuf_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 16 | <tr><td></td></tr> |
||
| 17 | <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
||
| 18 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="bitbuf.h::BitBuf"></a> |
||
| 19 | typedef struct_BitBuf </td><td class="memItemRight" valign="bottom"><b>BitBuf</b></td></tr> |
||
| 20 | |||
| 21 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 22 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="bitbuf.h::bitbufInit"></a> |
||
| 23 | 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> |
||
| 24 | |||
| 25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">initialize a buffer to start at a given address and have given size <br></td></tr> |
||
| 26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="bitbuf.h::bitbufGet"></a> |
||
| 27 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga2">bitbufGet</a> (BitBuf *bitBuffer)</td></tr> |
||
| 28 | |||
| 29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">get the bit at the current position in the buffer <br></td></tr> |
||
| 30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="bitbuf.h::bitbufGetAtIndex"></a> |
||
| 31 | 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> |
||
| 32 | |||
| 33 | <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> |
||
| 34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="bitbuf.h::bitbufStore"></a> |
||
| 35 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga4">bitbufStore</a> (BitBuf *bitBuffer, unsigned char bit)</td></tr> |
||
| 36 | |||
| 37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">store a bit at the current position in the buffer <br></td></tr> |
||
| 38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="bitbuf.h::bitbufGetDataLength"></a> |
||
| 39 | unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga5">bitbufGetDataLength</a> (BitBuf *bitBuffer)</td></tr> |
||
| 40 | |||
| 41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of bits in the buffer <br></td></tr> |
||
| 42 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="bitbuf.h::bitbufReset"></a> |
||
| 43 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga6">bitbufReset</a> (BitBuf *bitBuffer)</td></tr> |
||
| 44 | |||
| 45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">resets the read/write position of the buffer to beginning <br></td></tr> |
||
| 46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="bitbuf.h::bitbufFlush"></a> |
||
| 47 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bitbuf.html#ga7">bitbufFlush</a> (BitBuf *bitBuffer)</td></tr> |
||
| 48 | |||
| 49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">flush (clear) the contents of the buffer <br></td></tr> |
||
| 50 | </table> |
||
| 51 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by |
||
| 52 | <a href="http://www.doxygen.org/index.html"> |
||
| 53 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 54 | </body> |
||
| 55 | </html> |
Powered by WebSVN v2.8.3