Update Doxygen doc
[openjpeg.git] / doxygen / structopj__j2k__dec.html
index 2aec49dc009270d43b464cc2266767694781f8e6..b8dbdbf1472f7c7b0eff5252f0b8cb4bb76cc4b7 100644 (file)
@@ -18,7 +18,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">OpenJPEG
-   &#160;<span id="projectnumber">2.1.2</span>
+   &#160;<span id="projectnumber">2.2.0</span>
    </div>
   </td>
  </tr>
@@ -77,15 +77,6 @@ Data Fields</h2></td></tr>
 <tr class="separator:a2be5cc1c793db092012c29b1b54d4658"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae62e78d25e3e5d51f99c3776c10800e2"><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__j2k__dec.html#ae62e78d25e3e5d51f99c3776c10800e2">m_end_tile_y</a></td></tr>
 <tr class="separator:ae62e78d25e3e5d51f99c3776c10800e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a4720a912a76ee6913a2422d8244bd185"><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__j2k__dec.html#a4720a912a76ee6913a2422d8244bd185">m_DA_x0</a></td></tr>
-<tr class="memdesc:a4720a912a76ee6913a2422d8244bd185"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decoded area set by the user.  <a href="#a4720a912a76ee6913a2422d8244bd185">More...</a><br /></td></tr>
-<tr class="separator:a4720a912a76ee6913a2422d8244bd185"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a30a551a4504b13b97958484ce0d8b2ae"><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__j2k__dec.html#a30a551a4504b13b97958484ce0d8b2ae">m_DA_y0</a></td></tr>
-<tr class="separator:a30a551a4504b13b97958484ce0d8b2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad3a98e47c9ac6618cd0abca657fd57a0"><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__j2k__dec.html#ad3a98e47c9ac6618cd0abca657fd57a0">m_DA_x1</a></td></tr>
-<tr class="separator:ad3a98e47c9ac6618cd0abca657fd57a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a183ce4302671a373321a34495e7e1ff6"><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__j2k__dec.html#a183ce4302671a373321a34495e7e1ff6">m_DA_y1</a></td></tr>
-<tr class="separator:a183ce4302671a373321a34495e7e1ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0968cf3e09590018e3d71de12cbe452f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a0968cf3e09590018e3d71de12cbe452f">m_tile_ind_to_dec</a></td></tr>
 <tr class="memdesc:a0968cf3e09590018e3d71de12cbe452f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of the tile to decode (used in get_tile)  <a href="#a0968cf3e09590018e3d71de12cbe452f">More...</a><br /></td></tr>
 <tr class="separator:a0968cf3e09590018e3d71de12cbe452f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -95,26 +86,26 @@ Data Fields</h2></td></tr>
 <tr class="memitem:a8fc81bd32a851db5f36ed9836872b9dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a8fc81bd32a851db5f36ed9836872b9dc">m_last_tile_part</a></td></tr>
 <tr class="memdesc:a8fc81bd32a851db5f36ed9836872b9dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the current tile-part is assume as the last tile part of the codestream.  <a href="#a8fc81bd32a851db5f36ed9836872b9dc">More...</a><br /></td></tr>
 <tr class="separator:a8fc81bd32a851db5f36ed9836872b9dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a8fb0937cbc5c1a25aa279189ed6d1c88"><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__j2k__dec.html#a8fb0937cbc5c1a25aa279189ed6d1c88">m_can_decode</a>: 1</td></tr>
