Update Doxygen doc
[openjpeg.git] / doxygen / structopj__tile__index.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_tile_index 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_tile_index Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Index structure about a tile.  
55  <a href="structopj__tile__index.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.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:ab32de2a32290709e66313b5d7fbbe6e1"><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__tile__index.html#ab32de2a32290709e66313b5d7fbbe6e1">tileno</a></td></tr>
62 <tr class="memdesc:ab32de2a32290709e66313b5d7fbbe6e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">tile index  <a href="#ab32de2a32290709e66313b5d7fbbe6e1">More...</a><br /></td></tr>
63 <tr class="separator:ab32de2a32290709e66313b5d7fbbe6e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a850d46c58c9ad02070ae87ed46f4d675"><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__tile__index.html#a850d46c58c9ad02070ae87ed46f4d675">nb_tps</a></td></tr>
65 <tr class="memdesc:a850d46c58c9ad02070ae87ed46f4d675"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of tile parts  <a href="#a850d46c58c9ad02070ae87ed46f4d675">More...</a><br /></td></tr>
66 <tr class="separator:a850d46c58c9ad02070ae87ed46f4d675"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:a2ff0c3c3d726d2d337ba00daa573bc9c"><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__tile__index.html#a2ff0c3c3d726d2d337ba00daa573bc9c">current_nb_tps</a></td></tr>
68 <tr class="memdesc:a2ff0c3c3d726d2d337ba00daa573bc9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">current nb of tile part (allocated)  <a href="#a2ff0c3c3d726d2d337ba00daa573bc9c">More...</a><br /></td></tr>
69 <tr class="separator:a2ff0c3c3d726d2d337ba00daa573bc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a05f204bc2a2012668088b53761dbad21"><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__tile__index.html#a05f204bc2a2012668088b53761dbad21">current_tpsno</a></td></tr>
71 <tr class="memdesc:a05f204bc2a2012668088b53761dbad21"><td class="mdescLeft">&#160;</td><td class="mdescRight">current tile-part index  <a href="#a05f204bc2a2012668088b53761dbad21">More...</a><br /></td></tr>
72 <tr class="separator:a05f204bc2a2012668088b53761dbad21"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:a67e49af9ba010abeb56d723c639e3f65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a59301f51ec3a295cc3c7df01bd31c4f7">opj_tp_index_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tile__index.html#a67e49af9ba010abeb56d723c639e3f65">tp_index</a></td></tr>
74 <tr class="memdesc:a67e49af9ba010abeb56d723c639e3f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">information concerning tile parts  <a href="#a67e49af9ba010abeb56d723c639e3f65">More...</a><br /></td></tr>
75 <tr class="separator:a67e49af9ba010abeb56d723c639e3f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:afe5785db09d276754876b56504aa6928"><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__tile__index.html#afe5785db09d276754876b56504aa6928">marknum</a></td></tr>
77 <tr class="memdesc:afe5785db09d276754876b56504aa6928"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of markers  <a href="#afe5785db09d276754876b56504aa6928">More...</a><br /></td></tr>
78 <tr class="separator:afe5785db09d276754876b56504aa6928"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:a2d2cf09d03e365530c1cd40f98003b18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a8d13df85ea14a6a64ad403e168b0be37">opj_marker_info_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tile__index.html#a2d2cf09d03e365530c1cd40f98003b18">marker</a></td></tr>
80 <tr class="memdesc:a2d2cf09d03e365530c1cd40f98003b18"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of markers  <a href="#a2d2cf09d03e365530c1cd40f98003b18">More...</a><br /></td></tr>
81 <tr class="separator:a2d2cf09d03e365530c1cd40f98003b18"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:ac23cb8601e7c587234ec702b9cb19c52"><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__tile__index.html#ac23cb8601e7c587234ec702b9cb19c52">maxmarknum</a></td></tr>
83 <tr class="memdesc:ac23cb8601e7c587234ec702b9cb19c52"><td class="mdescLeft">&#160;</td><td class="mdescRight">actual size of markers array  <a href="#ac23cb8601e7c587234ec702b9cb19c52">More...</a><br /></td></tr>
84 <tr class="separator:ac23cb8601e7c587234ec702b9cb19c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:a78addc7dc1a7e4977626bfe7e64a8c22"><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__tile__index.html#a78addc7dc1a7e4977626bfe7e64a8c22">nb_packet</a></td></tr>
86 <tr class="memdesc:a78addc7dc1a7e4977626bfe7e64a8c22"><td class="mdescLeft">&#160;</td><td class="mdescRight">packet number  <a href="#a78addc7dc1a7e4977626bfe7e64a8c22">More...</a><br /></td></tr>
87 <tr class="separator:a78addc7dc1a7e4977626bfe7e64a8c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a6c7234f043c8994c991677965074c57f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ad2aa5c15e6f2f4d57f3f98200108b29c">opj_packet_info_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tile__index.html#a6c7234f043c8994c991677965074c57f">packet_index</a></td></tr>
89 <tr class="memdesc:a6c7234f043c8994c991677965074c57f"><td class="mdescLeft">&#160;</td><td class="mdescRight">information concerning packets inside tile  <a href="#a6c7234f043c8994c991677965074c57f">More...</a><br /></td></tr>
90 <tr class="separator:a6c7234f043c8994c991677965074c57f"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 </table>
92 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
93 <div class="textblock"><p>Index structure about a tile. </p>
94 </div><h2 class="groupheader">Field Documentation</h2>
95 <a class="anchor" id="a2ff0c3c3d726d2d337ba00daa573bc9c"></a>
96 <div class="memitem">
97 <div class="memproto">
98       <table class="memname">
99         <tr>
100           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::current_nb_tps</td>
101         </tr>
102       </table>
103 </div><div class="memdoc">
104
105 <p>current nb of tile part (allocated) </p>
106
107 <p>Referenced by <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>.</p>
108
109 </div>
110 </div>
111 <a class="anchor" id="a05f204bc2a2012668088b53761dbad21"></a>
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::current_tpsno</td>
117         </tr>
118       </table>
119 </div><div class="memdoc">
120
121 <p>current tile-part index </p>
122
123 <p>Referenced by <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="group___j2_k.html#gaf1ac6b62e18b03816163369ec3a81eff">opj_j2k_read_sod()</a>, and <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>.</p>
124
125 </div>
126 </div>
127 <a class="anchor" id="a2d2cf09d03e365530c1cd40f98003b18"></a>
128 <div class="memitem">
129 <div class="memproto">
130       <table class="memname">
131         <tr>
132           <td class="memname"><a class="el" href="openjpeg_8h.html#a8d13df85ea14a6a64ad403e168b0be37">opj_marker_info_t</a>* opj_tile_index::marker</td>
133         </tr>
134       </table>
135 </div><div class="memdoc">
136
137 <p>list of markers </p>
138
139 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="group___j2_k.html#ga555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
140
141 </div>
142 </div>
143 <a class="anchor" id="afe5785db09d276754876b56504aa6928"></a>
144 <div class="memitem">
145 <div class="memproto">
146       <table class="memname">
147         <tr>
148           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::marknum</td>
149         </tr>
150       </table>
151 </div><div class="memdoc">
152
153 <p>number of markers </p>
154
155 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="group___j2_k.html#ga555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>, and <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>.</p>
156
157 </div>
158 </div>
159 <a class="anchor" id="ac23cb8601e7c587234ec702b9cb19c52"></a>
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::maxmarknum</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 <p>actual size of markers array </p>
170
171 <p>Referenced by <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, and <a class="el" href="group___j2_k.html#ga555b0066bf125eea39ab1cb7fdec2e5b">opj_j2k_allocate_tile_element_cstr_index()</a>.</p>
172
173 </div>
174 </div>
175 <a class="anchor" id="a78addc7dc1a7e4977626bfe7e64a8c22"></a>
176 <div class="memitem">
177 <div class="memproto">
178       <table class="memname">
179         <tr>
180           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::nb_packet</td>
181         </tr>
182       </table>
183 </div><div class="memdoc">
184
185 <p>packet number </p>
186
187 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>.</p>
188
189 </div>
190 </div>
191 <a class="anchor" id="a850d46c58c9ad02070ae87ed46f4d675"></a>
192 <div class="memitem">
193 <div class="memproto">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::nb_tps</td>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200
201 <p>number of tile parts </p>
202
203 <p>Referenced by <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, and <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>.</p>
204
205 </div>
206 </div>
207 <a class="anchor" id="a6c7234f043c8994c991677965074c57f"></a>
208 <div class="memitem">
209 <div class="memproto">
210       <table class="memname">
211         <tr>
212           <td class="memname"><a class="el" href="openjpeg_8h.html#ad2aa5c15e6f2f4d57f3f98200108b29c">opj_packet_info_t</a>* opj_tile_index::packet_index</td>
213         </tr>
214       </table>
215 </div><div class="memdoc">
216
217 <p>information concerning packets inside tile </p>
218
219 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, and <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>.</p>
220
221 </div>
222 </div>
223 <a class="anchor" id="ab32de2a32290709e66313b5d7fbbe6e1"></a>
224 <div class="memitem">
225 <div class="memproto">
226       <table class="memname">
227         <tr>
228           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tile_index::tileno</td>
229         </tr>
230       </table>
231 </div><div class="memdoc">
232
233 <p>tile index </p>
234
235 <p>Referenced by <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>.</p>
236
237 </div>
238 </div>
239 <a class="anchor" id="a67e49af9ba010abeb56d723c639e3f65"></a>
240 <div class="memitem">
241 <div class="memproto">
242       <table class="memname">
243         <tr>
244           <td class="memname"><a class="el" href="openjpeg_8h.html#a59301f51ec3a295cc3c7df01bd31c4f7">opj_tp_index_t</a>* opj_tile_index::tp_index</td>
245         </tr>
246       </table>
247 </div><div class="memdoc">
248
249 <p>information concerning tile parts </p>
250
251 <p>Referenced by <a class="el" href="j2k_8h.html#a5836409e5b74b5a9b356e6f24cb9ade8">j2k_destroy_cstr_index()</a>, <a class="el" href="j2k_8h.html#aab1aefcf177ba3726b29afec69993f6b">j2k_get_cstr_index()</a>, <a class="el" href="group___j2_k.html#gac5cf290f62c510f4896ad41f872336a7">opj_j2k_add_tlmarker()</a>, <a class="el" href="j2k_8c.html#ae310be1158fc90d77b9f4bd2711069d2">opj_j2k_decode_one_tile()</a>, <a class="el" href="group___j2_k.html#ga2b7e7cbaaffd2361ade9b2c79b6627f2">opj_j2k_dump_MH_index()</a>, <a class="el" href="group___j2_k.html#gaf1ac6b62e18b03816163369ec3a81eff">opj_j2k_read_sod()</a>, and <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>.</p>
252
253 </div>
254 </div>
255 <hr/>The documentation for this struct was generated from the following file:<ul>
256 <li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
257 </ul>
258 </div><!-- contents -->
259 <!-- start footer part -->
260 <hr class="footer"/><address class="footer"><small>
261 Generated by &#160;<a href="http://www.doxygen.org/index.html">
262 <img class="footer" src="doxygen.png" alt="doxygen"/>
263 </a> 1.8.10
264 </small></address>
265 </body>
266 </html>