Update ABI/API compatibility reports after commit cc1919b183f76d5ac79cc9927fb899b4770...
[openjpeg.git] / doxygen / structopj__image__comptparm.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.11"/>
7 <title>OpenJPEG: opj_image_comptparm 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.4.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.11 -->
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_image_comptparm Struct Reference</div>  </div>
51 </div><!--header-->
52 <div class="contents">
53
54 <p>Component parameters structure used by the opj_image_create function.  
55  <a href="structopj__image__comptparm.html#details">More...</a></p>
56
57 <p><code>#include &lt;<a class="el" href="openjpeg_8h_source.html">openjpeg.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: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>
62 <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="#a709dcaed22eaba4f946e9ca3938b41b5">More...</a><br /></td></tr>
63 <tr class="separator:a709dcaed22eaba4f946e9ca3938b41b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <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>
65 <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="#aca10e7f31cbd3ebee3601532d19333de">More...</a><br /></td></tr>
66 <tr class="separator:aca10e7f31cbd3ebee3601532d19333de"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <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>
68 <tr class="memdesc:af83b657b54cb33fe3021656d27a76002"><td class="mdescLeft">&#160;</td><td class="mdescRight">data width  <a href="#af83b657b54cb33fe3021656d27a76002">More...</a><br /></td></tr>
69 <tr class="separator:af83b657b54cb33fe3021656d27a76002"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <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>
71 <tr class="memdesc:a9a262042a9c180f5b236145ef7f52553"><td class="mdescLeft">&#160;</td><td class="mdescRight">data height  <a href="#a9a262042a9c180f5b236145ef7f52553">More...</a><br /></td></tr>
72 <tr class="separator:a9a262042a9c180f5b236145ef7f52553"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <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>
74 <tr class="memdesc:a384f4f3280e19b98e5fc0b67cd4fc02a"><td class="mdescLeft">&#160;</td><td class="mdescRight">x component offset compared to the whole image  <a href="#a384f4f3280e19b98e5fc0b67cd4fc02a">More...</a><br /></td></tr>
75 <tr class="separator:a384f4f3280e19b98e5fc0b67cd4fc02a"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <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>
77 <tr class="memdesc:a8789a74e9825d51a1aa99021c2273746"><td class="mdescLeft">&#160;</td><td class="mdescRight">y component offset compared to the whole image  <a href="#a8789a74e9825d51a1aa99021c2273746">More...</a><br /></td></tr>
78 <tr class="separator:a8789a74e9825d51a1aa99021c2273746"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <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>
80 <tr class="memdesc:ac9a9f971df431df4ae59b94ad15f7ecf"><td class="mdescLeft">&#160;</td><td class="mdescRight">precision  <a href="#ac9a9f971df431df4ae59b94ad15f7ecf">More...</a><br /></td></tr>
81 <tr class="separator:ac9a9f971df431df4ae59b94ad15f7ecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:abc64ebc6d3d148ad72171ae58b6b8c6b"><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#abc64ebc6d3d148ad72171ae58b6b8c6b">bpp</a></td></tr>
83 <tr class="memdesc:abc64ebc6d3d148ad72171ae58b6b8c6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">image depth in bits  <a href="#abc64ebc6d3d148ad72171ae58b6b8c6b">More...</a><br /></td></tr>
84 <tr class="separator:abc64ebc6d3d148ad72171ae58b6b8c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <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>
86 <tr class="memdesc:ab04dc3080a225270b23417b1d591ff38"><td class="mdescLeft">&#160;</td><td class="mdescRight">signed (1) / unsigned (0)  <a href="#ab04dc3080a225270b23417b1d591ff38">More...</a><br /></td></tr>
87 <tr class="separator:ab04dc3080a225270b23417b1d591ff38"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 </table>
89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90 <div class="textblock"><p>Component parameters structure used by the opj_image_create function. </p>
91 </div><h2 class="groupheader">Field Documentation</h2>
92 <a class="anchor" id="abc64ebc6d3d148ad72171ae58b6b8c6b"></a>
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::bpp</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101
102 <p>image depth in bits </p>
103
104 <p>Referenced by <a class="el" href="openjpeg_8h.html#af168cf4a4295433c8c33610bac614553">opj_image_create()</a>.</p>
105
106 </div>
107 </div>
108 <a class="anchor" id="a709dcaed22eaba4f946e9ca3938b41b5"></a>
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::dx</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117
118 <p>XRsiz: horizontal separation of a sample of ith component with respect to the reference grid. </p>
119
120 <p>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>
121
122 </div>
123 </div>
124 <a class="anchor" id="aca10e7f31cbd3ebee3601532d19333de"></a>
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::dy</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p>YRsiz: vertical separation of a sample of ith component with respect to the reference grid. </p>
135
136 <p>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 class="anchor" id="a9a262042a9c180f5b236145ef7f52553"></a>
141 <div class="memitem">
142 <div class="memproto">
143       <table class="memname">
144         <tr>
145           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::h</td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 <p>data height </p>
151
152 <p>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>
153
154 </div>
155 </div>
156 <a class="anchor" id="ac9a9f971df431df4ae59b94ad15f7ecf"></a>
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::prec</td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p>precision </p>
167
168 <p>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>
169
170 </div>
171 </div>
172 <a class="anchor" id="ab04dc3080a225270b23417b1d591ff38"></a>
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::sgnd</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p>signed (1) / unsigned (0) </p>
183
184 <p>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>
185
186 </div>
187 </div>
188 <a class="anchor" id="af83b657b54cb33fe3021656d27a76002"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::w</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>data width </p>
199
200 <p>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>
201
202 </div>
203 </div>
204 <a class="anchor" id="a384f4f3280e19b98e5fc0b67cd4fc02a"></a>
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::x0</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213
214 <p>x component offset compared to the whole image </p>
215
216 <p>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>
217
218 </div>
219 </div>
220 <a class="anchor" id="a8789a74e9825d51a1aa99021c2273746"></a>
221 <div class="memitem">
222 <div class="memproto">
223       <table class="memname">
224         <tr>
225           <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_image_comptparm::y0</td>
226         </tr>
227       </table>
228 </div><div class="memdoc">
229
230 <p>y component offset compared to the whole image </p>
231
232 <p>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>
233
234 </div>
235 </div>
236 <hr/>The documentation for this struct was generated from the following file:<ul>
237 <li><a class="el" href="openjpeg_8h_source.html">openjpeg.h</a></li>
238 </ul>
239 </div><!-- contents -->
240 <!-- start footer part -->
241 <hr class="footer"/><address class="footer"><small>
242 Generated by &#160;<a href="http://www.doxygen.org/index.html">
243 <img class="footer" src="doxygen.png" alt="doxygen"/>
244 </a> 1.8.11
245 </small></address>
246 </body>
247 </html>