Update Doxygen doc
[openjpeg.git] / doxygen / structopj__stream__private.html
index 18ec5579e18d39c2a2994ef766a1b16a7cd977f1..38651d075f607b41cdd52b3cd79378a8935a2b9f 100644 (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: opj_stream_private Struct Reference</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.2.0</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>
@@ -85,9 +85,9 @@ Data Fields</h2></td></tr>
 <tr class="memitem:a954a54c078a817c3eeffd66b45419cfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a954a54c078a817c3eeffd66b45419cfc">m_current_data</a></td></tr>
 <tr class="memdesc:a954a54c078a817c3eeffd66b45419cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the current read data.  <a href="#a954a54c078a817c3eeffd66b45419cfc">More...</a><br /></td></tr>
 <tr class="separator:a954a54c078a817c3eeffd66b45419cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a095bf5273c6d4b158917a9a4e8b17cec"><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="structopj__stream__private.html#a095bf5273c6d4b158917a9a4e8b17cec">m_opj_skip</a> )(struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td></tr>
-<tr class="memdesc:a095bf5273c6d4b158917a9a4e8b17cec"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a095bf5273c6d4b158917a9a4e8b17cec">More...</a><br /></td></tr>
-<tr class="separator:a095bf5273c6d4b158917a9a4e8b17cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a58aece1447be21b39fe61dfd8b8e41b1"><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="structopj__stream__private.html#a58aece1447be21b39fe61dfd8b8e41b1">m_opj_skip</a> )(struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td></tr>
+<tr class="memdesc:a58aece1447be21b39fe61dfd8b8e41b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a58aece1447be21b39fe61dfd8b8e41b1">More...</a><br /></td></tr>
+<tr class="separator:a58aece1447be21b39fe61dfd8b8e41b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0096c9def0e99114e0eabb73696aabd7"><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__stream__private.html#a0096c9def0e99114e0eabb73696aabd7">m_opj_seek</a> )(struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td></tr>
 <tr class="memdesc:a0096c9def0e99114e0eabb73696aabd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a0096c9def0e99114e0eabb73696aabd7">More...</a><br /></td></tr>
 <tr class="separator:a0096c9def0e99114e0eabb73696aabd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -100,9 +100,9 @@ Data Fields</h2></td></tr>
 <tr class="memitem:a83e54b51fe859e0aa93ebf292edf054c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a83e54b51fe859e0aa93ebf292edf054c">m_buffer_size</a></td></tr>
 <tr class="memdesc:a83e54b51fe859e0aa93ebf292edf054c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the buffer.  <a href="#a83e54b51fe859e0aa93ebf292edf054c">More...</a><br /></td></tr>
 <tr class="separator:a83e54b51fe859e0aa93ebf292edf054c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a9488c15c3afa92847241963bdfa3a23e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___c_i_o.html#gacb8593353309d7ddf9b4ef81ad2a13ec">opj_stream_flag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a9488c15c3afa92847241963bdfa3a23e">m_status</a></td></tr>
-<tr class="memdesc:a9488c15c3afa92847241963bdfa3a23e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags to tell the status of the stream.  <a href="#a9488c15c3afa92847241963bdfa3a23e">More...</a><br /></td></tr>
-<tr class="separator:a9488c15c3afa92847241963bdfa3a23e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac2b84e72997fde0bf510faf6c8df5798"><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__stream__private.html#ac2b84e72997fde0bf510faf6c8df5798">m_status</a></td></tr>
+<tr class="memdesc:ac2b84e72997fde0bf510faf6c8df5798"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags to tell the status of the stream.  <a href="#ac2b84e72997fde0bf510faf6c8df5798">More...</a><br /></td></tr>
+<tr class="separator:ac2b84e72997fde0bf510faf6c8df5798"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Byte input-output stream. </p>
@@ -204,12 +204,12 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a095bf5273c6d4b158917a9a4e8b17cec"></a>
+<a class="anchor" id="a58aece1447be21b39fe61dfd8b8e41b1"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>(*  opj_stream_private::m_opj_skip) (struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *,<a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td>
+          <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>(*  opj_stream_private::m_opj_skip) (struct <a class="el" href="structopj__stream__private.html">opj_stream_private</a> *, <a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>, struct <a class="el" href="structopj__event__mgr.html">opj_event_mgr</a> *)</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -269,17 +269,18 @@ Data Fields</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a9488c15c3afa92847241963bdfa3a23e"></a>
+<a class="anchor" id="ac2b84e72997fde0bf510faf6c8df5798"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname"><a class="el" href="group___c_i_o.html#gacb8593353309d7ddf9b4ef81ad2a13ec">opj_stream_flag</a> opj_stream_private::m_status</td>
+          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_stream_private::m_status</td>
         </tr>
       </table>
 </div><div class="memdoc">
 
 <p>Flags to tell the status of the stream. </p>
+<p>Used with OPJ_STREAM_STATUS_* defines. </p>
 
 <p>Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="group___c_i_o.html#ga3cb2e53726d5dde5a5f97f64a9e5f42d">opj_stream_flush()</a>, <a class="el" href="group___c_i_o.html#ga6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, <a class="el" href="group___c_i_o.html#ga7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="group___c_i_o.html#ga092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="openjpeg_8h.html#a32646f57f2e8450e57165d085dadb8c8">opj_stream_set_read_function()</a>, <a class="el" href="openjpeg_8h.html#a5d196d304c431d2c1d462397976aa763">opj_stream_set_write_function()</a>, <a class="el" href="group___c_i_o.html#ga8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, <a class="el" href="group___c_i_o.html#gaa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>, and <a class="el" href="group___c_i_o.html#ga9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
 
@@ -331,7 +332,7 @@ Data Fields</h2></td></tr>
 
 <p>User data length. </p>
 
-<p>Referenced by <a class="el" href="group___c_i_o.html#gaec7225a845169469fd1aa8db2a3fac9e">opj_stream_get_number_byte_left()</a>, and <a class="el" href="openjpeg_8h.html#a2845fa5ff8031ef4a0b46314a19c0dc5">opj_stream_set_user_data_length()</a>.</p>
+<p>Referenced by <a class="el" href="group___c_i_o.html#gaec7225a845169469fd1aa8db2a3fac9e">opj_stream_get_number_byte_left()</a>, <a class="el" href="group___c_i_o.html#ga092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, and <a class="el" href="openjpeg_8h.html#a2845fa5ff8031ef4a0b46314a19c0dc5">opj_stream_set_user_data_length()</a>.</p>
 
 </div>
 </div>
@@ -359,7 +360,7 @@ Data Fields</h2></td></tr>
 <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>