kc3-lang/libjpeg-turbo/doc/turbojpeg/structtjregion.html
-
Show log
Commit
-
Hash : e69dd40c
Author :
Date : 2024-01-23T13:26:41
Reorganize source to make things easier to find - Move all libjpeg documentation, except for README.ijg, into the doc/ subdirectory. - Move the TurboJPEG C API documentation from doc/html/ into doc/turbojpeg/. - Move all C source code and headers into a src/ subdirectory. - Move turbojpeg-jni.c into the java/ subdirectory. Referring to #226, there is no ideal solution to this problem. A semantically ideal solution would have involved placing all source code, including the SIMD and Java source code, under src/ (or perhaps placing C library source code under lib/ and C test program source code under test/), all header files under include/, and all documentation under doc/. However: - To me it makes more sense to have separate top-level directories for each language, since the SIMD extensions and the Java API are technically optional features. src/ now contains only the code that is relevant to the core C API libraries and associated programs. - I didn't want to bury the java/ and simd/ directories or add a level of depth to them, since both directories already contain source code that is 3-4 levels deep. - I would prefer not to separate the header files from the C source code, because: 1. It would be disruptive. libjpeg and libjpeg-turbo have historically placed C source code and headers in the same directory, and people who are familiar with both projects (self included) are used to looking for the headers in the same directory as the C source code. 2. In terms of how the headers are used internally in libjpeg-turbo, the distinction between public and private headers is a bit fuzzy. - It didn't make sense to separate the test source code from the library source code, since there is not a clear distinction in some cases. (For instance, the IJG image I/O functions are used by cjpeg and djpeg as well as by the TurboJPEG API.) This solution is minimally disruptive, since it keeps all C source code and headers together and keeps java/ and simd/ as top-level directories. It is a bit awkward, because java/ and simd/ technically contain source code, even though they are not under src/. However, other solutions would have been more awkward for different reasons. Closes #226
-
doc/turbojpeg/structtjregion.html
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.9.8"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>TurboJPEG: tjregion Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">TurboJPEG<span id="projectnumber"> 3.0.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.9.8 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */ </script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <div id="MSearchResults"> <div class="SRPage"> <div id="SRIndex"> <div id="SRResults"></div> <div class="SRStatus" id="Loading">Loading...</div> <div class="SRStatus" id="Searching">Searching...</div> <div class="SRStatus" id="NoMatches">No Matches</div> </div> </div> </div> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"><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> </div><!--header--> <div class="contents"> <p>Cropping region. <a href="structtjregion.html#details">More...</a></p> <p><code>#include <turbojpeg.h></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a4b6a37a93997091b26a75831fa291ad9" id="r_a4b6a37a93997091b26a75831fa291ad9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#a4b6a37a93997091b26a75831fa291ad9">x</a></td></tr> <tr class="memdesc:a4b6a37a93997091b26a75831fa291ad9"><td class="mdescLeft"> </td><td class="mdescRight">The left boundary of the cropping region. <br /></td></tr> <tr class="separator:a4b6a37a93997091b26a75831fa291ad9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b3e0c24cfe87acc80e334cafdcf22c2" id="r_a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#a7b3e0c24cfe87acc80e334cafdcf22c2">y</a></td></tr> <tr class="memdesc:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="mdescLeft"> </td><td class="mdescRight">The upper boundary of the cropping region. <br /></td></tr> <tr class="separator:a7b3e0c24cfe87acc80e334cafdcf22c2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab6eb73ceef584fc23c8c8097926dce42" id="r_ab6eb73ceef584fc23c8c8097926dce42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#ab6eb73ceef584fc23c8c8097926dce42">w</a></td></tr> <tr class="memdesc:ab6eb73ceef584fc23c8c8097926dce42"><td class="mdescLeft"> </td><td class="mdescRight">The width of the cropping region. <br /></td></tr> <tr class="separator:ab6eb73ceef584fc23c8c8097926dce42"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aecefc45a26f4d8b60dd4d825c1710115" id="r_aecefc45a26f4d8b60dd4d825c1710115"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structtjregion.html#aecefc45a26f4d8b60dd4d825c1710115">h</a></td></tr> <tr class="memdesc:aecefc45a26f4d8b60dd4d825c1710115"><td class="mdescLeft"> </td><td class="mdescRight">The height of the cropping region. <br /></td></tr> <tr class="separator:aecefc45a26f4d8b60dd4d825c1710115"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Cropping region. </p> </div><h2 class="groupheader">Field Documentation</h2> <a id="aecefc45a26f4d8b60dd4d825c1710115" name="aecefc45a26f4d8b60dd4d825c1710115"></a> <h2 class="memtitle"><span class="permalink"><a href="#aecefc45a26f4d8b60dd4d825c1710115">◆ </a></span>h</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int tjregion::h</td> </tr> </table> </div><div class="memdoc"> <p>The height of the cropping region. </p> <p>Setting this to 0 is the equivalent of setting it to the height of the source JPEG image - y. </p> </div> </div> <a id="ab6eb73ceef584fc23c8c8097926dce42" name="ab6eb73ceef584fc23c8c8097926dce42"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab6eb73ceef584fc23c8c8097926dce42">◆ </a></span>w</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int tjregion::w</td> </tr> </table> </div><div class="memdoc"> <p>The width of the cropping region. </p> <p>Setting this to 0 is the equivalent of setting it to the width of the source JPEG image - x. </p> </div> </div> <a id="a4b6a37a93997091b26a75831fa291ad9" name="a4b6a37a93997091b26a75831fa291ad9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4b6a37a93997091b26a75831fa291ad9">◆ </a></span>x</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int tjregion::x</td> </tr> </table> </div><div class="memdoc"> <p>The left boundary of the cropping region. </p> <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> </div> </div> <a id="a7b3e0c24cfe87acc80e334cafdcf22c2" name="a7b3e0c24cfe87acc80e334cafdcf22c2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7b3e0c24cfe87acc80e334cafdcf22c2">◆ </a></span>y</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int tjregion::y</td> </tr> </table> </div><div class="memdoc"> <p>The upper boundary of the cropping region. </p> <p>For lossless transformation, 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> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><b>turbojpeg.h</b></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </small></address> </body> </html>