Imported Upstream version 1.3.1
[platform/upstream/libjpeg-turbo.git] / doc / html / structtjregion.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.3.1"/>
7 <title>TurboJPEG: tjregion 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="search/search.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="search/search.js"></script>
13 <script type="text/javascript">
14   $(document).ready(function() { searchBox.OnSelectItem(0); });
15 </script>
16 <link href="doxygen.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 style="padding-left: 0.5em;">
25    <div id="projectname">TurboJPEG
26    &#160;<span id="projectnumber">1.2.1</span>
27    </div>
28   </td>
29  </tr>
30  </tbody>
31 </table>
32 </div>
33 <!-- end header part -->
34 <!-- Generated by Doxygen 1.8.3.1 -->
35 <script type="text/javascript">
36 var searchBox = new SearchBox("searchBox", "search",false,'Search');
37 </script>
38   <div id="navrow1" class="tabs">
39     <ul class="tablist">
40       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
41       <li><a href="modules.html"><span>Modules</span></a></li>
42       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
43       <li>
44         <div id="MSearchBox" class="MSearchBoxInactive">
45         <span class="left">
46           <img id="MSearchSelect" src="search/mag_sel.png"
47                onmouseover="return searchBox.OnSearchSelectShow()"
48                onmouseout="return searchBox.OnSearchSelectHide()"
49                alt=""/>
50           <input type="text" id="MSearchField" value="Search" accesskey="S"
51                onfocus="searchBox.OnSearchFieldFocus(true)" 
52                onblur="searchBox.OnSearchFieldFocus(false)" 
53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
54           </span><span class="right">
55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
56           </span>
57         </div>
58       </li>
59     </ul>
60   </div>
61   <div id="navrow2" class="tabs2">
62     <ul class="tablist">
63       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
64       <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
65       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
66     </ul>
67   </div>
68 <!-- window showing the filter options -->
69 <div id="MSearchSelectWindow"
70      onmouseover="return searchBox.OnSearchSelectShow()"
71      onmouseout="return searchBox.OnSearchSelectHide()"
72      onkeydown="return searchBox.OnSearchSelectKey(event)">
73 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a></div>
74
75 <!-- iframe showing the search results (closed by default) -->
76 <div id="MSearchResultsWindow">
77 <iframe src="javascript:void(0)" frameborder="0" 
78         name="MSearchResults" id="MSearchResults">
79 </iframe>
80 </div>
81
82 </div><!-- top -->
83 <div class="header">
84   <div class="summary">
85 <a href="#pub-attribs">Data Fields</a>  </div>
86   <div class="headertitle">
87 <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>
88 </div><!--header-->
89 <div class="contents">
90
91 <p>Cropping region.  
92  <a href="structtjregion.html#details">More...</a></p>
93
94 <p><code>#include &lt;turbojpeg.h&gt;</code></p>
95 <table class="memberdecls">
96 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
97 Data Fields</h2></td></tr>
98 <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>
99 <tr class="memdesc:a4b6a37a93997091b26a75831fa291ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The left boundary of the cropping region.  <a href="#a4b6a37a93997091b26a75831fa291ad9">More...</a><br/></td></tr>
100 <tr class="separator:a4b6a37a93997091b26a75831fa291ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <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>
102 <tr class="memdesc:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The upper boundary of the cropping region.  <a href="#a7b3e0c24cfe87acc80e334cafdcf22c2">More...</a><br/></td></tr>
103 <tr class="separator:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <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>
105 <tr class="memdesc:ab6eb73ceef584fc23c8c8097926dce42"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the cropping region.  <a href="#ab6eb73ceef584fc23c8c8097926dce42">More...</a><br/></td></tr>
106 <tr class="separator:ab6eb73ceef584fc23c8c8097926dce42"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <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>
108 <tr class="memdesc:aecefc45a26f4d8b60dd4d825c1710115"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the cropping region.  <a href="#aecefc45a26f4d8b60dd4d825c1710115">More...</a><br/></td></tr>
109 <tr class="separator:aecefc45a26f4d8b60dd4d825c1710115"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 </table>
111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
112 <div class="textblock"><p>Cropping region. </p>
113 </div><h2 class="groupheader">Field Documentation</h2>
114 <a class="anchor" id="aecefc45a26f4d8b60dd4d825c1710115"></a>
115 <div class="memitem">
116 <div class="memproto">
117       <table class="memname">
118         <tr>
119           <td class="memname">int tjregion::h</td>
120         </tr>
121       </table>
122 </div><div class="memdoc">
123
124 <p>The height of the cropping region. </p>
125 <p>Setting this to 0 is the equivalent of setting it to the height of the source JPEG image - y. </p>
126
127 </div>
128 </div>
129 <a class="anchor" id="ab6eb73ceef584fc23c8c8097926dce42"></a>
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname">int tjregion::w</td>
135         </tr>
136       </table>
137 </div><div class="memdoc">
138
139 <p>The width of the cropping region. </p>
140 <p>Setting this to 0 is the equivalent of setting it to the width of the source JPEG image - x. </p>
141
142 </div>
143 </div>
144 <a class="anchor" id="a4b6a37a93997091b26a75831fa291ad9"></a>
145 <div class="memitem">
146 <div class="memproto">
147       <table class="memname">
148         <tr>
149           <td class="memname">int tjregion::x</td>
150         </tr>
151       </table>
152 </div><div class="memdoc">
153
154 <p>The left boundary of the cropping region. </p>
155 <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>
156
157 </div>
158 </div>
159 <a class="anchor" id="a7b3e0c24cfe87acc80e334cafdcf22c2"></a>
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname">int tjregion::y</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168
169 <p>The upper boundary of the cropping region. </p>
170 <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>
171
172 </div>
173 </div>
174 <hr/>The documentation for this struct was generated from the following file:<ul>
175 <li>turbojpeg.h</li>
176 </ul>
177 </div><!-- contents -->
178 <!-- start footer part -->
179 <hr class="footer"/><address class="footer"><small>
180 Generated by &#160;<a href="http://www.doxygen.org/index.html">
181 <img class="footer" src="doxygen.png" alt="doxygen"/>
182 </a> 1.8.3.1
183 </small></address>
184 </body>
185 </html>