doxygen/structopj__image__comptparm.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>OpenJPEG: opj_image_comptparm 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.5.0</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.17 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#pub-methods">Public Member Functions</a> &#124;
  44 <a href="#pub-attribs">Data Fields</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">opj_image_comptparm Struct Reference</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>Component parameters structure used by the opj_image_create function.
  51  <a href="structopj__image__comptparm.html#details">More...</a></p>
  52
  53 <p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&gt;</code></p>
  54 <table class="memberdecls">
  55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  56 Public Member Functions</h2></td></tr>
  57 <tr class="memitem:a9abd5c88b2b0f70d3b3be3c45b023b80"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__image__comptparm.html#a9abd5c88b2b0f70d3b3be3c45b023b80">OPJ_DEPRECATED_STRUCT_MEMBER</a> (<a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> bpp, &quot;Use <a class="el" href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">prec</a> instead&quot;)</td></tr>
  58 <tr class="memdesc:a9abd5c88b2b0f70d3b3be3c45b023b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">obsolete: use prec instead  <a href="structopj__image__comptparm.html#a9abd5c88b2b0f70d3b3be3c45b023b80">More...</a><br /></td></tr>
  59 <tr class="separator:a9abd5c88b2b0f70d3b3be3c45b023b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 </table><table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  62 Data Fields</h2></td></tr>
  63 <tr class="memitem:a709dcaed22eaba4f946e9ca3938b41b5"><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__image__comptparm.html#a709dcaed22eaba4f946e9ca3938b41b5">dx</a></td></tr>
  64 <tr class="memdesc:a709dcaed22eaba4f946e9ca3938b41b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">XRsiz: horizontal separation of a sample of ith component with respect to the reference grid.  <a href="structopj__image__comptparm.html#a709dcaed22eaba4f946e9ca3938b41b5">More...</a><br /></td></tr>
  65 <tr class="separator:a709dcaed22eaba4f946e9ca3938b41b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:aca10e7f31cbd3ebee3601532d19333de"><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__image__comptparm.html#aca10e7f31cbd3ebee3601532d19333de">dy</a></td></tr>
  67 <tr class="memdesc:aca10e7f31cbd3ebee3601532d19333de"><td class="mdescLeft">&#160;</td><td class="mdescRight">YRsiz: vertical separation of a sample of ith component with respect to the reference grid.  <a href="structopj__image__comptparm.html#aca10e7f31cbd3ebee3601532d19333de">More...</a><br /></td></tr>
  68 <tr class="separator:aca10e7f31cbd3ebee3601532d19333de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:af83b657b54cb33fe3021656d27a76002"><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__image__comptparm.html#af83b657b54cb33fe3021656d27a76002">w</a></td></tr>
  70 <tr class="memdesc:af83b657b54cb33fe3021656d27a76002"><td class="mdescLeft">&#160;</td><td class="mdescRight">data width  <a href="structopj__image__comptparm.html#af83b657b54cb33fe3021656d27a76002">More...</a><br /></td></tr>
  71 <tr class="separator:af83b657b54cb33fe3021656d27a76002"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:a9a262042a9c180f5b236145ef7f52553"><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__image__comptparm.html#a9a262042a9c180f5b236145ef7f52553">h</a></td></tr>
  73 <tr class="memdesc:a9a262042a9c180f5b236145ef7f52553"><td class="mdescLeft">&#160;</td><td class="mdescRight">data height  <a href="structopj__image__comptparm.html#a9a262042a9c180f5b236145ef7f52553">More...</a><br /></td></tr>
  74 <tr class="separator:a9a262042a9c180f5b236145ef7f52553"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:a384f4f3280e19b98e5fc0b67cd4fc02a"><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__image__comptparm.html#a384f4f3280e19b98e5fc0b67cd4fc02a">x0</a></td></tr>
  76 <tr class="memdesc:a384f4f3280e19b98e5fc0b67cd4fc02a"><td class="mdescLeft">&#160;</td><td class="mdescRight">x component offset compared to the whole image  <a href="structopj__image__comptparm.html#a384f4f3280e19b98e5fc0b67cd4fc02a">More...</a><br /></td></tr>
  77 <tr class="separator:a384f4f3280e19b98e5fc0b67cd4fc02a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:a8789a74e9825d51a1aa99021c2273746"><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__image__comptparm.html#a8789a74e9825d51a1aa99021c2273746">y0</a></td></tr>
  79 <tr class="memdesc:a8789a74e9825d51a1aa99021c2273746"><td class="mdescLeft">&#160;</td><td class="mdescRight">y component offset compared to the whole image  <a href="structopj__image__comptparm.html#a8789a74e9825d51a1aa99021c2273746">More...</a><br /></td></tr>
  80 <tr class="separator:a8789a74e9825d51a1aa99021c2273746"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:ac9a9f971df431df4ae59b94ad15f7ecf"><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__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">prec</a></td></tr>
  82 <tr class="memdesc:ac9a9f971df431df4ae59b94ad15f7ecf"><td class="mdescLeft">&#160;</td><td class="mdescRight">precision: number of bits per component per pixel  <a href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">More...</a><br /></td></tr>
  83 <tr class="separator:ac9a9f971df431df4ae59b94ad15f7ecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:ab04dc3080a225270b23417b1d591ff38"><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__image__comptparm.html#ab04dc3080a225270b23417b1d591ff38">sgnd</a></td></tr>
  85 <tr class="memdesc:ab04dc3080a225270b23417b1d591ff38"><td class="mdescLeft">&#160;</td><td class="mdescRight">signed (1) / unsigned (0)  <a href="structopj__image__comptparm.html#ab04dc3080a225270b23417b1d591ff38">More...</a><br /></td></tr>
  86 <tr class="separator:ab04dc3080a225270b23417b1d591ff38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table>
  88 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89 <div class="textblock"><p>Component parameters structure used by the opj_image_create function. </p>
  90 </div><h2 class="groupheader">Member Function Documentation</h2>
  91 <a id="a9abd5c88b2b0f70d3b3be3c45b023b80"></a>
  92 <h2 class="memtitle"><span class="permalink"><a href="#a9abd5c88b2b0f70d3b3be3c45b023b80">&#9670;&nbsp;</a></span>OPJ_DEPRECATED_STRUCT_MEMBER()</h2>
  93
  94 <div class="memitem">
  95 <div class="memproto">
  96       <table class="memname">
  97         <tr>
  98           <td class="memname">opj_image_comptparm::OPJ_DEPRECATED_STRUCT_MEMBER </td>
  99           <td>(</td>
 100           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
 101           <td class="paramname"><em>bpp</em>, </td>
 102         </tr>
 103         <tr>
 104           <td class="paramkey"></td>
 105           <td></td>
 106           <td class="paramtype">&quot;Use <a class="el" href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">prec</a> instead&quot;&#160;</td>
 107           <td class="paramname">&#160;</td>
 108         </tr>
 109         <tr>
 110           <td></td>
 111           <td>)</td>
 112           <td></td><td></td>
 113         </tr>
 114       </table>
 115 </div><div class="memdoc">
 116
 117 <p>obsolete: use prec instead </p>
 118
 119 </div>
 120 </div>
 121 <h2 class="groupheader">Field Documentation</h2>
 122 <a id="a709dcaed22eaba4f946e9ca3938b41b5"></a>
 123 <h2 class="memtitle"><span class="permalink"><a href="#a709dcaed22eaba4f946e9ca3938b41b5">&#9670;&nbsp;</a></span>dx</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#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::dx</td>
 130         </tr>
 131       </table>
 132 </div><div class="memdoc">
 133
 134 <p>XRsiz: horizontal separation of a sample of ith component with respect to the reference grid. </p>
 135
 136 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 137
 138 </div>
 139 </div>
 140 <a id="aca10e7f31cbd3ebee3601532d19333de"></a>
 141 <h2 class="memtitle"><span class="permalink"><a href="#aca10e7f31cbd3ebee3601532d19333de">&#9670;&nbsp;</a></span>dy</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#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::dy</td>
 148         </tr>
 149       </table>
 150 </div><div class="memdoc">
 151
 152 <p>YRsiz: vertical separation of a sample of ith component with respect to the reference grid. </p>
 153
 154 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 155
 156 </div>
 157 </div>
 158 <a id="a9a262042a9c180f5b236145ef7f52553"></a>
 159 <h2 class="memtitle"><span class="permalink"><a href="#a9a262042a9c180f5b236145ef7f52553">&#9670;&nbsp;</a></span>h</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#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::h</td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>data height </p>
 171
 172 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a id="ac9a9f971df431df4ae59b94ad15f7ecf"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ac9a9f971df431df4ae59b94ad15f7ecf">&#9670;&nbsp;</a></span>prec</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#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::prec</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 <p>precision: number of bits per component per pixel </p>
 189
 190 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 191
 192 </div>
 193 </div>
 194 <a id="ab04dc3080a225270b23417b1d591ff38"></a>
 195 <h2 class="memtitle"><span class="permalink"><a href="#ab04dc3080a225270b23417b1d591ff38">&#9670;&nbsp;</a></span>sgnd</h2>
 196
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::sgnd</td>
 202         </tr>
 203       </table>
 204 </div><div class="memdoc">
 205
 206 <p>signed (1) / unsigned (0) </p>
 207
 208 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 209
 210 </div>
 211 </div>
 212 <a id="af83b657b54cb33fe3021656d27a76002"></a>
 213 <h2 class="memtitle"><span class="permalink"><a href="#af83b657b54cb33fe3021656d27a76002">&#9670;&nbsp;</a></span>w</h2>
 214
 215 <div class="memitem">
 216 <div class="memproto">
 217       <table class="memname">
 218         <tr>
 219           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::w</td>
 220         </tr>
 221       </table>
 222 </div><div class="memdoc">
 223
 224 <p>data width </p>
 225
 226 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 227
 228 </div>
 229 </div>
 230 <a id="a384f4f3280e19b98e5fc0b67cd4fc02a"></a>
 231 <h2 class="memtitle"><span class="permalink"><a href="#a384f4f3280e19b98e5fc0b67cd4fc02a">&#9670;&nbsp;</a></span>x0</h2>
 232
 233 <div class="memitem">
 234 <div class="memproto">
 235       <table class="memname">
 236         <tr>
 237           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::x0</td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241
 242 <p>x component offset compared to the whole image </p>
 243
 244 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 245
 246 </div>
 247 </div>
 248 <a id="a8789a74e9825d51a1aa99021c2273746"></a>
 249 <h2 class="memtitle"><span class="permalink"><a href="#a8789a74e9825d51a1aa99021c2273746">&#9670;&nbsp;</a></span>y0</h2>
 250
 251 <div class="memitem">
 252 <div class="memproto">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::y0</td>
 256         </tr>
 257       </table>
 258 </div><div class="memdoc">
 259
 260 <p>y component offset compared to the whole image </p>
 261
 262 <p class="reference">Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>, and <a class="el" href="openjpeg_8h.html#a2b29bd52d3b2bcc2d3e0d95db66fbd5f">opj_image_tile_create()</a>.</p>
 263
 264 </div>
 265 </div>
 266 <hr/>The documentation for this struct was generated from the following file:<ul>
 267 <li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
 268 </ul>
 269 </div><!-- contents -->
 270 <!-- start footer part -->
 271 <hr class="footer"/><address class="footer"><small>
 272 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 273 <img class="footer" src="doxygen.png" alt="doxygen"/>
 274 </a> 1.8.17
 275 </small></address>
 276 </body>
 277 </html>