update doxygen with OPJ v2.1.2

This commit is contained in:
Antonin Descampe
2016-09-29 22:38:29 +02:00
parent 13379321ba
commit bcdfdc97cf
433 changed files with 9582 additions and 7944 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>OpenJPEG: pi.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -16,9 +16,9 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.1.0</span>
&#160;<span id="projectnumber">2.1.2</span>
</div>
</td>
</tr>
@@ -26,7 +26,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -160,12 +160,12 @@
<div class="ttc" id="structopj__pi__comp_html"><div class="ttname"><a href="structopj__pi__comp.html">opj_pi_comp</a></div><div class="ttdoc">FIXME DOC. </div><div class="ttdef"><b>Definition:</b> pi.h:63</div></div>
<div class="ttc" id="structopj__pi__iterator_html_af7cc019f3bed44ee73bd284c20e4a1d6"><div class="ttname"><a href="structopj__pi__iterator.html#af7cc019f3bed44ee73bd284c20e4a1d6">opj_pi_iterator::step_c</a></div><div class="ttdeci">OPJ_UINT32 step_c</div><div class="ttdoc">component step used to localize the packet in the include vector </div><div class="ttdef"><b>Definition:</b> pi.h:83</div></div>
<div class="ttc" id="openjpeg_8h_html_a22de44e15bddae7edfacf4e9ac9bb199"><div class="ttname"><a href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a></div><div class="ttdeci">unsigned char OPJ_BYTE</div><div class="ttdef"><b>Definition:</b> openjpeg.h:117</div></div>
<div class="ttc" id="group___p_i_html_ga4990d0324eb594434bd7ef61d746ac46"><div class="ttname"><a href="group___p_i.html#ga4990d0324eb594434bd7ef61d746ac46">opj_pi_create_decode</a></div><div class="ttdeci">opj_pi_iterator_t * opj_pi_create_decode(opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno)</div><div class="ttdoc">Create a packet iterator for Decoder. </div><div class="ttdef"><b>Definition:</b> pi.c:1154</div></div>
<div class="ttc" id="group___p_i_html_ga4990d0324eb594434bd7ef61d746ac46"><div class="ttname"><a href="group___p_i.html#ga4990d0324eb594434bd7ef61d746ac46">opj_pi_create_decode</a></div><div class="ttdeci">opj_pi_iterator_t * opj_pi_create_decode(opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno)</div><div class="ttdoc">Create a packet iterator for Decoder. </div><div class="ttdef"><b>Definition:</b> pi.c:1155</div></div>
<div class="ttc" id="structopj__pi__comp_html_afde144f475239fca8b240eb321b06a0e"><div class="ttname"><a href="structopj__pi__comp.html#afde144f475239fca8b240eb321b06a0e">opj_pi_comp::dy</a></div><div class="ttdeci">OPJ_UINT32 dy</div><div class="ttdef"><b>Definition:</b> pi.h:64</div></div>
<div class="ttc" id="group___p_i_html_gaf3ba38306cb812def774ac9852bf11ef"><div class="ttname"><a href="group___p_i.html#gaf3ba38306cb812def774ac9852bf11ef">opj_pi_resolution_t</a></div><div class="ttdeci">struct opj_pi_resolution opj_pi_resolution_t</div><div class="ttdoc">FIXME DOC. </div></div>
<div class="ttc" id="openjpeg_8h_html_a3cec91ef9e73677f0dbd60d4e42401b9"><div class="ttname"><a href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a></div><div class="ttdeci">int32_t OPJ_INT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:125</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a45916c625862f62c288bb0b923c6bc09"><div class="ttname"><a href="structopj__pi__iterator.html#a45916c625862f62c288bb0b923c6bc09">opj_pi_iterator::compno</a></div><div class="ttdeci">OPJ_UINT32 compno</div><div class="ttdoc">component that identify the packet </div><div class="ttdef"><b>Definition:</b> pi.h:87</div></div>
<div class="ttc" id="structopj__pi__iterator_html_af4b012c07b514a9cebf0a98d9dadde5b"><div class="ttname"><a href="structopj__pi__iterator.html#af4b012c07b514a9cebf0a98d9dadde5b">opj_pi_iterator::include</a></div><div class="ttdeci">OPJ_INT16 * include</div><div class="ttdoc">precise if the packet has been already used (usefull for progression order change) ...</div><div class="ttdef"><b>Definition:</b> pi.h:77</div></div>
<div class="ttc" id="structopj__pi__iterator_html_af4b012c07b514a9cebf0a98d9dadde5b"><div class="ttname"><a href="structopj__pi__iterator.html#af4b012c07b514a9cebf0a98d9dadde5b">opj_pi_iterator::include</a></div><div class="ttdeci">OPJ_INT16 * include</div><div class="ttdoc">precise if the packet has been already used (useful for progression order change) ...</div><div class="ttdef"><b>Definition:</b> pi.h:77</div></div>
<div class="ttc" id="structopj__pi__iterator_html"><div class="ttname"><a href="structopj__pi__iterator.html">opj_pi_iterator</a></div><div class="ttdoc">Packet iterator. </div><div class="ttdef"><b>Definition:</b> pi.h:73</div></div>
<div class="ttc" id="structopj__pi__resolution_html_a757006b62ce5763a79218e06521b291a"><div class="ttname"><a href="structopj__pi__resolution.html#a757006b62ce5763a79218e06521b291a">opj_pi_resolution::pw</a></div><div class="ttdeci">OPJ_UINT32 pw</div><div class="ttdef"><b>Definition:</b> pi.h:57</div></div>
<div class="ttc" id="group___p_i_html_gaf5e0e4858311b5d80f5255c3607a55df"><div class="ttname"><a href="group___p_i.html#gaf5e0e4858311b5d80f5255c3607a55df">opj_pi_comp_t</a></div><div class="ttdeci">struct opj_pi_comp opj_pi_comp_t</div><div class="ttdoc">FIXME DOC. </div></div>
@@ -179,28 +179,28 @@
<div class="ttc" id="structopj__pi__resolution_html"><div class="ttname"><a href="structopj__pi__resolution.html">opj_pi_resolution</a></div><div class="ttdoc">FIXME DOC. </div><div class="ttdef"><b>Definition:</b> pi.h:55</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a0a499a8ac11788b43b10b96a3aff2b61"><div class="ttname"><a href="structopj__pi__iterator.html#a0a499a8ac11788b43b10b96a3aff2b61">opj_pi_iterator::ty1</a></div><div class="ttdeci">OPJ_INT32 ty1</div><div class="ttdef"><b>Definition:</b> pi.h:103</div></div>
<div class="ttc" id="structopj__pi__comp_html_a3bac028a20940396f5549f76b64f6c11"><div class="ttname"><a href="structopj__pi__comp.html#a3bac028a20940396f5549f76b64f6c11">opj_pi_comp::resolutions</a></div><div class="ttdeci">opj_pi_resolution_t * resolutions</div><div class="ttdef"><b>Definition:</b> pi.h:67</div></div>
<div class="ttc" id="group___p_i_html_ga638f17d6f40f88cd90d1cedbf95147f9"><div class="ttname"><a href="group___p_i.html#ga638f17d6f40f88cd90d1cedbf95147f9">opj_pi_next</a></div><div class="ttdeci">OPJ_BOOL opj_pi_next(opj_pi_iterator_t *pi)</div><div class="ttdoc">Modify the packet iterator to point to the next packet. </div><div class="ttdef"><b>Definition:</b> pi.c:1860</div></div>
<div class="ttc" id="group___p_i_html_ga638f17d6f40f88cd90d1cedbf95147f9"><div class="ttname"><a href="group___p_i.html#ga638f17d6f40f88cd90d1cedbf95147f9">opj_pi_next</a></div><div class="ttdeci">OPJ_BOOL opj_pi_next(opj_pi_iterator_t *pi)</div><div class="ttdoc">Modify the packet iterator to point to the next packet. </div><div class="ttdef"><b>Definition:</b> pi.c:1867</div></div>
<div class="ttc" id="structopj__pi__iterator_html_aa34b7693c844d5a57bca2f9e647985b8"><div class="ttname"><a href="structopj__pi__iterator.html#aa34b7693c844d5a57bca2f9e647985b8">opj_pi_iterator::step_r</a></div><div class="ttdeci">OPJ_UINT32 step_r</div><div class="ttdoc">resolution step used to localize the packet in the include vector </div><div class="ttdef"><b>Definition:</b> pi.h:81</div></div>
<div class="ttc" id="structopj__pi__resolution_html_a5b93e82e4d7d714c49961be846e78d3c"><div class="ttname"><a href="structopj__pi__resolution.html#a5b93e82e4d7d714c49961be846e78d3c">opj_pi_resolution::pdy</a></div><div class="ttdeci">OPJ_UINT32 pdy</div><div class="ttdef"><b>Definition:</b> pi.h:56</div></div>
<div class="ttc" id="structopj__pi__iterator_html_aa2779c18943ed9328a2417f7ede23707"><div class="ttname"><a href="structopj__pi__iterator.html#aa2779c18943ed9328a2417f7ede23707">opj_pi_iterator::tp_on</a></div><div class="ttdeci">OPJ_BYTE tp_on</div><div class="ttdoc">Enabling Tile part generation. </div><div class="ttdef"><b>Definition:</b> pi.h:75</div></div>
<div class="ttc" id="structopj__pi__iterator_html_af3bd59898a69a3958829c4d71c78718c"><div class="ttname"><a href="structopj__pi__iterator.html#af3bd59898a69a3958829c4d71c78718c">opj_pi_iterator::poc</a></div><div class="ttdeci">opj_poc_t poc</div><div class="ttdoc">progression order change information </div><div class="ttdef"><b>Definition:</b> pi.h:97</div></div>
<div class="ttc" id="structopj__pi__resolution_html_a6be1a672090a5b5108236b1899b78877"><div class="ttname"><a href="structopj__pi__resolution.html#a6be1a672090a5b5108236b1899b78877">opj_pi_resolution::pdx</a></div><div class="ttdeci">OPJ_UINT32 pdx</div><div class="ttdef"><b>Definition:</b> pi.h:56</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a1defc12dc22e1a514b956f43757964ff"><div class="ttname"><a href="structopj__pi__iterator.html#a1defc12dc22e1a514b956f43757964ff">opj_pi_iterator::tx1</a></div><div class="ttdeci">OPJ_INT32 tx1</div><div class="ttdef"><b>Definition:</b> pi.h:103</div></div>
<div class="ttc" id="structopj__cp_html"><div class="ttname"><a href="structopj__cp.html">opj_cp</a></div><div class="ttdoc">Coding parameters. </div><div class="ttdef"><b>Definition:</b> j2k.h:341</div></div>
<div class="ttc" id="structopj__cp_html"><div class="ttname"><a href="structopj__cp.html">opj_cp</a></div><div class="ttdoc">Coding parameters. </div><div class="ttdef"><b>Definition:</b> j2k.h:353</div></div>
<div class="ttc" id="openjpeg_8h_html_a5ec5f8a1adf71244e3315c1d10f1af16"><div class="ttname"><a href="openjpeg_8h.html#a5ec5f8a1adf71244e3315c1d10f1af16">OPJ_INT16</a></div><div class="ttdeci">int16_t OPJ_INT16</div><div class="ttdef"><b>Definition:</b> openjpeg.h:123</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a03a3850a338421f475d8440e4caa2411"><div class="ttname"><a href="structopj__pi__iterator.html#a03a3850a338421f475d8440e4caa2411">opj_pi_iterator::step_p</a></div><div class="ttdeci">OPJ_UINT32 step_p</div><div class="ttdoc">precinct step used to localize the packet in the include vector </div><div class="ttdef"><b>Definition:</b> pi.h:85</div></div>
<div class="ttc" id="group___p_i_html_ga36e3009320d25edd589dd5edff649723"><div class="ttname"><a href="group___p_i.html#ga36e3009320d25edd589dd5edff649723">opj_pi_iterator_t</a></div><div class="ttdeci">struct opj_pi_iterator opj_pi_iterator_t</div><div class="ttdoc">Packet iterator. </div></div>
<div class="ttc" id="structopj__pi__iterator_html_afb02b0f87fc58311f610b6f6e74130cd"><div class="ttname"><a href="structopj__pi__iterator.html#afb02b0f87fc58311f610b6f6e74130cd">opj_pi_iterator::layno</a></div><div class="ttdeci">OPJ_UINT32 layno</div><div class="ttdoc">layer that identify the packet </div><div class="ttdef"><b>Definition:</b> pi.h:93</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a748d6249047620409f4bcd13dd58f5fd"><div class="ttname"><a href="structopj__pi__iterator.html#a748d6249047620409f4bcd13dd58f5fd">opj_pi_iterator::dy</a></div><div class="ttdeci">OPJ_UINT32 dy</div><div class="ttdef"><b>Definition:</b> pi.h:107</div></div>
<div class="ttc" id="structopj__pi__resolution_html_acc5731d9e3ed9174780211086ef0263d"><div class="ttname"><a href="structopj__pi__resolution.html#acc5731d9e3ed9174780211086ef0263d">opj_pi_resolution::ph</a></div><div class="ttdeci">OPJ_UINT32 ph</div><div class="ttdef"><b>Definition:</b> pi.h:57</div></div>
<div class="ttc" id="group___p_i_html_ga2b305751720002ec7fd630d9c87d4dd4"><div class="ttname"><a href="group___p_i.html#ga2b305751720002ec7fd630d9c87d4dd4">opj_pi_destroy</a></div><div class="ttdeci">void opj_pi_destroy(opj_pi_iterator_t *p_pi, OPJ_UINT32 p_nb_elements)</div><div class="ttdoc">Destroys a packet iterator array. </div><div class="ttdef"><b>Definition:</b> pi.c:1797</div></div>
<div class="ttc" id="group___p_i_html_ga19c951dfab9ba88d65a9b78f32dd3397"><div class="ttname"><a href="group___p_i.html#ga19c951dfab9ba88d65a9b78f32dd3397">opj_pi_update_encoding_parameters</a></div><div class="ttdeci">void opj_pi_update_encoding_parameters(const opj_image_t *p_image, opj_cp_t *p_cp, OPJ_UINT32 p_tile_no)</div><div class="ttdoc">Updates the encoding parameters of the codec. </div><div class="ttdef"><b>Definition:</b> pi.c:1829</div></div>
<div class="ttc" id="group___p_i_html_ga2b305751720002ec7fd630d9c87d4dd4"><div class="ttname"><a href="group___p_i.html#ga2b305751720002ec7fd630d9c87d4dd4">opj_pi_destroy</a></div><div class="ttdeci">void opj_pi_destroy(opj_pi_iterator_t *p_pi, OPJ_UINT32 p_nb_elements)</div><div class="ttdoc">Destroys a packet iterator array. </div><div class="ttdef"><b>Definition:</b> pi.c:1804</div></div>
<div class="ttc" id="group___p_i_html_ga19c951dfab9ba88d65a9b78f32dd3397"><div class="ttname"><a href="group___p_i.html#ga19c951dfab9ba88d65a9b78f32dd3397">opj_pi_update_encoding_parameters</a></div><div class="ttdeci">void opj_pi_update_encoding_parameters(const opj_image_t *p_image, opj_cp_t *p_cp, OPJ_UINT32 p_tile_no)</div><div class="ttdoc">Updates the encoding parameters of the codec. </div><div class="ttdef"><b>Definition:</b> pi.c:1836</div></div>
<div class="ttc" id="openjpeg_8h_html_a4cb1e6e6b6ef2df499d5c02f7df54cbb"><div class="ttname"><a href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a></div><div class="ttdeci">uint32_t OPJ_UINT32</div><div class="ttdef"><b>Definition:</b> openjpeg.h:126</div></div>
<div class="ttc" id="structopj__pi__iterator_html_aa493636b53ff9297acdf5eb1ba307587"><div class="ttname"><a href="structopj__pi__iterator.html#aa493636b53ff9297acdf5eb1ba307587">opj_pi_iterator::tx0</a></div><div class="ttdeci">OPJ_INT32 tx0</div><div class="ttdoc">FIXME DOC. </div><div class="ttdef"><b>Definition:</b> pi.h:103</div></div>
<div class="ttc" id="structopj__pi__comp_html_a5cc0b5ea22fd1affb0f5875fc0fa7ba5"><div class="ttname"><a href="structopj__pi__comp.html#a5cc0b5ea22fd1affb0f5875fc0fa7ba5">opj_pi_comp::dx</a></div><div class="ttdeci">OPJ_UINT32 dx</div><div class="ttdef"><b>Definition:</b> pi.h:64</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a4606b1787e1a8ade8070419ff586fd28"><div class="ttname"><a href="structopj__pi__iterator.html#a4606b1787e1a8ade8070419ff586fd28">opj_pi_iterator::step_l</a></div><div class="ttdeci">OPJ_UINT32 step_l</div><div class="ttdoc">layer step used to localize the packet in the include vector </div><div class="ttdef"><b>Definition:</b> pi.h:79</div></div>
<div class="ttc" id="group___p_i_html_ga063e3300cc8f7553f0ea02652194409a"><div class="ttname"><a href="group___p_i.html#ga063e3300cc8f7553f0ea02652194409a">opj_pi_initialise_encode</a></div><div class="ttdeci">opj_pi_iterator_t * opj_pi_initialise_encode(const opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno, J2K_T2_MODE t2_mode)</div><div class="ttdoc">Creates a packet iterator for encoding. </div><div class="ttdef"><b>Definition:</b> pi.c:1354</div></div>
<div class="ttc" id="group___p_i_html_gacb01a23ef601a5e06c582c926c39a8e4"><div class="ttname"><a href="group___p_i.html#gacb01a23ef601a5e06c582c926c39a8e4">opj_pi_create_encode</a></div><div class="ttdeci">void opj_pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp, OPJ_UINT32 tileno, OPJ_UINT32 pino, OPJ_UINT32 tpnum, OPJ_INT32 tppos, J2K_T2_MODE t2_mode)</div><div class="ttdoc">Modify the packet iterator for enabling tile part generation. </div><div class="ttdef"><b>Definition:</b> pi.c:1539</div></div>
<div class="ttc" id="group___p_i_html_ga063e3300cc8f7553f0ea02652194409a"><div class="ttname"><a href="group___p_i.html#ga063e3300cc8f7553f0ea02652194409a">opj_pi_initialise_encode</a></div><div class="ttdeci">opj_pi_iterator_t * opj_pi_initialise_encode(const opj_image_t *image, opj_cp_t *cp, OPJ_UINT32 tileno, J2K_T2_MODE t2_mode)</div><div class="ttdoc">Creates a packet iterator for encoding. </div><div class="ttdef"><b>Definition:</b> pi.c:1361</div></div>
<div class="ttc" id="group___p_i_html_gacb01a23ef601a5e06c582c926c39a8e4"><div class="ttname"><a href="group___p_i.html#gacb01a23ef601a5e06c582c926c39a8e4">opj_pi_create_encode</a></div><div class="ttdeci">void opj_pi_create_encode(opj_pi_iterator_t *pi, opj_cp_t *cp, OPJ_UINT32 tileno, OPJ_UINT32 pino, OPJ_UINT32 tpnum, OPJ_INT32 tppos, J2K_T2_MODE t2_mode)</div><div class="ttdoc">Modify the packet iterator for enabling tile part generation. </div><div class="ttdef"><b>Definition:</b> pi.c:1546</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a0710e52be24bdc46ea106ebe889fd3fb"><div class="ttname"><a href="structopj__pi__iterator.html#a0710e52be24bdc46ea106ebe889fd3fb">opj_pi_iterator::dx</a></div><div class="ttdeci">OPJ_UINT32 dx</div><div class="ttdoc">FIXME DOC. </div><div class="ttdef"><b>Definition:</b> pi.h:107</div></div>
<div class="ttc" id="structopj__pi__iterator_html_a58b8941fe83af207cb9e4ebcad587106"><div class="ttname"><a href="structopj__pi__iterator.html#a58b8941fe83af207cb9e4ebcad587106">opj_pi_iterator::first</a></div><div class="ttdeci">OPJ_BOOL first</div><div class="ttdoc">0 if the first packet </div><div class="ttdef"><b>Definition:</b> pi.h:95</div></div>
</div><!-- fragment --></div><!-- contents -->
@@ -208,7 +208,7 @@
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</a> 1.8.10
</small></address>
</body>
</html>