72d49d2706b4cab69926a424cac7843b3490098f
[platform/upstream/libjpeg-turbo.git] / doc / html / structtjregion.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.20"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>TurboJPEG: tjregion 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="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
17 </head>
18 <body>
19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20 <div id="titlearea">
21 <table cellspacing="0" cellpadding="0">
22  <tbody>
23  <tr style="height: 56px;">
24   <td id="projectalign" style="padding-left: 0.5em;">
25    <div id="projectname">TurboJPEG
26    &#160;<span id="projectnumber">2.1.4</span>
27    </div>
28   </td>
29  </tr>
30  </tbody>
31 </table>
32 </div>
33 <!-- end header part -->
34 <!-- Generated by Doxygen 1.8.20 -->
35 <script type="text/javascript">
36 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37 var searchBox = new SearchBox("searchBox", "search",false,'Search');
38 /* @license-end */
39 </script>
40 <script type="text/javascript" src="menudata.js"></script>
41 <script type="text/javascript" src="menu.js"></script>
42 <script type="text/javascript">
43 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
44 $(function() {
45   initMenu('',true,false,'search.php','Search');
46   $(document).ready(function() { init_search(); });
47 });
48 /* @license-end */</script>
49 <div id="main-nav"></div>
50 <!-- window showing the filter options -->
51 <div id="MSearchSelectWindow"
52      onmouseover="return searchBox.OnSearchSelectShow()"
53      onmouseout="return searchBox.OnSearchSelectHide()"
54      onkeydown="return searchBox.OnSearchSelectKey(event)">
55 </div>
56
57 <!-- iframe showing the search results (closed by default) -->
58 <div id="MSearchResultsWindow">
59 <iframe src="javascript:void(0)" frameborder="0" 
60         name="MSearchResults" id="MSearchResults">
61 </iframe>
62 </div>
63
64 </div><!-- top -->
65 <div class="header">
66   <div class="summary">
67 <a href="#pub-attribs">Data Fields</a>  </div>
68   <div class="headertitle">
69 <div class="title">tjregion Struct Reference<div class="ingroups"><a class="el" href="group___turbo_j_p_e_g.html">TurboJPEG</a></div></div>  </div>
70 </div><!--header-->
71 <div class="contents">
72
73 <p>Cropping region.  
74  <a href="structtjregion.html#details">More...</a></p>
75
76 <p><code>#include &lt;turbojpeg.h&gt;</code></p>
77 <table class="memberdecls">
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
79 Data Fields</h2></td></tr>
80 <tr class="memitem:a4b6a37a93997091b26a75831fa291ad9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#a4b6a37a93997091b26a75831fa291ad9">x</a></td></tr>
81 <tr class="memdesc:a4b6a37a93997091b26a75831fa291ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The left boundary of the cropping region.  <a href="structtjregion.html#a4b6a37a93997091b26a75831fa291ad9">More...</a><br /></td></tr>
82 <tr class="separator:a4b6a37a93997091b26a75831fa291ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#a7b3e0c24cfe87acc80e334cafdcf22c2">y</a></td></tr>
84 <tr class="memdesc:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The upper boundary of the cropping region.  <a href="structtjregion.html#a7b3e0c24cfe87acc80e334cafdcf22c2">More...</a><br /></td></tr>
85 <tr class="separator:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:ab6eb73ceef584fc23c8c8097926dce42"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#ab6eb73ceef584fc23c8c8097926dce42">w</a></td></tr>
87 <tr class="memdesc:ab6eb73ceef584fc23c8c8097926dce42"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the cropping region.  <a href="structtjregion.html#ab6eb73ceef584fc23c8c8097926dce42">More...</a><br /></td></tr>
88 <tr class="separator:ab6eb73ceef584fc23c8c8097926dce42"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:aecefc45a26f4d8b60dd4d825c1710115"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#aecefc45a26f4d8b60dd4d825c1710115">h</a></td></tr>
90 <tr class="memdesc:aecefc45a26f4d8b60dd4d825c1710115"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the cropping region.  <a href="structtjregion.html#aecefc45a26f4d8b60dd4d825c1710115">More...</a><br /></td></tr>
91 <tr class="separator:aecefc45a26f4d8b60dd4d825c1710115"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 </table>
93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
94 <div class="textblock"><p>Cropping region. </p>
95 </div><h2 class="groupheader">Field Documentation</h2>
96 <a id="aecefc45a26f4d8b60dd4d825c1710115"></a>
97 <h2 class="memtitle"><span class="permalink"><a href="#aecefc45a26f4d8b60dd4d825c1710115">&#9670;&nbsp;</a></span>h</h2>
98
99 <div class="memitem">
100 <div class="memproto">
101       <table class="memname">
102         <tr>
103           <td class="memname">int tjregion::h</td>
104         </tr>
105       </table>
106 </div><div class="memdoc">
107
108 <p>The height of the cropping region. </p>
109 <p>Setting this to 0 is the equivalent of setting it to the height of the source JPEG image - y. </p>
110
111 </div>
112 </div>
113 <a id="ab6eb73ceef584fc23c8c8097926dce42"></a>
114 <h2 class="memtitle"><span class="permalink"><a href="#ab6eb73ceef584fc23c8c8097926dce42">&#9670;&nbsp;</a></span>w</h2>
115
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname">int tjregion::w</td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124
125 <p>The width of the cropping region. </p>
126 <p>Setting this to 0 is the equivalent of setting it to the width of the source JPEG image - x. </p>
127
128 </div>
129 </div>
130 <a id="a4b6a37a93997091b26a75831fa291ad9"></a>
131 <h2 class="memtitle"><span class="permalink"><a href="#a4b6a37a93997091b26a75831fa291ad9">&#9670;&nbsp;</a></span>x</h2>
132
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname">int tjregion::x</td>
138         </tr>
139       </table>
140 </div><div class="memdoc">
141
142 <p>The left boundary of the cropping region. </p>
143 <p>This must be evenly divisible by the MCU block width (see <a class="el" href="group___turbo_j_p_e_g.html#ga9e61e7cd47a15a173283ba94e781308c" title="MCU block width (in pixels) for a given level of chrominance subsampling.">tjMCUWidth</a>.) </p>
144
145 </div>
146 </div>
147 <a id="a7b3e0c24cfe87acc80e334cafdcf22c2"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#a7b3e0c24cfe87acc80e334cafdcf22c2">&#9670;&nbsp;</a></span>y</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152       <table class="memname">
153         <tr>
154           <td class="memname">int tjregion::y</td>
155         </tr>
156       </table>
157 </div><div class="memdoc">
158
159 <p>The upper boundary of the cropping region. </p>
160 <p>This must be evenly divisible by the MCU block height (see <a class="el" href="group___turbo_j_p_e_g.html#gabd247bb9fecb393eca57366feb8327bf" title="MCU block height (in pixels) for a given level of chrominance subsampling.">tjMCUHeight</a>.) </p>
161
162 </div>
163 </div>
164 <hr/>The documentation for this struct was generated from the following file:<ul>
165 <li>turbojpeg.h</li>
166 </ul>
167 </div><!-- contents -->
168 <!-- start footer part -->
169 <hr class="footer"/><address class="footer"><small>
170 Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
171 </small></address>
172 </body>
173 </html>