Update ABI/API compatibility reports after commit cc1919b183f76d5ac79cc9927fb899b4770...
[openjpeg.git] / doxygen / structbox__param.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.11"/>
7 <title>OpenJPEG: box_param 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.4.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.11 -->
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">box_param Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>box parameters  
55  <a href="structbox__param.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="box__manager_8h_source.html">box_manager.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:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#ab6a91091b8afeb3d5cea812a3c6b19a3">fd</a></td></tr>
62 <tr class="memdesc:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">file descriptor  <a href="#ab6a91091b8afeb3d5cea812a3c6b19a3">More...</a><br /></td></tr>
63 <tr class="separator:ab6a91091b8afeb3d5cea812a3c6b19a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a6ea7450cb7dad8229f9f80deeecb3653"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a6ea7450cb7dad8229f9f80deeecb3653">offset</a></td></tr>
65 <tr class="memdesc:a6ea7450cb7dad8229f9f80deeecb3653"><td class="mdescLeft">&#160;</td><td class="mdescRight">byte position of the whole Box (LBox) in the file  <a href="#a6ea7450cb7dad8229f9f80deeecb3653">More...</a><br /></td></tr>
66 <tr class="separator:a6ea7450cb7dad8229f9f80deeecb3653"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:aada29a9e2ee24be155b8a3dc3e3d2253"><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="structbox__param.html#aada29a9e2ee24be155b8a3dc3e3d2253">headlen</a></td></tr>
68 <tr class="memdesc:aada29a9e2ee24be155b8a3dc3e3d2253"><td class="mdescLeft">&#160;</td><td class="mdescRight">header length 8 or 16  <a href="#aada29a9e2ee24be155b8a3dc3e3d2253">More...</a><br /></td></tr>
69 <tr class="separator:aada29a9e2ee24be155b8a3dc3e3d2253"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a3f675a72aeb95c732b88ab45e8446a4e"><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="structbox__param.html#a3f675a72aeb95c732b88ab45e8446a4e">length</a></td></tr>
71 <tr class="memdesc:a3f675a72aeb95c732b88ab45e8446a4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">length of the whole Box  <a href="#a3f675a72aeb95c732b88ab45e8446a4e">More...</a><br /></td></tr>
72 <tr class="separator:a3f675a72aeb95c732b88ab45e8446a4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a24767e2a946d939983ba55efa8fdfb7a"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a24767e2a946d939983ba55efa8fdfb7a">type</a> [4]</td></tr>
74 <tr class="memdesc:a24767e2a946d939983ba55efa8fdfb7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of information in the DBox  <a href="#a24767e2a946d939983ba55efa8fdfb7a">More...</a><br /></td></tr>
75 <tr class="separator:a24767e2a946d939983ba55efa8fdfb7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbox__param.html">box_param</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbox__param.html#a8d5dba02e64d6c60e2805ee5c62c2d41">next</a></td></tr>
77 <tr class="memdesc:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the next box  <a href="#a8d5dba02e64d6c60e2805ee5c62c2d41">More...</a><br /></td></tr>
78 <tr class="separator:a8d5dba02e64d6c60e2805ee5c62c2d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 </table>
80 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
81 <div class="textblock"><p>box parameters </p>
82 </div><h2 class="groupheader">Field Documentation</h2>
83 <a class="anchor" id="ab6a91091b8afeb3d5cea812a3c6b19a3"></a>
84 <div class="memitem">
85 <div class="memproto">
86       <table class="memname">
87         <tr>
88           <td class="memname">int box_param::fd</td>
89         </tr>
90       </table>
91 </div><div class="memdoc">
92
93 <p>file descriptor </p>
94
95 <p>Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#ac907241542ef0cd6e13deafffde74363">fetch_DBox1byte()</a>, <a class="el" href="box__manager_8h.html#a28a029e965842146cac12fcf05757c66">fetch_DBox2bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a1f18b967d9b8fd83fa70a6580ce9ab53">fetch_DBox4bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a46342c34b100e9174966f70bf36936ef">fetch_DBox8bytebigendian()</a>, <a class="el" href="box__manager_8h.html#a0dcfa6897f3fd71d6336671a2a5b7e07">fetch_DBoxbytes()</a>, <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a748c2d73b85353a96c1f59feebed6eb2">gene_childboxbyOffset()</a>, <a class="el" href="box__manager_8h.html#a10d0b1c901f1ac161305c2b5b45aca5e">gene_childboxbyType()</a>, <a class="el" href="boxheader__manager_8h.html#acef0f9dedbcfe391a86a87b5693fda5a">gene_childboxheader()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>, <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>, and <a class="el" href="index__manager_8c.html#ab16c783f41458fea838b5a8ebd892798">set_tpixdata()</a>.</p>
96
97 </div>
98 </div>
99 <a class="anchor" id="aada29a9e2ee24be155b8a3dc3e3d2253"></a>
100 <div class="memitem">
101 <div class="memproto">
102       <table class="memname">
103         <tr>
104           <td class="memname"><a class="el" href="byte__manager_8h.html#ade896f5d51f03e046a004d006b53a8b0">Byte_t</a> box_param::headlen</td>
105         </tr>
106       </table>
107 </div><div class="memdoc">
108
109 <p>header length 8 or 16 </p>
110
111 <p>Referenced by <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="placeholder__manager_8h.html#ab98bea9b6be61f2e65a04df5745d9eb7">gene_placeholder()</a>, <a class="el" href="box__manager_8h.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="box__manager_8h.html#aa6d6dd0304ffedcb0c67ef23cf62e38a">get_DBoxoff()</a>, and <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>.</p>
112
113 </div>
114 </div>
115 <a class="anchor" id="a3f675a72aeb95c732b88ab45e8446a4e"></a>
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> box_param::length</td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124
125 <p>length of the whole Box </p>
126
127 <p>Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a0c5e97f8df3073b59d319c237844d3fd">get_boxstructure()</a>, <a class="el" href="box__manager_8h.html#a177899ef17695f68a34abaff3795175c">get_DBoxlen()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</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>
128
129 </div>
130 </div>
131 <a class="anchor" id="a8d5dba02e64d6c60e2805ee5c62c2d41"></a>
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname">struct <a class="el" href="structbox__param.html">box_param</a>* box_param::next</td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 <p>pointer to the next box </p>
142
143 <p>Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#a77ada7ec552ad6aecf1de5ecb1ec27bb">delete_box_in_list()</a>, <a class="el" href="box__manager_8h.html#ad72e15be902a7c0cdfee23468250fff5">delete_boxlist()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#af1cdc6e87a93954e92d8e481208895d4">insert_box_into_list()</a>, <a class="el" href="box__manager_8h.html#a29a36ad1d80050083acd21c1131eea59">print_allbox()</a>, <a class="el" href="box__manager_8h.html#ad9d347a84614e1e2bfd4464f22fbd2c5">search_box()</a>, and <a class="el" href="metadata__manager_8h.html#a17ebaeb53c239a6b5e0d8f77ea88ffac">search_metadataidx()</a>.</p>
144
145 </div>
146 </div>
147 <a class="anchor" id="a6ea7450cb7dad8229f9f80deeecb3653"></a>
148 <div class="memitem">
149 <div class="memproto">
150       <table class="memname">
151         <tr>
152           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> box_param::offset</td>
153         </tr>
154       </table>
155 </div><div class="memdoc">
156
157 <p>byte position of the whole Box (LBox) in the file </p>
158
159 <p>Referenced by <a class="el" href="index__manager_8c.html#aef72d99e5b07983bcf9b7ba3b76f0c61">check_JP2boxidx()</a>, <a class="el" href="msgqueue__manager_8c.html#af9e8592eed6cce4e4662573d4e0baab2">enqueue_box()</a>, <a class="el" href="box__manager_8h.html#a7775b0d45b5e84a6d59ca1477ee0088c">fetch_headbytes()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#aa6d6dd0304ffedcb0c67ef23cf62e38a">get_DBoxoff()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</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>
160
161 </div>
162 </div>
163 <a class="anchor" id="a24767e2a946d939983ba55efa8fdfb7a"></a>
164 <div class="memitem">
165 <div class="memproto">
166       <table class="memname">
167         <tr>
168           <td class="memname">char box_param::type[4]</td>
169         </tr>
170       </table>
171 </div><div class="memdoc">
172
173 <p>type of information in the DBox </p>
174
175 <p>Referenced by <a class="el" href="metadata__manager_8h.html#a03c8182628aa31f07dbca72fe966676a">const_metadatalist()</a>, <a class="el" href="box__manager_8h.html#a191b8fecf58253b417a49b1f5ea142ae">gene_boxbyOffinStream()</a>, <a class="el" href="box__manager_8h.html#ab31eb6d1ab6816c613a1938f0cc4b6e1">gene_boxbyOffset()</a>, <a class="el" href="box__manager_8h.html#af72156ca09a2c48d26b001b2897bd442">gene_boxbyType()</a>, <a class="el" href="box__manager_8h.html#ab67a3239dc3443f80439aa68531fe3dd">gene_boxbyTypeinStream()</a>, <a class="el" href="box__manager_8h.html#a169c879575c0ab58678dced26f96af85">print_box()</a>, <a class="el" href="box__manager_8h.html#ad9d347a84614e1e2bfd4464f22fbd2c5">search_box()</a>, and <a class="el" href="metadata__manager_8h.html#a17ebaeb53c239a6b5e0d8f77ea88ffac">search_metadataidx()</a>.</p>
176
177 </div>
178 </div>
179 <hr/>The documentation for this struct was generated from the following file:<ul>
180 <li><a class="el" href="box__manager_8h_source.html">box_manager.h</a></li>
181 </ul>
182 </div><!-- contents -->
183 <!-- start footer part -->
184 <hr class="footer"/><address class="footer"><small>
185 Generated by &#160;<a href="http://www.doxygen.org/index.html">
186 <img class="footer" src="doxygen.png" alt="doxygen"/>
187 </a> 1.8.11
188 </small></address>
189 </body>
190 </html>