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