blob: 36c0afac65263043e189b77809d931e7770ff1e6 [file] [log] [blame]
DRC9b28def2011-05-21 14:37:15 +00001<!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"/>
DRCa4a48ed2013-08-18 08:47:03 +00005<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.3.1"/>
DRC9b28def2011-05-21 14:37:15 +00007<title>TurboJPEG: tjregion Struct Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
DRCa4a48ed2013-08-18 08:47:03 +00009<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
DRC9b28def2011-05-21 14:37:15 +000011<link href="search/search.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="search/search.js"></script>
DRCa4a48ed2013-08-18 08:47:03 +000013<script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
15</script>
16<link href="doxygen.css" rel="stylesheet" type="text/css" />
DRCc71ab2f2014-08-10 16:43:31 +000017<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
DRC9b28def2011-05-21 14:37:15 +000018</head>
DRCa4a48ed2013-08-18 08:47:03 +000019<body>
20<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
DRC9b28def2011-05-21 14:37:15 +000021<div id="titlearea">
22<table cellspacing="0" cellpadding="0">
23 <tbody>
24 <tr style="height: 56px;">
25 <td style="padding-left: 0.5em;">
DRCa4a48ed2013-08-18 08:47:03 +000026 <div id="projectname">TurboJPEG
DRCb9ab64d2017-05-11 21:02:29 -050027 &#160;<span id="projectnumber">1.6</span>
DRCa4a48ed2013-08-18 08:47:03 +000028 </div>
DRC9b28def2011-05-21 14:37:15 +000029 </td>
30 </tr>
31 </tbody>
32</table>
33</div>
DRCa4a48ed2013-08-18 08:47:03 +000034<!-- end header part -->
35<!-- Generated by Doxygen 1.8.3.1 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
DRC9b28def2011-05-21 14:37:15 +000039 <div id="navrow1" class="tabs">
40 <ul class="tablist">
41 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42 <li><a href="modules.html"><span>Modules</span></a></li>
43 <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
DRCa4a48ed2013-08-18 08:47:03 +000044 <li>
DRC9b28def2011-05-21 14:37:15 +000045 <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59 </li>
60 </ul>
61 </div>
62 <div id="navrow2" class="tabs2">
63 <ul class="tablist">
64 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
65 <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
66 <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
67 </ul>
68 </div>
DRCa4a48ed2013-08-18 08:47:03 +000069<!-- window showing the filter options -->
70<div id="MSearchSelectWindow"
71 onmouseover="return searchBox.OnSearchSelectShow()"
72 onmouseout="return searchBox.OnSearchSelectHide()"
73 onkeydown="return searchBox.OnSearchSelectKey(event)">
74<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>
75
76<!-- iframe showing the search results (closed by default) -->
77<div id="MSearchResultsWindow">
78<iframe src="javascript:void(0)" frameborder="0"
79 name="MSearchResults" id="MSearchResults">
80</iframe>
DRC9b28def2011-05-21 14:37:15 +000081</div>
DRCa4a48ed2013-08-18 08:47:03 +000082
83</div><!-- top -->
DRC9b28def2011-05-21 14:37:15 +000084<div class="header">
85 <div class="summary">
86<a href="#pub-attribs">Data Fields</a> </div>
87 <div class="headertitle">
88<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>
DRCa4a48ed2013-08-18 08:47:03 +000089</div><!--header-->
DRC9b28def2011-05-21 14:37:15 +000090<div class="contents">
DRCa4a48ed2013-08-18 08:47:03 +000091
DRC9b28def2011-05-21 14:37:15 +000092<p>Cropping region.
93 <a href="structtjregion.html#details">More...</a></p>
94
95<p><code>#include &lt;turbojpeg.h&gt;</code></p>
96<table class="memberdecls">
DRCa4a48ed2013-08-18 08:47:03 +000097<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
DRC9b28def2011-05-21 14:37:15 +000098Data Fields</h2></td></tr>
DRCa4a48ed2013-08-18 08:47:03 +000099<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>
100<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>
101<tr class="separator:a4b6a37a93997091b26a75831fa291ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
102<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>
103<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>
104<tr class="separator:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
105<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>
106<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>
107<tr class="separator:ab6eb73ceef584fc23c8c8097926dce42"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<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>
109<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>
110<tr class="separator:aecefc45a26f4d8b60dd4d825c1710115"><td class="memSeparator" colspan="2">&#160;</td></tr>
DRC9b28def2011-05-21 14:37:15 +0000111</table>
DRCa4a48ed2013-08-18 08:47:03 +0000112<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
DRC9b28def2011-05-21 14:37:15 +0000113<div class="textblock"><p>Cropping region. </p>
DRCa4a48ed2013-08-18 08:47:03 +0000114</div><h2 class="groupheader">Field Documentation</h2>
115<a class="anchor" id="aecefc45a26f4d8b60dd4d825c1710115"></a>
DRC9b28def2011-05-21 14:37:15 +0000116<div class="memitem">
117<div class="memproto">
118 <table class="memname">
119 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000120 <td class="memname">int tjregion::h</td>
DRC9b28def2011-05-21 14:37:15 +0000121 </tr>
122 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000123</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000124
125<p>The height of the cropping region. </p>
126<p>Setting this to 0 is the equivalent of setting it to the height of the source JPEG image - y. </p>
127
128</div>
129</div>
DRCa4a48ed2013-08-18 08:47:03 +0000130<a class="anchor" id="ab6eb73ceef584fc23c8c8097926dce42"></a>
DRC9b28def2011-05-21 14:37:15 +0000131<div class="memitem">
132<div class="memproto">
133 <table class="memname">
134 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000135 <td class="memname">int tjregion::w</td>
DRC9b28def2011-05-21 14:37:15 +0000136 </tr>
137 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000138</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000139
140<p>The width of the cropping region. </p>
141<p>Setting this to 0 is the equivalent of setting it to the width of the source JPEG image - x. </p>
142
143</div>
144</div>
DRCa4a48ed2013-08-18 08:47:03 +0000145<a class="anchor" id="a4b6a37a93997091b26a75831fa291ad9"></a>
DRC9b28def2011-05-21 14:37:15 +0000146<div class="memitem">
147<div class="memproto">
148 <table class="memname">
149 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000150 <td class="memname">int tjregion::x</td>
DRC9b28def2011-05-21 14:37:15 +0000151 </tr>
152 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000153</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000154
155<p>The left boundary of the cropping region. </p>
156<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>
157
158</div>
159</div>
DRCa4a48ed2013-08-18 08:47:03 +0000160<a class="anchor" id="a7b3e0c24cfe87acc80e334cafdcf22c2"></a>
DRC9b28def2011-05-21 14:37:15 +0000161<div class="memitem">
162<div class="memproto">
163 <table class="memname">
164 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000165 <td class="memname">int tjregion::y</td>
DRC9b28def2011-05-21 14:37:15 +0000166 </tr>
167 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000168</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000169
170<p>The upper boundary of the cropping region. </p>
171<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>
172
173</div>
174</div>
175<hr/>The documentation for this struct was generated from the following file:<ul>
176<li>turbojpeg.h</li>
177</ul>
DRCa4a48ed2013-08-18 08:47:03 +0000178</div><!-- contents -->
179<!-- start footer part -->
180<hr class="footer"/><address class="footer"><small>
DRCca866c42013-08-18 09:37:48 +0000181Generated by &#160;<a href="http://www.doxygen.org/index.html">
DRCa4a48ed2013-08-18 08:47:03 +0000182<img class="footer" src="doxygen.png" alt="doxygen"/>
183</a> 1.8.3.1
184</small></address>
DRC9b28def2011-05-21 14:37:15 +0000185</body>
186</html>