Update Doxygen doc
[openjpeg.git] / doxygen / structopj__bio.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.10"/>
7 <title>OpenJPEG: opj_bio Struct Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39   <div id="navrow2" class="tabs2">
40     <ul class="tablist">
41       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
42       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
43     </ul>
44   </div>
45 </div><!-- top -->
46 <div class="header">
47   <div class="summary">
48 <a href="#pub-attribs">Data Fields</a>  </div>
49   <div class="headertitle">
50 <div class="title">opj_bio Struct Reference<div class="ingroups"><a class="el" href="group___b_i_o.html">BIO - Individual bit input-output stream</a></div></div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Individual bit input-output stream (BIO)  
55  <a href="structopj__bio.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="bio_8h_source.html">bio.h</a>&gt;</code></p>
58 <table class="memberdecls">
59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
60 Data Fields</h2></td></tr>
61 <tr class="memitem:a5b7b5826e12247721d21b8b118beaf38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a5b7b5826e12247721d21b8b118beaf38">start</a></td></tr>
62 <tr class="memdesc:a5b7b5826e12247721d21b8b118beaf38"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the start of the buffer  <a href="#a5b7b5826e12247721d21b8b118beaf38">More...</a><br /></td></tr>
63 <tr class="separator:a5b7b5826e12247721d21b8b118beaf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a82d1b48ca5f22eeb8ab2139982b576ba">end</a></td></tr>
65 <tr class="memdesc:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the end of the buffer  <a href="#a82d1b48ca5f22eeb8ab2139982b576ba">More...</a><br /></td></tr>
66 <tr class="separator:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:afbbfc81d9624cfd55add60bef5d0fb42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#afbbfc81d9624cfd55add60bef5d0fb42">bp</a></td></tr>
68 <tr class="memdesc:afbbfc81d9624cfd55add60bef5d0fb42"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the present position in the buffer  <a href="#afbbfc81d9624cfd55add60bef5d0fb42">More...</a><br /></td></tr>
69 <tr class="separator:afbbfc81d9624cfd55add60bef5d0fb42"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a91e6c579ced7a356d042b27cbeba3e03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a91e6c579ced7a356d042b27cbeba3e03">buf</a></td></tr>
71 <tr class="memdesc:a91e6c579ced7a356d042b27cbeba3e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">temporary place where each byte is read or written  <a href="#a91e6c579ced7a356d042b27cbeba3e03">More...</a><br /></td></tr>
72 <tr class="separator:a91e6c579ced7a356d042b27cbeba3e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a739743b6883a37747cd417edaa18cf88"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__bio.html#a739743b6883a37747cd417edaa18cf88">ct</a></td></tr>
74 <tr class="memdesc:a739743b6883a37747cd417edaa18cf88"><td class="mdescLeft">&#160;</td><td class="mdescRight">coder : number of bits free to write.  <a href="#a739743b6883a37747cd417edaa18cf88">More...</a><br /></td></tr>
75 <tr class="separator:a739743b6883a37747cd417edaa18cf88"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 </table>
77 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
78 <div class="textblock"><p>Individual bit input-output stream (BIO) </p>
79 </div><h2 class="groupheader">Field Documentation</h2>
80 <a class="anchor" id="afbbfc81d9624cfd55add60bef5d0fb42"></a>
81 <div class="memitem">
82 <div class="memproto">
83       <table class="memname">
84         <tr>
85           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::bp</td>
86         </tr>
87       </table>
88 </div><div class="memdoc">
89
90 <p>pointer to the present position in the buffer </p>
91
92 <p>Referenced by <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="group___b_i_o.html#gab895be8f05401452c080e42427408c5c">opj_bio_numbytes()</a>.</p>
93
94 </div>
95 </div>
96 <a class="anchor" id="a91e6c579ced7a356d042b27cbeba3e03"></a>
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio::buf</td>
102         </tr>
103       </table>
104 </div><div class="memdoc">
105
106 <p>temporary place where each byte is read or written </p>
107
108 <p>Referenced by <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>, <a class="el" href="group___b_i_o.html#ga830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign()</a>, <a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
109
110 </div>
111 </div>
112 <a class="anchor" id="a739743b6883a37747cd417edaa18cf88"></a>
113 <div class="memitem">
114 <div class="memproto">
115       <table class="memname">
116         <tr>
117           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio::ct</td>
118         </tr>
119       </table>
120 </div><div class="memdoc">
121
122 <p>coder : number of bits free to write. </p>
123 <p>decoder : number of bits read </p>
124
125 <p>Referenced by <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="group___b_i_o.html#gac2e60a814729cbeb98d8ee747245320c">opj_bio_flush()</a>, <a class="el" href="group___b_i_o.html#ga7aa126e3f12e3b56d83a0b19dce2370b">opj_bio_getbit()</a>, <a class="el" href="group___b_i_o.html#ga830ee6789a9be0ae5f9a8ff056b771fe">opj_bio_inalign()</a>, <a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="group___b_i_o.html#ga4cff07dd767044b26fbbd3030680df36">opj_bio_putbit()</a>.</p>
126
127 </div>
128 </div>
129 <a class="anchor" id="a82d1b48ca5f22eeb8ab2139982b576ba"></a>
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::end</td>
135         </tr>
136       </table>
137 </div><div class="memdoc">
138
139 <p>pointer to the end of the buffer </p>
140
141 <p>Referenced by <a class="el" href="group___b_i_o.html#ga1632241f1dd35ee1c895c89abf5f0fd0">opj_bio_bytein()</a>, <a class="el" href="group___b_i_o.html#ga9b06f926913047b80974f8f3c64be378">opj_bio_byteout()</a>, <a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, and <a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>.</p>
142
143 </div>
144 </div>
145 <a class="anchor" id="a5b7b5826e12247721d21b8b118beaf38"></a>
146 <div class="memitem">
147 <div class="memproto">
148       <table class="memname">
149         <tr>
150           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::start</td>
151         </tr>
152       </table>
153 </div><div class="memdoc">
154
155 <p>pointer to the start of the buffer </p>
156
157 <p>Referenced by <a class="el" href="group___b_i_o.html#ga8ab62fc21c5f26a774fb0e3590efeb4b">opj_bio_init_dec()</a>, <a class="el" href="group___b_i_o.html#ga549d1ff56aa2c8bea27c031c8a33936f">opj_bio_init_enc()</a>, and <a class="el" href="group___b_i_o.html#gab895be8f05401452c080e42427408c5c">opj_bio_numbytes()</a>.</p>
158
159 </div>
160 </div>
161 <hr/>The documentation for this struct was generated from the following file:<ul>
162 <li><a class="el" href="bio_8h_source.html">bio.h</a></li>
163 </ul>
164 </div><!-- contents -->
165 <!-- start footer part -->
166 <hr class="footer"/><address class="footer"><small>
167 Generated by &#160;<a href="http://www.doxygen.org/index.html">
168 <img class="footer" src="doxygen.png" alt="doxygen"/>
169 </a> 1.8.10
170 </small></address>
171 </body>
172 </html>