blob: 72d49d2706b4cab69926a424cac7843b3490098f [file] [log] [blame]
DRC2d14fc22020-10-01 14:35:46 -05001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
DRC9b28def2011-05-21 14:37:15 +00002<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"/>
DRC2d14fc22020-10-01 14:35:46 -05006<meta name="generator" content="Doxygen 1.8.20"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
DRC9b28def2011-05-21 14:37:15 +00008<title>TurboJPEG: tjregion Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
DRCa4a48ed2013-08-18 08:47:03 +000010<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
DRC9b28def2011-05-21 14:37:15 +000012<link href="search/search.css" rel="stylesheet" type="text/css"/>
DRC2d14fc22020-10-01 14:35:46 -050013<script type="text/javascript" src="search/searchdata.js"></script>
DRC9b28def2011-05-21 14:37:15 +000014<script type="text/javascript" src="search/search.js"></script>
DRCa4a48ed2013-08-18 08:47:03 +000015<link href="doxygen.css" rel="stylesheet" type="text/css" />
DRCc71ab2f2014-08-10 16:43:31 +000016<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
DRC9b28def2011-05-21 14:37:15 +000017</head>
DRCa4a48ed2013-08-18 08:47:03 +000018<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
DRC9b28def2011-05-21 14:37:15 +000020<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
DRC2d14fc22020-10-01 14:35:46 -050024 <td id="projectalign" style="padding-left: 0.5em;">
DRCa4a48ed2013-08-18 08:47:03 +000025 <div id="projectname">TurboJPEG
DRCba22c0f2022-06-24 14:03:03 -050026 &#160;<span id="projectnumber">2.1.4</span>
DRCa4a48ed2013-08-18 08:47:03 +000027 </div>
DRC9b28def2011-05-21 14:37:15 +000028 </td>
29 </tr>
30 </tbody>
31</table>
32</div>
DRCa4a48ed2013-08-18 08:47:03 +000033<!-- end header part -->
DRC2d14fc22020-10-01 14:35:46 -050034<!-- Generated by Doxygen 1.8.20 -->
DRCa4a48ed2013-08-18 08:47:03 +000035<script type="text/javascript">
DRC2d14fc22020-10-01 14:35:46 -050036/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
DRCa4a48ed2013-08-18 08:47:03 +000037var searchBox = new SearchBox("searchBox", "search",false,'Search');
DRC2d14fc22020-10-01 14:35:46 -050038/* @license-end */
DRCa4a48ed2013-08-18 08:47:03 +000039</script>
DRC2d14fc22020-10-01 14:35:46 -050040<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>
DRCa4a48ed2013-08-18 08:47:03 +000050<!-- 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)">
DRC2d14fc22020-10-01 14:35:46 -050055</div>
DRCa4a48ed2013-08-18 08:47:03 +000056
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>
DRC9b28def2011-05-21 14:37:15 +000062</div>
DRCa4a48ed2013-08-18 08:47:03 +000063
64</div><!-- top -->
DRC9b28def2011-05-21 14:37:15 +000065<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>
DRCa4a48ed2013-08-18 08:47:03 +000070</div><!--header-->
DRC9b28def2011-05-21 14:37:15 +000071<div class="contents">
DRCa4a48ed2013-08-18 08:47:03 +000072
DRC9b28def2011-05-21 14:37:15 +000073<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">
DRCa4a48ed2013-08-18 08:47:03 +000078<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
DRC9b28def2011-05-21 14:37:15 +000079Data Fields</h2></td></tr>
DRCa4a48ed2013-08-18 08:47:03 +000080<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>
DRC2d14fc22020-10-01 14:35:46 -050081<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>
DRCa4a48ed2013-08-18 08:47:03 +000082<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>
DRC2d14fc22020-10-01 14:35:46 -050084<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>
DRCa4a48ed2013-08-18 08:47:03 +000085<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>
DRC2d14fc22020-10-01 14:35:46 -050087<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>
DRCa4a48ed2013-08-18 08:47:03 +000088<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>
DRC2d14fc22020-10-01 14:35:46 -050090<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>
DRCa4a48ed2013-08-18 08:47:03 +000091<tr class="separator:aecefc45a26f4d8b60dd4d825c1710115"><td class="memSeparator" colspan="2">&#160;</td></tr>
DRC9b28def2011-05-21 14:37:15 +000092</table>
DRCa4a48ed2013-08-18 08:47:03 +000093<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
DRC9b28def2011-05-21 14:37:15 +000094<div class="textblock"><p>Cropping region. </p>
DRCa4a48ed2013-08-18 08:47:03 +000095</div><h2 class="groupheader">Field Documentation</h2>
DRC2d14fc22020-10-01 14:35:46 -050096<a id="aecefc45a26f4d8b60dd4d825c1710115"></a>
97<h2 class="memtitle"><span class="permalink"><a href="#aecefc45a26f4d8b60dd4d825c1710115">&#9670;&nbsp;</a></span>h</h2>
98
DRC9b28def2011-05-21 14:37:15 +000099<div class="memitem">
100<div class="memproto">
101 <table class="memname">
102 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000103 <td class="memname">int tjregion::h</td>
DRC9b28def2011-05-21 14:37:15 +0000104 </tr>
105 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000106</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000107
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>
DRC2d14fc22020-10-01 14:35:46 -0500113<a id="ab6eb73ceef584fc23c8c8097926dce42"></a>
114<h2 class="memtitle"><span class="permalink"><a href="#ab6eb73ceef584fc23c8c8097926dce42">&#9670;&nbsp;</a></span>w</h2>
115
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::w</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 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>
DRC2d14fc22020-10-01 14:35:46 -0500130<a id="a4b6a37a93997091b26a75831fa291ad9"></a>
131<h2 class="memtitle"><span class="permalink"><a href="#a4b6a37a93997091b26a75831fa291ad9">&#9670;&nbsp;</a></span>x</h2>
132
DRC9b28def2011-05-21 14:37:15 +0000133<div class="memitem">
134<div class="memproto">
135 <table class="memname">
136 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000137 <td class="memname">int tjregion::x</td>
DRC9b28def2011-05-21 14:37:15 +0000138 </tr>
139 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000140</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000141
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>
DRC2d14fc22020-10-01 14:35:46 -0500147<a id="a7b3e0c24cfe87acc80e334cafdcf22c2"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#a7b3e0c24cfe87acc80e334cafdcf22c2">&#9670;&nbsp;</a></span>y</h2>
149
DRC9b28def2011-05-21 14:37:15 +0000150<div class="memitem">
151<div class="memproto">
152 <table class="memname">
153 <tr>
DRCa4a48ed2013-08-18 08:47:03 +0000154 <td class="memname">int tjregion::y</td>
DRC9b28def2011-05-21 14:37:15 +0000155 </tr>
156 </table>
DRCa4a48ed2013-08-18 08:47:03 +0000157</div><div class="memdoc">
DRC9b28def2011-05-21 14:37:15 +0000158
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>
DRCa4a48ed2013-08-18 08:47:03 +0000167</div><!-- contents -->
168<!-- start footer part -->
169<hr class="footer"/><address class="footer"><small>
DRC2d14fc22020-10-01 14:35:46 -0500170Generated 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
DRCa4a48ed2013-08-18 08:47:03 +0000171</small></address>
DRC9b28def2011-05-21 14:37:15 +0000172</body>
173</html>