Update doc
[openjpeg.git] / doxygen / structboxheader__param.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: boxheader_param 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.5.0</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.17 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 </div><!-- top -->
41 <div class="header">
42   <div class="summary">
43 <a href="#pub-attribs">Data Fields</a>  </div>
44   <div class="headertitle">
45 <div class="title">boxheader_param Struct Reference</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>box header parameters  
50  <a href="structboxheader__param.html#details">More...</a></p>
51
52 <p><code>#include &lt;<a class="el" href="boxheader__manager_8h_source.html">boxheader_manager.h</a>&gt;</code></p>
53 <table class="memberdecls">
54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
55 Data Fields</h2></td></tr>
56 <tr class="memitem:aabf782e3d43e158e4477308c11670ac4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">headlen</a></td></tr>
57 <tr class="memdesc:aabf782e3d43e158e4477308c11670ac4"><td class="mdescLeft">&#160;</td><td class="mdescRight">header length 8 or 16  <a href="structboxheader__param.html#aabf782e3d43e158e4477308c11670ac4">More...</a><br /></td></tr>
58 <tr class="separator:aabf782e3d43e158e4477308c11670ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <tr class="memitem:a2a90e59fdad1a3ff2c0f40b4dfff7ed1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">length</a></td></tr>
60 <tr class="memdesc:a2a90e59fdad1a3ff2c0f40b4dfff7ed1"><td class="mdescLeft">&#160;</td><td class="mdescRight">length of the reference Box  <a href="structboxheader__param.html#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">More...</a><br /></td></tr>
61 <tr class="separator:a2a90e59fdad1a3ff2c0f40b4dfff7ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:ad64aefab7bef517b0bfe152352f89d99"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">type</a> [4]</td></tr>
63 <tr class="memdesc:ad64aefab7bef517b0bfe152352f89d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of information in the DBox  <a href="structboxheader__param.html#ad64aefab7bef517b0bfe152352f89d99">More...</a><br /></td></tr>
64 <tr class="separator:ad64aefab7bef517b0bfe152352f89d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
65 <tr class="memitem:a24a521b8c32b65e2354e67191c14f232"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structboxheader__param.html">boxheader_param</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">next</a></td></tr>
66 <tr class="memdesc:a24a521b8c32b65e2354e67191c14f232"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the next header box  <a href="structboxheader__param.html#a24a521b8c32b65e2354e67191c14f232">More...</a><br /></td></tr>
67 <tr class="separator:a24a521b8c32b65e2354e67191c14f232"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 </table>
69 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
70 <div class="textblock"><p>box header parameters </p>
71 </div><h2 class="groupheader">Field Documentation</h2>
72 <a id="aabf782e3d43e158e4477308c11670ac4"></a>
73 <h2 class="memtitle"><span class="permalink"><a href="#aabf782e3d43e158e4477308c11670ac4">&#9670;&nbsp;</a></span>headlen</h2>
74
75 <div class="memitem">
76 <div class="memproto">
77       <table class="memname">
78         <tr>
79           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> boxheader_param::headlen</td>
80         </tr>
81       </table>
82 </div><div class="memdoc">
83
84 <p>header length 8 or 16 </p>
85
86 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader()</a>, and <a class="el" href="manfbox__manager_8h.html#a7c8a7b0c84e1ad9d858c16ed4888b7f1">gene_manfbox()</a>.</p>
87
88 </div>
89 </div>
90 <a id="a2a90e59fdad1a3ff2c0f40b4dfff7ed1"></a>
91 <h2 class="memtitle"><span class="permalink"><a href="#a2a90e59fdad1a3ff2c0f40b4dfff7ed1">&#9670;&nbsp;</a></span>length</h2>
92
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> boxheader_param::length</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p>length of the reference Box </p>
103
104 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader()</a>, and <a class="el" href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader()</a>.</p>
105
106 </div>
107 </div>
108 <a id="a24a521b8c32b65e2354e67191c14f232"></a>
109 <h2 class="memtitle"><span class="permalink"><a href="#a24a521b8c32b65e2354e67191c14f232">&#9670;&nbsp;</a></span>next</h2>
110
111 <div class="memitem">
112 <div class="memproto">
113       <table class="memname">
114         <tr>
115           <td class="memname">struct <a class="el" href="structboxheader__param.html">boxheader_param</a>* boxheader_param::next</td>
116         </tr>
117       </table>
118 </div><div class="memdoc">
119
120 <p>pointer to the next header box </p>
121
122 <p class="reference">Referenced by <a class="el" href="manfbox__manager_8h.html#a79f039f4170fa5673abd188e4649b717">delete_manfbox()</a>, <a class="el" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader()</a>, <a class="el" href="manfbox__manager_8h.html#a7c8a7b0c84e1ad9d858c16ed4888b7f1">gene_manfbox()</a>, <a class="el" href="manfbox__manager_8h.html#afffa66277d7b16d789f1c78683f7fc53">print_manfbox()</a>, <a class="el" href="manfbox__manager_8h.html#a6574f4f07559e5bffc3fafc4a8689249">search_boxheader()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
123
124 </div>
125 </div>
126 <a id="ad64aefab7bef517b0bfe152352f89d99"></a>
127 <h2 class="memtitle"><span class="permalink"><a href="#ad64aefab7bef517b0bfe152352f89d99">&#9670;&nbsp;</a></span>type</h2>
128
129 <div class="memitem">
130 <div class="memproto">
131       <table class="memname">
132         <tr>
133           <td class="memname">char boxheader_param::type[4]</td>
134         </tr>
135       </table>
136 </div><div class="memdoc">
137
138 <p>type of information in the DBox </p>
139
140 <p class="reference">Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="boxheader__manager_8h.html#ad67b5454e29ddcd711d07eaddbe29f67">gene_boxheader()</a>, <a class="el" href="boxheader__manager_8h.html#a366e577597bfcd3e2d8c6db97f802a26">print_boxheader()</a>, and <a class="el" href="manfbox__manager_8h.html#a6574f4f07559e5bffc3fafc4a8689249">search_boxheader()</a>.</p>
141
142 </div>
143 </div>
144 <hr/>The documentation for this struct was generated from the following file:<ul>
145 <li><a class="el" href="boxheader__manager_8h_source.html">boxheader_manager.h</a></li>
146 </ul>
147 </div><!-- contents -->
148 <!-- start footer part -->
149 <hr class="footer"/><address class="footer"><small>
150 Generated by &#160;<a href="http://www.doxygen.org/index.html">
151 <img class="footer" src="doxygen.png" alt="doxygen"/>
152 </a> 1.8.17
153 </small></address>
154 </body>
155 </html>