-<tr class="memdesc:a8fb0937cbc5c1a25aa279189ed6d1c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">to tell that a tile can be decoded.  <a href="#a8fb0937cbc5c1a25aa279189ed6d1c88">More...</a><br /></td></tr>
-<tr class="separator:a8fb0937cbc5c1a25aa279189ed6d1c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aab16872be57e3d63771a046e49fbc294"><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__j2k__dec.html#aab16872be57e3d63771a046e49fbc294">m_discard_tiles</a>: 1</td></tr>
-<tr class="separator:aab16872be57e3d63771a046e49fbc294"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae963a4b650887f400d15d759451a313b"><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__j2k__dec.html#ae963a4b650887f400d15d759451a313b">m_skip_data</a>: 1</td></tr>
-<tr class="separator:ae963a4b650887f400d15d759451a313b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ac154972436ea6d3fd8d7172155dbf3eb"><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__j2k__dec.html#ac154972436ea6d3fd8d7172155dbf3eb">m_nb_tile_parts_correction_checked</a>: 1</td></tr>
-<tr class="memdesc:ac154972436ea6d3fd8d7172155dbf3eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">TNsot correction : see issue 254.  <a href="#ac154972436ea6d3fd8d7172155dbf3eb">More...</a><br /></td></tr>
-<tr class="separator:ac154972436ea6d3fd8d7172155dbf3eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a3044870037b7abe7c19b724723df05f4"><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__j2k__dec.html#a3044870037b7abe7c19b724723df05f4">m_nb_tile_parts_correction</a>: 1</td></tr>
-<tr class="separator:a3044870037b7abe7c19b724723df05f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5641f21bf71dd0f8dec11ae2fc0b0f88"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a5641f21bf71dd0f8dec11ae2fc0b0f88">m_can_decode</a>: 1</td></tr>
+<tr class="memdesc:a5641f21bf71dd0f8dec11ae2fc0b0f88"><td class="mdescLeft">&#160;</td><td class="mdescRight">to tell that a tile can be decoded.  <a href="#a5641f21bf71dd0f8dec11ae2fc0b0f88">More...</a><br /></td></tr>
+<tr class="separator:a5641f21bf71dd0f8dec11ae2fc0b0f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a397741827fe4f66747279c4cbdb68e2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a397741827fe4f66747279c4cbdb68e2b">m_discard_tiles</a>: 1</td></tr>
+<tr class="separator:a397741827fe4f66747279c4cbdb68e2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6c4ba04312456a9c98e7472401f38c3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a6c4ba04312456a9c98e7472401f38c3a">m_skip_data</a>: 1</td></tr>
+<tr class="separator:a6c4ba04312456a9c98e7472401f38c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a377fad1cd433ddb5aaa720cb4558e4d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a377fad1cd433ddb5aaa720cb4558e4d1">m_nb_tile_parts_correction_checked</a>: 1</td></tr>
+<tr class="memdesc:a377fad1cd433ddb5aaa720cb4558e4d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">TNsot correction : see issue 254.  <a href="#a377fad1cd433ddb5aaa720cb4558e4d1">More...</a><br /></td></tr>
+<tr class="separator:a377fad1cd433ddb5aaa720cb4558e4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a86792baeaa39c5ffb0c52c18564bdbea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__j2k__dec.html#a86792baeaa39c5ffb0c52c18564bdbea">m_nb_tile_parts_correction</a>: 1</td></tr>
+<tr class="separator:a86792baeaa39c5ffb0c52c18564bdbea"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Field Documentation</h2>
-<a class="anchor" id="a8fb0937cbc5c1a25aa279189ed6d1c88"></a>
+<a class="anchor" id="a5641f21bf71dd0f8dec11ae2fc0b0f88"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_can_decode</td>
+          <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_j2k_dec::m_can_decode</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -123,56 +114,6 @@ Data Fields</h2></td></tr>
 
 <p>Referenced by <a class="el" href="j2k_8h.html#a589edf58bf96de0a09b6104b6f5c13e8">opj_j2k_decode_tile()</a>, <a class="el" href="group___j2_k.html#ga935e4014c63e07bf19ad99584f6de430">opj_j2k_read_sot()</a>, and <a class="el" href="j2k_8h.html#a25b7b51949ceea33515984f1db2f594d">opj_j2k_read_tile_header()</a>.</p>
 
-</div>
-</div>
-<a class="anchor" id="a4720a912a76ee6913a2422d8244bd185"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_DA_x0</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Decoded area set by the user. </p>
-
-</div>
-</div>
-<a class="anchor" id="ad3a98e47c9ac6618cd0abca657fd57a0"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_DA_x1</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-</div>
-</div>
-<a class="anchor" id="a30a551a4504b13b97958484ce0d8b2ae"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_DA_y0</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-</div>
-</div>
-<a class="anchor" id="a183ce4302671a373321a34495e7e1ff6"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_DA_y1</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
 </div>
 </div>
 <a class="anchor" id="a9a7e4b2c704998e94e19abc5259210e2"></a>
@@ -191,12 +132,12 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="aab16872be57e3d63771a046e49fbc294"></a>
+<a class="anchor" id="a397741827fe4f66747279c4cbdb68e2b"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_discard_tiles</td>
+          <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_j2k_dec::m_discard_tiles</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -294,12 +235,12 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a3044870037b7abe7c19b724723df05f4"></a>
+<a class="anchor" id="a86792baeaa39c5ffb0c52c18564bdbea"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_nb_tile_parts_correction</td>
+          <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_j2k_dec::m_nb_tile_parts_correction</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -308,12 +249,12 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="ac154972436ea6d3fd8d7172155dbf3eb"></a>
+<a class="anchor" id="a377fad1cd433ddb5aaa720cb4558e4d1"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_nb_tile_parts_correction_checked</td>
+          <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_j2k_dec::m_nb_tile_parts_correction_checked</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -324,12 +265,12 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="ae963a4b650887f400d15d759451a313b"></a>
+<a class="anchor" id="a6c4ba04312456a9c98e7472401f38c3a"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_j2k_dec::m_skip_data</td>
+          <td class="memname"><a class="el" href="opj__includes_8h.html#ae64d2795e8dbcd9ff6d8e1ebd904ce80">OPJ_BITFIELD</a> opj_j2k_dec::m_skip_data</td>
         </tr>
       </table>
 </div><div class="memdoc">