doxygen/group___s_p_a_r_s_e___a_r_r_a_y.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: SPARSE ARRAYS - Sparse arrays</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="#typedef-members">Typedefs</a> &#124;
  43 <a href="#func-members">Functions</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">SPARSE ARRAYS - Sparse arrays</div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  50 Typedefs</h2></td></tr>
  51 <tr class="memitem:gab63770624f4ec03e6e022c6a0b80e6ff"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structopj__sparse__array__int32.html">opj_sparse_array_int32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a></td></tr>
  52 <tr class="memdesc:gab63770624f4ec03e6e022c6a0b80e6ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque type for sparse arrays that contain int32 values.  <a href="#gab63770624f4ec03e6e022c6a0b80e6ff">More...</a><br /></td></tr>
  53 <tr class="separator:gab63770624f4ec03e6e022c6a0b80e6ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54 </table><table class="memberdecls">
  55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  56 Functions</h2></td></tr>
  57 <tr class="memitem:ga41953de4fab74677337c2597a67c9843"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#ga41953de4fab74677337c2597a67c9843">opj_sparse_array_int32_create</a> (<a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> width, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> height, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> block_width, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> block_height)</td></tr>
  58 <tr class="memdesc:ga41953de4fab74677337c2597a67c9843"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new sparse array.  <a href="#ga41953de4fab74677337c2597a67c9843">More...</a><br /></td></tr>
  59 <tr class="separator:ga41953de4fab74677337c2597a67c9843"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 <tr class="memitem:gad70f920d05b4915853b474d010a9a336"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gad70f920d05b4915853b474d010a9a336">opj_sparse_array_int32_free</a> (<a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *sa)</td></tr>
  61 <tr class="memdesc:gad70f920d05b4915853b474d010a9a336"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a sparse array.  <a href="#gad70f920d05b4915853b474d010a9a336">More...</a><br /></td></tr>
  62 <tr class="separator:gad70f920d05b4915853b474d010a9a336"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:ga2b5c5075af6a30d35569e4378931ed4c"><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="group___s_p_a_r_s_e___a_r_r_a_y.html#ga2b5c5075af6a30d35569e4378931ed4c">opj_sparse_array_is_region_valid</a> (const <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *sa, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x1, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y1)</td></tr>
  64 <tr class="memdesc:ga2b5c5075af6a30d35569e4378931ed4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether region bounds are valid (non empty and within array bounds)  <a href="#ga2b5c5075af6a30d35569e4378931ed4c">More...</a><br /></td></tr>
  65 <tr class="separator:ga2b5c5075af6a30d35569e4378931ed4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:ga092675bfa99d062ce36fa45aff4766da"><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="group___s_p_a_r_s_e___a_r_r_a_y.html#ga092675bfa99d062ce36fa45aff4766da">opj_sparse_array_int32_read</a> (const <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *sa, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x1, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y1, <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> *dest, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> dest_col_stride, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> dest_line_stride, <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> forgiving)</td></tr>
  67 <tr class="memdesc:ga092675bfa99d062ce36fa45aff4766da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the content of a rectangular region of the sparse array into a user buffer.  <a href="#ga092675bfa99d062ce36fa45aff4766da">More...</a><br /></td></tr>
  68 <tr class="separator:ga092675bfa99d062ce36fa45aff4766da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:ga174b3ef4cb89af58cdd7c2b9f0a20559"><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="group___s_p_a_r_s_e___a_r_r_a_y.html#ga174b3ef4cb89af58cdd7c2b9f0a20559">opj_sparse_array_int32_write</a> (<a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *sa, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y0, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> x1, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> y1, const <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> *src, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> src_col_stride, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> src_line_stride, <a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> forgiving)</td></tr>
  70 <tr class="memdesc:ga174b3ef4cb89af58cdd7c2b9f0a20559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the content of a rectangular region into the sparse array from a user buffer.  <a href="#ga174b3ef4cb89af58cdd7c2b9f0a20559">More...</a><br /></td></tr>
  71 <tr class="separator:ga174b3ef4cb89af58cdd7c2b9f0a20559"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 </table>
  73 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  74 <h2 class="groupheader">Typedef Documentation</h2>
  75 <a id="gab63770624f4ec03e6e022c6a0b80e6ff"></a>
  76 <h2 class="memtitle"><span class="permalink"><a href="#gab63770624f4ec03e6e022c6a0b80e6ff">&#9670;&nbsp;</a></span>opj_sparse_array_int32_t</h2>
  77
  78 <div class="memitem">
  79 <div class="memproto">
  80       <table class="memname">
  81         <tr>
  82           <td class="memname">typedef struct <a class="el" href="structopj__sparse__array__int32.html">opj_sparse_array_int32</a> <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a></td>
  83         </tr>
  84       </table>
  85 </div><div class="memdoc">
  86
  87 <p>Opaque type for sparse arrays that contain int32 values. </p>
  88
  89 </div>
  90 </div>
  91 <h2 class="groupheader">Function Documentation</h2>
  92 <a id="ga41953de4fab74677337c2597a67c9843"></a>
  93 <h2 class="memtitle"><span class="permalink"><a href="#ga41953de4fab74677337c2597a67c9843">&#9670;&nbsp;</a></span>opj_sparse_array_int32_create()</h2>
  94
  95 <div class="memitem">
  96 <div class="memproto">
  97       <table class="memname">
  98         <tr>
  99           <td class="memname"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a>* opj_sparse_array_int32_create </td>
 100           <td>(</td>
 101           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 102           <td class="paramname"><em>width</em>, </td>
 103         </tr>
 104         <tr>
 105           <td class="paramkey"></td>
 106           <td></td>
 107           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 108           <td class="paramname"><em>height</em>, </td>
 109         </tr>
 110         <tr>
 111           <td class="paramkey"></td>
 112           <td></td>
 113           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 114           <td class="paramname"><em>block_width</em>, </td>
 115         </tr>
 116         <tr>
 117           <td class="paramkey"></td>
 118           <td></td>
 119           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 120           <td class="paramname"><em>block_height</em>&#160;</td>
 121         </tr>
 122         <tr>
 123           <td></td>
 124           <td>)</td>
 125           <td></td><td></td>
 126         </tr>
 127       </table>
 128 </div><div class="memdoc">
 129
 130 <p>Creates a new sparse array. </p>
 131 <dl class="params"><dt>Parameters</dt><dd>
 132   <table class="params">
 133     <tr><td class="paramname">width</td><td>total width of the array. </td></tr>
 134     <tr><td class="paramname">height</td><td>total height of the array </td></tr>
 135     <tr><td class="paramname">block_width</td><td>width of a block. </td></tr>
 136     <tr><td class="paramname">block_height</td><td>height of a block. </td></tr>
 137   </table>
 138   </dd>
 139 </dl>
 140 <dl class="section return"><dt>Returns</dt><dd>a new sparse array instance, or NULL in case of failure. </dd></dl>
 141
 142 <p class="reference">References <a class="el" href="structopj__sparse__array__int32.html#a3e4065eb08fe228175101035b6f218ed">opj_sparse_array_int32::block_count_hor</a>, <a class="el" href="structopj__sparse__array__int32.html#aee2f11c522fd981408e3ae164c142baf">opj_sparse_array_int32::block_count_ver</a>, <a class="el" href="structopj__sparse__array__int32.html#a8879d3a7726f3f6ff228d5e341ada8b3">opj_sparse_array_int32::block_height</a>, <a class="el" href="structopj__sparse__array__int32.html#a97a62a6f3c09048f6fd8ec4192d71b5f">opj_sparse_array_int32::block_width</a>, <a class="el" href="structopj__sparse__array__int32.html#aa8740069e9f55f024b69b0e96b6f4f56">opj_sparse_array_int32::data_blocks</a>, <a class="el" href="structopj__sparse__array__int32.html#acbfd23999d0b817fb40ed58073bb6cf2">opj_sparse_array_int32::height</a>, <a class="el" href="group___m_i_s_c.html#ga7fe6dfcb0a623dbec30daf0f48624bf7">opj_calloc()</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#gae4b2e5a7c8b8f09faacc4a895f866ea1">opj_uint_ceildiv()</a>, and <a class="el" href="structopj__sparse__array__int32.html#a427c80944840803fd7f5592317ad8564">opj_sparse_array_int32::width</a>.</p>
 143
 144 <p class="reference">Referenced by <a class="el" href="test__sparse__array_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, and <a class="el" href="dwt_8c.html#a57c042791753ac46c7bb073abcc245ba">opj_dwt_init_sparse_array()</a>.</p>
 145
 146 </div>
 147 </div>
 148 <a id="gad70f920d05b4915853b474d010a9a336"></a>
 149 <h2 class="memtitle"><span class="permalink"><a href="#gad70f920d05b4915853b474d010a9a336">&#9670;&nbsp;</a></span>opj_sparse_array_int32_free()</h2>
 150
 151 <div class="memitem">
 152 <div class="memproto">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname">void opj_sparse_array_int32_free </td>
 156           <td>(</td>
 157           <td class="paramtype"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *&#160;</td>
 158           <td class="paramname"><em>sa</em></td><td>)</td>
 159           <td></td>
 160         </tr>
 161       </table>
 162 </div><div class="memdoc">
 163
 164 <p>Frees a sparse array. </p>
 165 <dl class="params"><dt>Parameters</dt><dd>
 166   <table class="params">
 167     <tr><td class="paramname">sa</td><td>sparse array instance. </td></tr>
 168   </table>
 169   </dd>
 170 </dl>
 171
 172 <p class="reference">References <a class="el" href="structopj__sparse__array__int32.html#a3e4065eb08fe228175101035b6f218ed">opj_sparse_array_int32::block_count_hor</a>, <a class="el" href="structopj__sparse__array__int32.html#aee2f11c522fd981408e3ae164c142baf">opj_sparse_array_int32::block_count_ver</a>, <a class="el" href="structopj__sparse__array__int32.html#aa8740069e9f55f024b69b0e96b6f4f56">opj_sparse_array_int32::data_blocks</a>, and <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>.</p>
 173
 174 <p class="reference">Referenced by <a class="el" href="test__sparse__array_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, <a class="el" href="dwt_8c.html#a75cd080404aadce6662457dec7cc9d21">opj_dwt_decode_partial_97()</a>, <a class="el" href="group___d_w_t.html#ga74b827f7914de05bf5bfc52894894803">opj_dwt_decode_partial_tile()</a>, and <a class="el" href="dwt_8c.html#a57c042791753ac46c7bb073abcc245ba">opj_dwt_init_sparse_array()</a>.</p>
 175
 176 </div>
 177 </div>
 178 <a id="ga092675bfa99d062ce36fa45aff4766da"></a>
 179 <h2 class="memtitle"><span class="permalink"><a href="#ga092675bfa99d062ce36fa45aff4766da">&#9670;&nbsp;</a></span>opj_sparse_array_int32_read()</h2>
 180
 181 <div class="memitem">
 182 <div class="memproto">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_sparse_array_int32_read </td>
 186           <td>(</td>
 187           <td class="paramtype">const <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *&#160;</td>
 188           <td class="paramname"><em>sa</em>, </td>
 189         </tr>
 190         <tr>
 191           <td class="paramkey"></td>
 192           <td></td>
 193           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 194           <td class="paramname"><em>x0</em>, </td>
 195         </tr>
 196         <tr>
 197           <td class="paramkey"></td>
 198           <td></td>
 199           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 200           <td class="paramname"><em>y0</em>, </td>
 201         </tr>
 202         <tr>
 203           <td class="paramkey"></td>
 204           <td></td>
 205           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 206           <td class="paramname"><em>x1</em>, </td>
 207         </tr>
 208         <tr>
 209           <td class="paramkey"></td>
 210           <td></td>
 211           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 212           <td class="paramname"><em>y1</em>, </td>
 213         </tr>
 214         <tr>
 215           <td class="paramkey"></td>
 216           <td></td>
 217           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> *&#160;</td>
 218           <td class="paramname"><em>dest</em>, </td>
 219         </tr>
 220         <tr>
 221           <td class="paramkey"></td>
 222           <td></td>
 223           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 224           <td class="paramname"><em>dest_col_stride</em>, </td>
 225         </tr>
 226         <tr>
 227           <td class="paramkey"></td>
 228           <td></td>
 229           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 230           <td class="paramname"><em>dest_line_stride</em>, </td>
 231         </tr>
 232         <tr>
 233           <td class="paramkey"></td>
 234           <td></td>
 235           <td class="paramtype"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td>
 236           <td class="paramname"><em>forgiving</em>&#160;</td>
 237         </tr>
 238         <tr>
 239           <td></td>
 240           <td>)</td>
 241           <td></td><td></td>
 242         </tr>
 243       </table>
 244 </div><div class="memdoc">
 245
 246 <p>Read the content of a rectangular region of the sparse array into a user buffer. </p>
 247 <p>Regions not written with <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#ga174b3ef4cb89af58cdd7c2b9f0a20559" title="Write the content of a rectangular region into the sparse array from a user buffer. ">opj_sparse_array_int32_write()</a> are read as 0.</p>
 248 <dl class="params"><dt>Parameters</dt><dd>
 249   <table class="params">
 250     <tr><td class="paramname">sa</td><td>sparse array instance. </td></tr>
 251     <tr><td class="paramname">x0</td><td>left x coordinate of the region to read in the sparse array. </td></tr>
 252     <tr><td class="paramname">y0</td><td>top x coordinate of the region to read in the sparse array. </td></tr>
 253     <tr><td class="paramname">x1</td><td>right x coordinate (not included) of the region to read in the sparse array. Must be greater than x0. </td></tr>
 254     <tr><td class="paramname">y1</td><td>bottom y coordinate (not included) of the region to read in the sparse array. Must be greater than y0. </td></tr>
 255     <tr><td class="paramname">dest</td><td>user buffer to fill. Must be at least sizeof(int32) * ( (y1 - y0 - 1) * dest_line_stride + (x1 - x0 - 1) * dest_col_stride + 1) bytes large. </td></tr>
 256     <tr><td class="paramname">dest_col_stride</td><td>spacing (in elements, not in bytes) in x dimension between consecutive elements of the user buffer. </td></tr>
 257     <tr><td class="paramname">dest_line_stride</td><td>spacing (in elements, not in bytes) in y dimension between consecutive elements of the user buffer. </td></tr>
 258     <tr><td class="paramname">forgiving</td><td>if set to TRUE and the region is invalid, OPJ_TRUE will still be returned. </td></tr>
 259   </table>
 260   </dd>
 261 </dl>
 262 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE in case of success. </dd></dl>
 263
 264 <p class="reference">References <a class="el" href="sparse__array_8c.html#a175c52e28cac6cad5ccdc24200e67a60">opj_sparse_array_int32_read_or_write()</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
 265
 266 <p class="reference">Referenced by <a class="el" href="test__sparse__array_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, <a class="el" href="dwt_8c.html#a75cd080404aadce6662457dec7cc9d21">opj_dwt_decode_partial_97()</a>, <a class="el" href="group___d_w_t.html#ga74b827f7914de05bf5bfc52894894803">opj_dwt_decode_partial_tile()</a>, <a class="el" href="dwt_8c.html#aa9f1030974db43df751380437e5167af">opj_dwt_interleave_partial_h()</a>, <a class="el" href="dwt_8c.html#ad7a304bcf13f2427c0a6835e6c527d3e">opj_dwt_interleave_partial_v()</a>, <a class="el" href="dwt_8c.html#ae5137e0c3c1dcf46d22aa2915499322a">opj_v4dwt_interleave_partial_h()</a>, and <a class="el" href="dwt_8c.html#aa2dc1074fbe4206e06f9e2ceb70f8d0a">opj_v4dwt_interleave_partial_v()</a>.</p>
 267
 268 </div>
 269 </div>
 270 <a id="ga174b3ef4cb89af58cdd7c2b9f0a20559"></a>
 271 <h2 class="memtitle"><span class="permalink"><a href="#ga174b3ef4cb89af58cdd7c2b9f0a20559">&#9670;&nbsp;</a></span>opj_sparse_array_int32_write()</h2>
 272
 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#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_sparse_array_int32_write </td>
 278           <td>(</td>
 279           <td class="paramtype"><a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *&#160;</td>
 280           <td class="paramname"><em>sa</em>, </td>
 281         </tr>
 282         <tr>
 283           <td class="paramkey"></td>
 284           <td></td>
 285           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 286           <td class="paramname"><em>x0</em>, </td>
 287         </tr>
 288         <tr>
 289           <td class="paramkey"></td>
 290           <td></td>
 291           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 292           <td class="paramname"><em>y0</em>, </td>
 293         </tr>
 294         <tr>
 295           <td class="paramkey"></td>
 296           <td></td>
 297           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 298           <td class="paramname"><em>x1</em>, </td>
 299         </tr>
 300         <tr>
 301           <td class="paramkey"></td>
 302           <td></td>
 303           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 304           <td class="paramname"><em>y1</em>, </td>
 305         </tr>
 306         <tr>
 307           <td class="paramkey"></td>
 308           <td></td>
 309           <td class="paramtype">const <a class="el" href="openjpeg_8h.html#a3cec91ef9e73677f0dbd60d4e42401b9">OPJ_INT32</a> *&#160;</td>
 310           <td class="paramname"><em>src</em>, </td>
 311         </tr>
 312         <tr>
 313           <td class="paramkey"></td>
 314           <td></td>
 315           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 316           <td class="paramname"><em>src_col_stride</em>, </td>
 317         </tr>
 318         <tr>
 319           <td class="paramkey"></td>
 320           <td></td>
 321           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 322           <td class="paramname"><em>src_line_stride</em>, </td>
 323         </tr>
 324         <tr>
 325           <td class="paramkey"></td>
 326           <td></td>
 327           <td class="paramtype"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td>
 328           <td class="paramname"><em>forgiving</em>&#160;</td>
 329         </tr>
 330         <tr>
 331           <td></td>
 332           <td>)</td>
 333           <td></td><td></td>
 334         </tr>
 335       </table>
 336 </div><div class="memdoc">
 337
 338 <p>Write the content of a rectangular region into the sparse array from a user buffer. </p>
 339 <p>Blocks intersecting the region are allocated, if not already done.</p>
 340 <dl class="params"><dt>Parameters</dt><dd>
 341   <table class="params">
 342     <tr><td class="paramname">sa</td><td>sparse array instance. </td></tr>
 343     <tr><td class="paramname">x0</td><td>left x coordinate of the region to write into the sparse array. </td></tr>
 344     <tr><td class="paramname">y0</td><td>top x coordinate of the region to write into the sparse array. </td></tr>
 345     <tr><td class="paramname">x1</td><td>right x coordinate (not included) of the region to write into the sparse array. Must be greater than x0. </td></tr>
 346     <tr><td class="paramname">y1</td><td>bottom y coordinate (not included) of the region to write into the sparse array. Must be greater than y0. </td></tr>
 347     <tr><td class="paramname">src</td><td>user buffer to fill. Must be at least sizeof(int32) * ( (y1 - y0 - 1) * src_line_stride + (x1 - x0 - 1) * src_col_stride + 1) bytes large. </td></tr>
 348     <tr><td class="paramname">src_col_stride</td><td>spacing (in elements, not in bytes) in x dimension between consecutive elements of the user buffer. </td></tr>
 349     <tr><td class="paramname">src_line_stride</td><td>spacing (in elements, not in bytes) in y dimension between consecutive elements of the user buffer. </td></tr>
 350     <tr><td class="paramname">forgiving</td><td>if set to TRUE and the region is invalid, OPJ_TRUE will still be returned. </td></tr>
 351   </table>
 352   </dd>
 353 </dl>
 354 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE in case of success. </dd></dl>
 355
 356 <p class="reference">References <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, and <a class="el" href="sparse__array_8c.html#a175c52e28cac6cad5ccdc24200e67a60">opj_sparse_array_int32_read_or_write()</a>.</p>
 357
 358 <p class="reference">Referenced by <a class="el" href="test__sparse__array_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, <a class="el" href="dwt_8c.html#a75cd080404aadce6662457dec7cc9d21">opj_dwt_decode_partial_97()</a>, <a class="el" href="group___d_w_t.html#ga74b827f7914de05bf5bfc52894894803">opj_dwt_decode_partial_tile()</a>, and <a class="el" href="dwt_8c.html#a57c042791753ac46c7bb073abcc245ba">opj_dwt_init_sparse_array()</a>.</p>
 359
 360 </div>
 361 </div>
 362 <a id="ga2b5c5075af6a30d35569e4378931ed4c"></a>
 363 <h2 class="memtitle"><span class="permalink"><a href="#ga2b5c5075af6a30d35569e4378931ed4c">&#9670;&nbsp;</a></span>opj_sparse_array_is_region_valid()</h2>
 364
 365 <div class="memitem">
 366 <div class="memproto">
 367       <table class="memname">
 368         <tr>
 369           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_sparse_array_is_region_valid </td>
 370           <td>(</td>
 371           <td class="paramtype">const <a class="el" href="group___s_p_a_r_s_e___a_r_r_a_y.html#gab63770624f4ec03e6e022c6a0b80e6ff">opj_sparse_array_int32_t</a> *&#160;</td>
 372           <td class="paramname"><em>sa</em>, </td>
 373         </tr>
 374         <tr>
 375           <td class="paramkey"></td>
 376           <td></td>
 377           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 378           <td class="paramname"><em>x0</em>, </td>
 379         </tr>
 380         <tr>
 381           <td class="paramkey"></td>
 382           <td></td>
 383           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 384           <td class="paramname"><em>y0</em>, </td>
 385         </tr>
 386         <tr>
 387           <td class="paramkey"></td>
 388           <td></td>
 389           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 390           <td class="paramname"><em>x1</em>, </td>
 391         </tr>
 392         <tr>
 393           <td class="paramkey"></td>
 394           <td></td>
 395           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 396           <td class="paramname"><em>y1</em>&#160;</td>
 397         </tr>
 398         <tr>
 399           <td></td>
 400           <td>)</td>
 401           <td></td><td></td>
 402         </tr>
 403       </table>
 404 </div><div class="memdoc">
 405
 406 <p>Returns whether region bounds are valid (non empty and within array bounds) </p>
 407 <dl class="params"><dt>Parameters</dt><dd>
 408   <table class="params">
 409     <tr><td class="paramname">sa</td><td>sparse array instance. </td></tr>
 410     <tr><td class="paramname">x0</td><td>left x coordinate of the region. </td></tr>
 411     <tr><td class="paramname">y0</td><td>top x coordinate of the region. </td></tr>
 412     <tr><td class="paramname">x1</td><td>right x coordinate (not included) of the region. Must be greater than x0. </td></tr>
 413     <tr><td class="paramname">y1</td><td>bottom y coordinate (not included) of the region. Must be greater than y0. </td></tr>
 414   </table>
 415   </dd>
 416 </dl>
 417 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE or OPJ_FALSE. </dd></dl>
 418
 419 <p class="reference">References <a class="el" href="structopj__sparse__array__int32.html#acbfd23999d0b817fb40ed58073bb6cf2">opj_sparse_array_int32::height</a>, and <a class="el" href="structopj__sparse__array__int32.html#a427c80944840803fd7f5592317ad8564">opj_sparse_array_int32::width</a>.</p>
 420
 421 <p class="reference">Referenced by <a class="el" href="sparse__array_8c.html#a175c52e28cac6cad5ccdc24200e67a60">opj_sparse_array_int32_read_or_write()</a>.</p>
 422
 423 </div>
 424 </div>
 425 </div><!-- contents -->
 426 <!-- start footer part -->
 427 <hr class="footer"/><address class="footer"><small>
 428 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 429 <img class="footer" src="doxygen.png" alt="doxygen"/>
 430 </a> 1.8.13
 431 </small></address>
 432 </body>
 433 </html>