openjpeg/doxygen/structopj__image__comptparm...

278 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenJPEG: opj_image_comptparm Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenJPEG
&#160;<span id="projectnumber">2.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">opj_image_comptparm Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Component parameters structure used by the opj_image_create function.
<a href="structopj__image__comptparm.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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>
<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>
<tr class="separator:a9abd5c88b2b0f70d3b3be3c45b023b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<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>
<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>
<tr class="separator:a709dcaed22eaba4f946e9ca3938b41b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:aca10e7f31cbd3ebee3601532d19333de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:af83b657b54cb33fe3021656d27a76002"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a9a262042a9c180f5b236145ef7f52553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a384f4f3280e19b98e5fc0b67cd4fc02a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a8789a74e9825d51a1aa99021c2273746"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ac9a9f971df431df4ae59b94ad15f7ecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ab04dc3080a225270b23417b1d591ff38"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Component parameters structure used by the opj_image_create function. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9abd5c88b2b0f70d3b3be3c45b023b80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9abd5c88b2b0f70d3b3be3c45b023b80">&#9670;&nbsp;</a></span>OPJ_DEPRECATED_STRUCT_MEMBER()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">opj_image_comptparm::OPJ_DEPRECATED_STRUCT_MEMBER </td>
<td>(</td>
<td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
<td class="paramname"><em>bpp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&quot;Use <a class="el" href="structopj__image__comptparm.html#ac9a9f971df431df4ae59b94ad15f7ecf">prec</a> instead&quot;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>obsolete: use prec instead </p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a709dcaed22eaba4f946e9ca3938b41b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a709dcaed22eaba4f946e9ca3938b41b5">&#9670;&nbsp;</a></span>dx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::dx</td>
</tr>
</table>
</div><div class="memdoc">
<p>XRsiz: horizontal separation of a sample of ith component with respect to the reference grid. </p>
<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>
</div>
</div>
<a id="aca10e7f31cbd3ebee3601532d19333de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca10e7f31cbd3ebee3601532d19333de">&#9670;&nbsp;</a></span>dy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::dy</td>
</tr>
</table>
</div><div class="memdoc">
<p>YRsiz: vertical separation of a sample of ith component with respect to the reference grid. </p>
<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>
</div>
</div>
<a id="a9a262042a9c180f5b236145ef7f52553"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a262042a9c180f5b236145ef7f52553">&#9670;&nbsp;</a></span>h</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::h</td>
</tr>
</table>
</div><div class="memdoc">
<p>data height </p>
<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>
</div>
</div>
<a id="ac9a9f971df431df4ae59b94ad15f7ecf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9a9f971df431df4ae59b94ad15f7ecf">&#9670;&nbsp;</a></span>prec</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::prec</td>
</tr>
</table>
</div><div class="memdoc">
<p>precision: number of bits per component per pixel </p>
<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>
</div>
</div>
<a id="ab04dc3080a225270b23417b1d591ff38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab04dc3080a225270b23417b1d591ff38">&#9670;&nbsp;</a></span>sgnd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::sgnd</td>
</tr>
</table>
</div><div class="memdoc">
<p>signed (1) / unsigned (0) </p>
<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>
</div>
</div>
<a id="af83b657b54cb33fe3021656d27a76002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af83b657b54cb33fe3021656d27a76002">&#9670;&nbsp;</a></span>w</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::w</td>
</tr>
</table>
</div><div class="memdoc">
<p>data width </p>
<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>
</div>
</div>
<a id="a384f4f3280e19b98e5fc0b67cd4fc02a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a384f4f3280e19b98e5fc0b67cd4fc02a">&#9670;&nbsp;</a></span>x0</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::x0</td>
</tr>
</table>
</div><div class="memdoc">
<p>x component offset compared to the whole image </p>
<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>
</div>
</div>
<a id="a8789a74e9825d51a1aa99021c2273746"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8789a74e9825d51a1aa99021c2273746">&#9670;&nbsp;</a></span>y0</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::y0</td>
</tr>
</table>
</div><div class="memdoc">
<p>y component offset compared to the whole image </p>
<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>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>