Update ABI/API compatibility reports after commit 4e5501b3c72a98b3117e68263afb922092c...
[openjpeg.git] / doxygen / structopj__stream__private.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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: opj_stream_private Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <div class="title">opj_stream_private Struct Reference<div class="ingroups"><a class="el" href="group___c_i_o.html">CIO - byte input-output stream</a></div></div>  </div>
45 </div><!--header-->
46 <div class="contents">
47
48 <p>Byte input-output stream.  
49  <a href="structopj__stream__private.html#details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="cio_8h_source.html">cio.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <tr class="memitem:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a326f2fe5dc1fccce2788bf09ddf4931c">m_user_data</a></td></tr>
56 <tr class="memdesc:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data, be it files, ...  <a href="#a326f2fe5dc1fccce2788bf09ddf4931c">More...</a><br /></td></tr>
57 <tr class="separator:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:a262bea0d39f7c5a0bd5ef07434e38723"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#adea98a88378b8bf7f1654ca7511808ce">opj_stream_free_user_data_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a262bea0d39f7c5a0bd5ef07434e38723">m_free_user_data_fn</a></td></tr>
59 <tr class="memdesc:a262bea0d39f7c5a0bd5ef07434e38723"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to function to free m_user_data (NULL at initialization) when destroying the stream.  <a href="#a262bea0d39f7c5a0bd5ef07434e38723">More...</a><br /></td></tr>
60 <tr class="separator:a262bea0d39f7c5a0bd5ef07434e38723"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <tr class="memitem:a53cb7b3992a382231554bdc73cb0c7bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a53cb7b3992a382231554bdc73cb0c7bd">m_user_data_length</a></td></tr>
62 <tr class="memdesc:a53cb7b3992a382231554bdc73cb0c7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data length.  <a href="#a53cb7b3992a382231554bdc73cb0c7bd">More...</a><br /></td></tr>
63 <tr class="separator:a53cb7b3992a382231554bdc73cb0c7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:acce2d2187feff70fa3057b0439591f76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#aa2eb8272b84be8503bafa20075b4a943">opj_stream_read_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#acce2d2187feff70fa3057b0439591f76">m_read_fn</a></td></tr>
65 <tr class="memdesc:acce2d2187feff70fa3057b0439591f76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual read function (NULL at the initialization of the cio.  <a href="#acce2d2187feff70fa3057b0439591f76">More...</a><br /></td></tr>
66 <tr class="separator:acce2d2187feff70fa3057b0439591f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a087a324f17cc02a95526b41b7636b580">opj_stream_write_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#aacd57b4e429ddf5ca3a4913a2f963d6a">m_write_fn</a></td></tr>
68 <tr class="memdesc:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual write function (NULL at the initialization of the cio.  <a href="#aacd57b4e429ddf5ca3a4913a2f963d6a">More...</a><br /></td></tr>
69 <tr class="separator:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:a2ca719761a9cd88dc350486e38b41790"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5a5da112c449f1aafb5823f7a04d0b3b">opj_stream_skip_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#a2ca719761a9cd88dc350486e38b41790">m_skip_fn</a></td></tr>
71 <tr class="memdesc:a2ca719761a9cd88dc350486e38b41790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual skip function (NULL at the initialization of the cio.  <a href="#a2ca719761a9cd88dc350486e38b41790">More...</a><br /></td></tr>
72 <tr class="separator:a2ca719761a9cd88dc350486e38b41790"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:adab26f9f0a32253aefdce763331c641a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a6b85fe2ce4d609d2262afad0c7a7f31e">opj_stream_seek_fn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__stream__private.html#adab26f9f0a32253aefdce763331c641a">m_seek_fn</a></td></tr>
74 <tr class="memdesc:adab26f9f0a32253aefdce763331c641a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to actual seek function (if available).  <a href="#adab26f9f0a32253aefdce763331c641a">More...</a><br /></td></tr>
75 <tr class="separator:adab26f9f0a32253aefdce763331c641a"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:aca072a59b683dc106263ba04d3c28577"><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#aca072a59b683dc106263ba04d3c28577">m_stored_data</a></td></tr>
77 <tr class="memdesc:aca072a59b683dc106263ba04d3c28577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Actual data stored into the stream if readed from.  <a href="#aca072a59b683dc106263ba04d3c28577">More...</a><br /></td></tr>
78 <tr class="separator:aca072a59b683dc106263ba04d3c28577"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <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>
80 <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>
81 <tr class="separator:a954a54c078a817c3eeffd66b45419cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <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>
83 <tr class="memdesc:a58aece1447be21b39fe61dfd8b8e41b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a58aece1447be21b39fe61dfd8b8e41b1">More...</a><br /></td></tr>
84 <tr class="separator:a58aece1447be21b39fe61dfd8b8e41b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <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>
86 <tr class="memdesc:a0096c9def0e99114e0eabb73696aabd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a0096c9def0e99114e0eabb73696aabd7">More...</a><br /></td></tr>
87 <tr class="separator:a0096c9def0e99114e0eabb73696aabd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a8bbf688a608e52a52d1cf89c7103ac5b"><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#a8bbf688a608e52a52d1cf89c7103ac5b">m_bytes_in_buffer</a></td></tr>
89 <tr class="memdesc:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bytes containing in the buffer.  <a href="#a8bbf688a608e52a52d1cf89c7103ac5b">More...</a><br /></td></tr>
90 <tr class="separator:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:a5c0c669ab30776a58afc458b7f33a75b"><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#a5c0c669ab30776a58afc458b7f33a75b">m_byte_offset</a></td></tr>
92 <tr class="memdesc:a5c0c669ab30776a58afc458b7f33a75b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of bytes read/written from the beginning of the stream.  <a href="#a5c0c669ab30776a58afc458b7f33a75b">More...</a><br /></td></tr>
93 <tr class="separator:a5c0c669ab30776a58afc458b7f33a75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <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>
95 <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>
96 <tr class="separator:a83e54b51fe859e0aa93ebf292edf054c"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <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>
98 <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>
99 <tr class="separator:ac2b84e72997fde0bf510faf6c8df5798"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 </table>
101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
102 <div class="textblock"><p>Byte input-output stream. </p>
103 </div><h2 class="groupheader">Field Documentation</h2>
104 <a id="a83e54b51fe859e0aa93ebf292edf054c"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#a83e54b51fe859e0aa93ebf292edf054c">&#9670;&nbsp;</a></span>m_buffer_size</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109       <table class="memname">
110         <tr>
111           <td class="memname"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> opj_stream_private::m_buffer_size</td>
112         </tr>
113       </table>
114 </div><div class="memdoc">
115
116 <p>The size of the buffer. </p>
117
118 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="group___c_i_o.html#ga6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, and <a class="el" href="group___c_i_o.html#ga8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>.</p>
119
120 </div>
121 </div>
122 <a id="a5c0c669ab30776a58afc458b7f33a75b"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#a5c0c669ab30776a58afc458b7f33a75b">&#9670;&nbsp;</a></span>m_byte_offset</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_stream_private::m_byte_offset</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p>The number of bytes read/written from the beginning of the stream. </p>
135
136 <p class="reference">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#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="group___c_i_o.html#ga5c59a39f3664f9deb654c269153c600a">opj_stream_tell()</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>
137
138 </div>
139 </div>
140 <a id="a8bbf688a608e52a52d1cf89c7103ac5b"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#a8bbf688a608e52a52d1cf89c7103ac5b">&#9670;&nbsp;</a></span>m_bytes_in_buffer</h2>
142
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> opj_stream_private::m_bytes_in_buffer</td>
148         </tr>
149       </table>
150 </div><div class="memdoc">
151
152 <p>number of bytes containing in the buffer. </p>
153
154 <p class="reference">Referenced by <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="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>
155
156 </div>
157 </div>
158 <a id="a954a54c078a817c3eeffd66b45419cfc"></a>
159 <h2 class="memtitle"><span class="permalink"><a href="#a954a54c078a817c3eeffd66b45419cfc">&#9670;&nbsp;</a></span>m_current_data</h2>
160
161 <div class="memitem">
162 <div class="memproto">
163       <table class="memname">
164         <tr>
165           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_current_data</td>
166         </tr>
167       </table>
168 </div><div class="memdoc">
169
170 <p>Pointer to the current read data. </p>
171
172 <p class="reference">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="group___c_i_o.html#ga8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, and <a class="el" href="group___c_i_o.html#gaa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
173
174 </div>
175 </div>
176 <a id="a262bea0d39f7c5a0bd5ef07434e38723"></a>
177 <h2 class="memtitle"><span class="permalink"><a href="#a262bea0d39f7c5a0bd5ef07434e38723">&#9670;&nbsp;</a></span>m_free_user_data_fn</h2>
178
179 <div class="memitem">
180 <div class="memproto">
181       <table class="memname">
182         <tr>
183           <td class="memname"><a class="el" href="openjpeg_8h.html#adea98a88378b8bf7f1654ca7511808ce">opj_stream_free_user_data_fn</a> opj_stream_private::m_free_user_data_fn</td>
184         </tr>
185       </table>
186 </div><div class="memdoc">
187
188 <p>Pointer to function to free m_user_data (NULL at initialization) when destroying the stream. </p>
189 <p>If pointer is NULL the function is not called and the m_user_data is not freed (even if non-NULL). </p>
190
191 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</a>, and <a class="el" href="openjpeg_8h.html#a6cd79f0336b039391ffd67cddca0ac67">opj_stream_set_user_data()</a>.</p>
192
193 </div>
194 </div>
195 <a id="a0096c9def0e99114e0eabb73696aabd7"></a>
196 <h2 class="memtitle"><span class="permalink"><a href="#a0096c9def0e99114e0eabb73696aabd7">&#9670;&nbsp;</a></span>m_opj_seek</h2>
197
198 <div class="memitem">
199 <div class="memproto">
200       <table class="memname">
201         <tr>
202           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>(*  opj_stream_private::m_opj_seek) (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>
203         </tr>
204       </table>
205 </div><div class="memdoc">
206
207 <p>FIXME DOC. </p>
208
209 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, and <a class="el" href="group___c_i_o.html#ga9061d0624a17af80b74e1a114b0c7f06">opj_stream_seek()</a>.</p>
210
211 </div>
212 </div>
213 <a id="a58aece1447be21b39fe61dfd8b8e41b1"></a>
214 <h2 class="memtitle"><span class="permalink"><a href="#a58aece1447be21b39fe61dfd8b8e41b1">&#9670;&nbsp;</a></span>m_opj_skip</h2>
215
216 <div class="memitem">
217 <div class="memproto">
218       <table class="memname">
219         <tr>
220           <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>
221         </tr>
222       </table>
223 </div><div class="memdoc">
224
225 <p>FIXME DOC. </p>
226
227 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, and <a class="el" href="group___c_i_o.html#ga8a8ab9c9e1ccdc20a6dd2a2925a3f8c0">opj_stream_skip()</a>.</p>
228
229 </div>
230 </div>
231 <a id="acce2d2187feff70fa3057b0439591f76"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#acce2d2187feff70fa3057b0439591f76">&#9670;&nbsp;</a></span>m_read_fn</h2>
233
234 <div class="memitem">
235 <div class="memproto">
236       <table class="memname">
237         <tr>
238           <td class="memname"><a class="el" href="openjpeg_8h.html#aa2eb8272b84be8503bafa20075b4a943">opj_stream_read_fn</a> opj_stream_private::m_read_fn</td>
239         </tr>
240       </table>
241 </div><div class="memdoc">
242
243 <p>Pointer to actual read function (NULL at the initialization of the cio. </p>
244
245 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="group___c_i_o.html#ga6102b5a73d4a0235e9cfa65d92a623dc">opj_stream_read_data()</a>, and <a class="el" href="openjpeg_8h.html#a32646f57f2e8450e57165d085dadb8c8">opj_stream_set_read_function()</a>.</p>
246
247 </div>
248 </div>
249 <a id="adab26f9f0a32253aefdce763331c641a"></a>
250 <h2 class="memtitle"><span class="permalink"><a href="#adab26f9f0a32253aefdce763331c641a">&#9670;&nbsp;</a></span>m_seek_fn</h2>
251
252 <div class="memitem">
253 <div class="memproto">
254       <table class="memname">
255         <tr>
256           <td class="memname"><a class="el" href="openjpeg_8h.html#a6b85fe2ce4d609d2262afad0c7a7f31e">opj_stream_seek_fn</a> opj_stream_private::m_seek_fn</td>
257         </tr>
258       </table>
259 </div><div class="memdoc">
260
261 <p>Pointer to actual seek function (if available). </p>
262
263 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="group___c_i_o.html#gae456419611db729983d8ca337e3f3293">opj_stream_has_seek()</a>, <a class="el" href="group___c_i_o.html#ga7dc74eec9e8e6227d485ef36396c57d8">opj_stream_read_seek()</a>, <a class="el" href="openjpeg_8h.html#abad6efc7d4b7a75b2223bef8a444ccb4">opj_stream_set_seek_function()</a>, and <a class="el" href="group___c_i_o.html#gaa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
264
265 </div>
266 </div>
267 <a id="a2ca719761a9cd88dc350486e38b41790"></a>
268 <h2 class="memtitle"><span class="permalink"><a href="#a2ca719761a9cd88dc350486e38b41790">&#9670;&nbsp;</a></span>m_skip_fn</h2>
269
270 <div class="memitem">
271 <div class="memproto">
272       <table class="memname">
273         <tr>
274           <td class="memname"><a class="el" href="openjpeg_8h.html#a5a5da112c449f1aafb5823f7a04d0b3b">opj_stream_skip_fn</a> opj_stream_private::m_skip_fn</td>
275         </tr>
276       </table>
277 </div><div class="memdoc">
278
279 <p>Pointer to actual skip function (NULL at the initialization of the cio. </p>
280 <p>There is no seek function to prevent from back and forth slow procedures. </p>
281
282 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="group___c_i_o.html#ga092c8153f29a4137728c6d79165c7e51">opj_stream_read_skip()</a>, <a class="el" href="openjpeg_8h.html#aecb87205464e2f2e90e4a2458f0bbcd5">opj_stream_set_skip_function()</a>, and <a class="el" href="group___c_i_o.html#ga9e71a30be5af724e31c50066b7ff1128">opj_stream_write_skip()</a>.</p>
283
284 </div>
285 </div>
286 <a id="ac2b84e72997fde0bf510faf6c8df5798"></a>
287 <h2 class="memtitle"><span class="permalink"><a href="#ac2b84e72997fde0bf510faf6c8df5798">&#9670;&nbsp;</a></span>m_status</h2>
288
289 <div class="memitem">
290 <div class="memproto">
291       <table class="memname">
292         <tr>
293           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_stream_private::m_status</td>
294         </tr>
295       </table>
296 </div><div class="memdoc">
297
298 <p>Flags to tell the status of the stream. </p>
299 <p>Used with OPJ_STREAM_STATUS_* defines. </p>
300
301 <p class="reference">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>
302
303 </div>
304 </div>
305 <a id="aca072a59b683dc106263ba04d3c28577"></a>
306 <h2 class="memtitle"><span class="permalink"><a href="#aca072a59b683dc106263ba04d3c28577">&#9670;&nbsp;</a></span>m_stored_data</h2>
307
308 <div class="memitem">
309 <div class="memproto">
310       <table class="memname">
311         <tr>
312           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_stored_data</td>
313         </tr>
314       </table>
315 </div><div class="memdoc">
316
317 <p>Actual data stored into the stream if readed from. </p>
318 <p>Data is read by chunk of fixed size. you should never access this data directly. </p>
319
320 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a5ceb2a40ddd3b69cdc183e1373257091">opj_stream_create()</a>, <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</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="group___c_i_o.html#ga8f590493a14f4e33a1e2bbcf8eaa889d">opj_stream_write_data()</a>, and <a class="el" href="group___c_i_o.html#gaa87066c3ad9c71a3b2e7725d111188b9">opj_stream_write_seek()</a>.</p>
321
322 </div>
323 </div>
324 <a id="a326f2fe5dc1fccce2788bf09ddf4931c"></a>
325 <h2 class="memtitle"><span class="permalink"><a href="#a326f2fe5dc1fccce2788bf09ddf4931c">&#9670;&nbsp;</a></span>m_user_data</h2>
326
327 <div class="memitem">
328 <div class="memproto">
329       <table class="memname">
330         <tr>
331           <td class="memname">void* opj_stream_private::m_user_data</td>
332         </tr>
333       </table>
334 </div><div class="memdoc">
335
336 <p>User data, be it files, ... </p>
337 <p>The actual data depends on the type of the stream. </p>
338
339 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#a0703208df785be60460eb83c5d40b10f">opj_stream_destroy()</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#a6cd79f0336b039391ffd67cddca0ac67">opj_stream_set_user_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>
340
341 </div>
342 </div>
343 <a id="a53cb7b3992a382231554bdc73cb0c7bd"></a>
344 <h2 class="memtitle"><span class="permalink"><a href="#a53cb7b3992a382231554bdc73cb0c7bd">&#9670;&nbsp;</a></span>m_user_data_length</h2>
345
346 <div class="memitem">
347 <div class="memproto">
348       <table class="memname">
349         <tr>
350           <td class="memname"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a> opj_stream_private::m_user_data_length</td>
351         </tr>
352       </table>
353 </div><div class="memdoc">
354
355 <p>User data length. </p>
356
357 <p class="reference">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>
358
359 </div>
360 </div>
361 <a id="aacd57b4e429ddf5ca3a4913a2f963d6a"></a>
362 <h2 class="memtitle"><span class="permalink"><a href="#aacd57b4e429ddf5ca3a4913a2f963d6a">&#9670;&nbsp;</a></span>m_write_fn</h2>
363
364 <div class="memitem">
365 <div class="memproto">
366       <table class="memname">
367         <tr>
368           <td class="memname"><a class="el" href="openjpeg_8h.html#a087a324f17cc02a95526b41b7636b580">opj_stream_write_fn</a> opj_stream_private::m_write_fn</td>
369         </tr>
370       </table>
371 </div><div class="memdoc">
372
373 <p>Pointer to actual write function (NULL at the initialization of the cio. </p>
374
375 <p class="reference">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>, and <a class="el" href="openjpeg_8h.html#a5d196d304c431d2c1d462397976aa763">opj_stream_set_write_function()</a>.</p>
376
377 </div>
378 </div>
379 <hr/>The documentation for this struct was generated from the following file:<ul>
380 <li><a class="el" href="cio_8h_source.html">cio.h</a></li>
381 </ul>
382 </div><!-- contents -->
383 <!-- start footer part -->
384 <hr class="footer"/><address class="footer"><small>
385 Generated by &#160;<a href="http://www.doxygen.org/index.html">
386 <img class="footer" src="doxygen.png" alt="doxygen"/>
387 </a> 1.8.13
388 </small></address>
389 </body>
390 </html>