Update Doxygen doc
[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.10"/>
7 <title>OpenJPEG: opj_stream_private 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_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>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Byte input-output stream.  
55  <a href="structopj__stream__private.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="cio_8h_source.html">cio.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: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>
62 <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>
63 <tr class="separator:a326f2fe5dc1fccce2788bf09ddf4931c"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <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>
66 <tr class="separator:a262bea0d39f7c5a0bd5ef07434e38723"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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>
68 <tr class="memdesc:a53cb7b3992a382231554bdc73cb0c7bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data length.  <a href="#a53cb7b3992a382231554bdc73cb0c7bd">More...</a><br /></td></tr>
69 <tr class="separator:a53cb7b3992a382231554bdc73cb0c7bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <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>
71 <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>
72 <tr class="separator:acce2d2187feff70fa3057b0439591f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <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>
74 <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>
75 <tr class="separator:aacd57b4e429ddf5ca3a4913a2f963d6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <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>
77 <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>
78 <tr class="separator:a2ca719761a9cd88dc350486e38b41790"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <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>
80 <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>
81 <tr class="separator:adab26f9f0a32253aefdce763331c641a"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <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>
83 <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>
84 <tr class="separator:aca072a59b683dc106263ba04d3c28577"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <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>
86 <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>
87 <tr class="separator:a954a54c078a817c3eeffd66b45419cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <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>
89 <tr class="memdesc:a58aece1447be21b39fe61dfd8b8e41b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a58aece1447be21b39fe61dfd8b8e41b1">More...</a><br /></td></tr>
90 <tr class="separator:a58aece1447be21b39fe61dfd8b8e41b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <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>
92 <tr class="memdesc:a0096c9def0e99114e0eabb73696aabd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">FIXME DOC.  <a href="#a0096c9def0e99114e0eabb73696aabd7">More...</a><br /></td></tr>
93 <tr class="separator:a0096c9def0e99114e0eabb73696aabd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <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>
95 <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>
96 <tr class="separator:a8bbf688a608e52a52d1cf89c7103ac5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <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>
98 <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>
99 <tr class="separator:a5c0c669ab30776a58afc458b7f33a75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <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>
101 <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>
102 <tr class="separator:a83e54b51fe859e0aa93ebf292edf054c"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <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>
104 <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>
105 <tr class="separator:ac2b84e72997fde0bf510faf6c8df5798"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 </table>
107 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
108 <div class="textblock"><p>Byte input-output stream. </p>
109 </div><h2 class="groupheader">Field Documentation</h2>
110 <a class="anchor" id="a83e54b51fe859e0aa93ebf292edf054c"></a>
111 <div class="memitem">
112 <div class="memproto">
113       <table class="memname">
114         <tr>
115           <td class="memname"><a class="el" href="openjpeg_8h.html#aba7397be054e36dc0284a6589736135e">OPJ_SIZE_T</a> opj_stream_private::m_buffer_size</td>
116         </tr>
117       </table>
118 </div><div class="memdoc">
119
120 <p>The size of the buffer. </p>
121
122 <p>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>
123
124 </div>
125 </div>
126 <a class="anchor" id="a5c0c669ab30776a58afc458b7f33a75b"></a>
127 <div class="memitem">
128 <div class="memproto">
129       <table class="memname">
130         <tr>
131           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> opj_stream_private::m_byte_offset</td>
132         </tr>
133       </table>
134 </div><div class="memdoc">
135
136 <p>The number of bytes read/written from the beginning of the stream. </p>
137
138 <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#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>
139
140 </div>
141 </div>
142 <a class="anchor" id="a8bbf688a608e52a52d1cf89c7103ac5b"></a>
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>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 class="anchor" id="a954a54c078a817c3eeffd66b45419cfc"></a>
159 <div class="memitem">
160 <div class="memproto">
161       <table class="memname">
162         <tr>
163           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_current_data</td>
164         </tr>
165       </table>
166 </div><div class="memdoc">
167
168 <p>Pointer to the current read data. </p>
169
170 <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="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>
171
172 </div>
173 </div>
174 <a class="anchor" id="a262bea0d39f7c5a0bd5ef07434e38723"></a>
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <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>
180         </tr>
181       </table>
182 </div><div class="memdoc">
183
184 <p>Pointer to function to free m_user_data (NULL at initialization) when destroying the stream. </p>
185 <p>If pointer is NULL the function is not called and the m_user_data is not freed (even if non-NULL). </p>
186
187 <p>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>
188
189 </div>
190 </div>
191 <a class="anchor" id="a0096c9def0e99114e0eabb73696aabd7"></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#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>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200
201 <p>FIXME DOC. </p>
202
203 <p>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>
204
205 </div>
206 </div>
207 <a class="anchor" id="a58aece1447be21b39fe61dfd8b8e41b1"></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#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>
213         </tr>
214       </table>
215 </div><div class="memdoc">
216
217 <p>FIXME DOC. </p>
218
219 <p>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>
220
221 </div>
222 </div>
223 <a class="anchor" id="acce2d2187feff70fa3057b0439591f76"></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#aa2eb8272b84be8503bafa20075b4a943">opj_stream_read_fn</a> opj_stream_private::m_read_fn</td>
229         </tr>
230       </table>
231 </div><div class="memdoc">
232
233 <p>Pointer to actual read function (NULL at the initialization of the cio. </p>
234
235 <p>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>
236
237 </div>
238 </div>
239 <a class="anchor" id="adab26f9f0a32253aefdce763331c641a"></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#a6b85fe2ce4d609d2262afad0c7a7f31e">opj_stream_seek_fn</a> opj_stream_private::m_seek_fn</td>
245         </tr>
246       </table>
247 </div><div class="memdoc">
248
249 <p>Pointer to actual seek function (if available). </p>
250
251 <p>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>
252
253 </div>
254 </div>
255 <a class="anchor" id="a2ca719761a9cd88dc350486e38b41790"></a>
256 <div class="memitem">
257 <div class="memproto">
258       <table class="memname">
259         <tr>
260           <td class="memname"><a class="el" href="openjpeg_8h.html#a5a5da112c449f1aafb5823f7a04d0b3b">opj_stream_skip_fn</a> opj_stream_private::m_skip_fn</td>
261         </tr>
262       </table>
263 </div><div class="memdoc">
264
265 <p>Pointer to actual skip function (NULL at the initialization of the cio. </p>
266 <p>There is no seek function to prevent from back and forth slow procedures. </p>
267
268 <p>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>
269
270 </div>
271 </div>
272 <a class="anchor" id="ac2b84e72997fde0bf510faf6c8df5798"></a>
273 <div class="memitem">
274 <div class="memproto">
275       <table class="memname">
276         <tr>
277           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_stream_private::m_status</td>
278         </tr>
279       </table>
280 </div><div class="memdoc">
281
282 <p>Flags to tell the status of the stream. </p>
283 <p>Used with OPJ_STREAM_STATUS_* defines. </p>
284
285 <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>
286
287 </div>
288 </div>
289 <a class="anchor" id="aca072a59b683dc106263ba04d3c28577"></a>
290 <div class="memitem">
291 <div class="memproto">
292       <table class="memname">
293         <tr>
294           <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>* opj_stream_private::m_stored_data</td>
295         </tr>
296       </table>
297 </div><div class="memdoc">
298
299 <p>Actual data stored into the stream if readed from. </p>
300 <p>Data is read by chunk of fixed size. you should never access this data directly. </p>
301
302 <p>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>
303
304 </div>
305 </div>
306 <a class="anchor" id="a326f2fe5dc1fccce2788bf09ddf4931c"></a>
307 <div class="memitem">
308 <div class="memproto">
309       <table class="memname">
310         <tr>
311           <td class="memname">void* opj_stream_private::m_user_data</td>
312         </tr>
313       </table>
314 </div><div class="memdoc">
315
316 <p>User data, be it files, ... </p>
317 <p>The actual data depends on the type of the stream. </p>
318
319 <p>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>
320
321 </div>
322 </div>
323 <a class="anchor" id="a53cb7b3992a382231554bdc73cb0c7bd"></a>
324 <div class="memitem">
325 <div class="memproto">
326       <table class="memname">
327         <tr>
328           <td class="memname"><a class="el" href="openjpeg_8h.html#ad915cf26c4c9cc10a75b2d9287dbbb5e">OPJ_UINT64</a> opj_stream_private::m_user_data_length</td>
329         </tr>
330       </table>
331 </div><div class="memdoc">
332
333 <p>User data length. </p>
334
335 <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>
336
337 </div>
338 </div>
339 <a class="anchor" id="aacd57b4e429ddf5ca3a4913a2f963d6a"></a>
340 <div class="memitem">
341 <div class="memproto">
342       <table class="memname">
343         <tr>
344           <td class="memname"><a class="el" href="openjpeg_8h.html#a087a324f17cc02a95526b41b7636b580">opj_stream_write_fn</a> opj_stream_private::m_write_fn</td>
345         </tr>
346       </table>
347 </div><div class="memdoc">
348
349 <p>Pointer to actual write function (NULL at the initialization of the cio. </p>
350
351 <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>, and <a class="el" href="openjpeg_8h.html#a5d196d304c431d2c1d462397976aa763">opj_stream_set_write_function()</a>.</p>
352
353 </div>
354 </div>
355 <hr/>The documentation for this struct was generated from the following file:<ul>
356 <li><a class="el" href="cio_8h_source.html">cio.h</a></li>
357 </ul>
358 </div><!-- contents -->
359 <!-- start footer part -->
360 <hr class="footer"/><address class="footer"><small>
361 Generated by &#160;<a href="http://www.doxygen.org/index.html">
362 <img class="footer" src="doxygen.png" alt="doxygen"/>
363 </a> 1.8.10
364 </small></address>
365 </body>
366 </html>