Update doxygen for release 2.3.1
[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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_bio Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <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>
45 </div><!--header-->
46 <div class="contents">
47
48 <p>Individual bit input-output stream (BIO)  
49  <a href="structopj__bio.html#details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="bio_8h_source.html">bio.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <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>
56 <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>
57 <tr class="separator:a5b7b5826e12247721d21b8b118beaf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <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>
59 <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>
60 <tr class="separator:a82d1b48ca5f22eeb8ab2139982b576ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <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>
62 <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>
63 <tr class="separator:afbbfc81d9624cfd55add60bef5d0fb42"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <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>
66 <tr class="separator:a91e6c579ced7a356d042b27cbeba3e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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>
68 <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>
69 <tr class="separator:a739743b6883a37747cd417edaa18cf88"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 </table>
71 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
72 <div class="textblock"><p>Individual bit input-output stream (BIO) </p>
73 </div><h2 class="groupheader">Field Documentation</h2>
74 <a id="afbbfc81d9624cfd55add60bef5d0fb42"></a>
75 <h2 class="memtitle"><span class="permalink"><a href="#afbbfc81d9624cfd55add60bef5d0fb42">&#9670;&nbsp;</a></span>bp</h2>
76
77 <div class="memitem">
78 <div class="memproto">
79       <table class="memname">
80         <tr>
81           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::bp</td>
82         </tr>
83       </table>
84 </div><div class="memdoc">
85
86 <p>pointer to the present position in the buffer </p>
87
88 <p class="reference">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>
89
90 </div>
91 </div>
92 <a id="a91e6c579ced7a356d042b27cbeba3e03"></a>
93 <h2 class="memtitle"><span class="permalink"><a href="#a91e6c579ced7a356d042b27cbeba3e03">&#9670;&nbsp;</a></span>buf</h2>
94
95 <div class="memitem">
96 <div class="memproto">
97       <table class="memname">
98         <tr>
99           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_bio::buf</td>
100         </tr>
101       </table>
102 </div><div class="memdoc">
103
104 <p>temporary place where each byte is read or written </p>
105
106 <p class="reference">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>
107
108 </div>
109 </div>
110 <a id="a739743b6883a37747cd417edaa18cf88"></a>
111 <h2 class="memtitle"><span class="permalink"><a href="#a739743b6883a37747cd417edaa18cf88">&#9670;&nbsp;</a></span>ct</h2>
112
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 class="reference">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 id="a82d1b48ca5f22eeb8ab2139982b576ba"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#a82d1b48ca5f22eeb8ab2139982b576ba">&#9670;&nbsp;</a></span>end</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::end</td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 <p>pointer to the end of the buffer </p>
142
143 <p class="reference">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>
144
145 </div>
146 </div>
147 <a id="a5b7b5826e12247721d21b8b118beaf38"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#a5b7b5826e12247721d21b8b118beaf38">&#9670;&nbsp;</a></span>start</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152       <table class="memname">
153         <tr>
154           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_bio::start</td>
155         </tr>
156       </table>
157 </div><div class="memdoc">
158
159 <p>pointer to the start of the buffer </p>
160
161 <p class="reference">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>
162
163 </div>
164 </div>
165 <hr/>The documentation for this struct was generated from the following file:<ul>
166 <li><a class="el" href="bio_8h_source.html">bio.h</a></li>
167 </ul>
168 </div><!-- contents -->
169 <!-- start footer part -->
170 <hr class="footer"/><address class="footer"><small>
171 Generated by &#160;<a href="http://www.doxygen.org/index.html">
172 <img class="footer" src="doxygen.png" alt="doxygen"/>
173 </a> 1.8.13
174 </small></address>
175 </body>
176 </html>