Update Doxygen doc
[openjpeg.git] / doxygen / structopj__raw.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_raw 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.1.2</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_raw Struct Reference<div class="ingroups"><a class="el" href="group___r_a_w.html">RAW - Implementation of operations for raw encoding</a></div></div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>RAW encoding operations.  
55  <a href="structopj__raw.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="raw_8h_source.html">raw.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:a9e5a976d8f55e567af92c9ff6fd492e4"><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__raw.html#a9e5a976d8f55e567af92c9ff6fd492e4">c</a></td></tr>
62 <tr class="memdesc:a9e5a976d8f55e567af92c9ff6fd492e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">temporary buffer where bits are coded or decoded  <a href="#a9e5a976d8f55e567af92c9ff6fd492e4">More...</a><br /></td></tr>
63 <tr class="separator:a9e5a976d8f55e567af92c9ff6fd492e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:afb86b09eef74471031c6d4144e4951ed"><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__raw.html#afb86b09eef74471031c6d4144e4951ed">ct</a></td></tr>
65 <tr class="memdesc:afb86b09eef74471031c6d4144e4951ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bits already read or free to write  <a href="#afb86b09eef74471031c6d4144e4951ed">More...</a><br /></td></tr>
66 <tr class="separator:afb86b09eef74471031c6d4144e4951ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a37d9f82ef382e011692f6d03e2be1b73"><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__raw.html#a37d9f82ef382e011692f6d03e2be1b73">lenmax</a></td></tr>
68 <tr class="memdesc:a37d9f82ef382e011692f6d03e2be1b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">maximum length to decode  <a href="#a37d9f82ef382e011692f6d03e2be1b73">More...</a><br /></td></tr>
69 <tr class="separator:a37d9f82ef382e011692f6d03e2be1b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a49edd2e5113c2727bebb56937c0811bf"><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__raw.html#a49edd2e5113c2727bebb56937c0811bf">len</a></td></tr>
71 <tr class="memdesc:a49edd2e5113c2727bebb56937c0811bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">length decoded  <a href="#a49edd2e5113c2727bebb56937c0811bf">More...</a><br /></td></tr>
72 <tr class="separator:a49edd2e5113c2727bebb56937c0811bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a873ec3b4abf06832cb492f1fe0f9dde9"><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__raw.html#a873ec3b4abf06832cb492f1fe0f9dde9">bp</a></td></tr>
74 <tr class="memdesc:a873ec3b4abf06832cb492f1fe0f9dde9"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the current position in the buffer  <a href="#a873ec3b4abf06832cb492f1fe0f9dde9">More...</a><br /></td></tr>
75 <tr class="separator:a873ec3b4abf06832cb492f1fe0f9dde9"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:ab135fadf2a1c829503331c3bf909496f"><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__raw.html#ab135fadf2a1c829503331c3bf909496f">start</a></td></tr>
77 <tr class="memdesc:ab135fadf2a1c829503331c3bf909496f"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the start of the buffer  <a href="#ab135fadf2a1c829503331c3bf909496f">More...</a><br /></td></tr>
78 <tr class="separator:ab135fadf2a1c829503331c3bf909496f"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:ad81abd256f06335bd3d23872cbad204a"><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__raw.html#ad81abd256f06335bd3d23872cbad204a">end</a></td></tr>
80 <tr class="memdesc:ad81abd256f06335bd3d23872cbad204a"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the end of the buffer  <a href="#ad81abd256f06335bd3d23872cbad204a">More...</a><br /></td></tr>
81 <tr class="separator:ad81abd256f06335bd3d23872cbad204a"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 </table>
83 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
84 <div class="textblock"><p>RAW encoding operations. </p>
85 </div><h2 class="groupheader">Field Documentation</h2>
86 <a class="anchor" id="a873ec3b4abf06832cb492f1fe0f9dde9"></a>
87 <div class="memitem">
88 <div class="memproto">
89       <table class="memname">
90         <tr>
91           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_raw::bp</td>
92         </tr>
93       </table>
94 </div><div class="memdoc">
95
96 <p>pointer to the current position in the buffer </p>
97
98 <p>Referenced by <a class="el" href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes()</a>.</p>
99
100 </div>
101 </div>
102 <a class="anchor" id="a9e5a976d8f55e567af92c9ff6fd492e4"></a>
103 <div class="memitem">
104 <div class="memproto">
105       <table class="memname">
106         <tr>
107           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> opj_raw::c</td>
108         </tr>
109       </table>
110 </div><div class="memdoc">
111
112 <p>temporary buffer where bits are coded or decoded </p>
113
114 <p>Referenced by <a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode()</a>, and <a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec()</a>.</p>
115
116 </div>
117 </div>
118 <a class="anchor" id="afb86b09eef74471031c6d4144e4951ed"></a>
119 <div class="memitem">
120 <div class="memproto">
121       <table class="memname">
122         <tr>
123           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw::ct</td>
124         </tr>
125       </table>
126 </div><div class="memdoc">
127
128 <p>number of bits already read or free to write </p>
129
130 <p>Referenced by <a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode()</a>, and <a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec()</a>.</p>
131
132 </div>
133 </div>
134 <a class="anchor" id="ad81abd256f06335bd3d23872cbad204a"></a>
135 <div class="memitem">
136 <div class="memproto">
137       <table class="memname">
138         <tr>
139           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_raw::end</td>
140         </tr>
141       </table>
142 </div><div class="memdoc">
143
144 <p>pointer to the end of the buffer </p>
145
146 </div>
147 </div>
148 <a class="anchor" id="a49edd2e5113c2727bebb56937c0811bf"></a>
149 <div class="memitem">
150 <div class="memproto">
151       <table class="memname">
152         <tr>
153           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw::len</td>
154         </tr>
155       </table>
156 </div><div class="memdoc">
157
158 <p>length decoded </p>
159
160 <p>Referenced by <a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode()</a>, and <a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec()</a>.</p>
161
162 </div>
163 </div>
164 <a class="anchor" id="a37d9f82ef382e011692f6d03e2be1b73"></a>
165 <div class="memitem">
166 <div class="memproto">
167       <table class="memname">
168         <tr>
169           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_raw::lenmax</td>
170         </tr>
171       </table>
172 </div><div class="memdoc">
173
174 <p>maximum length to decode </p>
175
176 <p>Referenced by <a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode()</a>, and <a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec()</a>.</p>
177
178 </div>
179 </div>
180 <a class="anchor" id="ab135fadf2a1c829503331c3bf909496f"></a>
181 <div class="memitem">
182 <div class="memproto">
183       <table class="memname">
184         <tr>
185           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_raw::start</td>
186         </tr>
187       </table>
188 </div><div class="memdoc">
189
190 <p>pointer to the start of the buffer </p>
191
192 <p>Referenced by <a class="el" href="group___r_a_w.html#gaa4e879e1d733e459b94c29141b7df142">opj_raw_decode()</a>, <a class="el" href="group___r_a_w.html#gaebd3e67e3b8673e4e4c3fa1834406389">opj_raw_init_dec()</a>, and <a class="el" href="group___r_a_w.html#gaee1cb91b1c5183234a36f53e0624f733">opj_raw_numbytes()</a>.</p>
193
194 </div>
195 </div>
196 <hr/>The documentation for this struct was generated from the following file:<ul>
197 <li><a class="el" href="raw_8h_source.html">raw.h</a></li>
198 </ul>
199 </div><!-- contents -->
200 <!-- start footer part -->
201 <hr class="footer"/><address class="footer"><small>
202 Generated by &#160;<a href="http://www.doxygen.org/index.html">
203 <img class="footer" src="doxygen.png" alt="doxygen"/>
204 </a> 1.8.10
205 </small></address>
206 </body>
207 </html>