You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

178 lines
18 KiB

1 year ago
  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.5"/>
  7. <title>Face Engine SDK: include/fsdk/Version.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/search.js"></script>
  20. <script type="text/javascript">
  21. $(document).ready(function() { searchBox.OnSelectItem(0); });
  22. </script>
  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  24. </head>
  25. <body>
  26. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  27. <div id="titlearea">
  28. <table cellspacing="0" cellpadding="0">
  29. <tbody>
  30. <tr style="height: 56px;">
  31. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  32. <td style="padding-left: 0.5em;">
  33. <div id="projectname">Face Engine SDK
  34. &#160;<span id="projectnumber">5.8.0</span>
  35. </div>
  36. <div id="projectbrief">A face detection, recognition and tracking engine.</div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.5 -->
  44. <script type="text/javascript">
  45. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  46. </script>
  47. <div id="navrow1" class="tabs">
  48. <ul class="tablist">
  49. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  50. <li><a href="modules.html"><span>Modules</span></a></li>
  51. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  52. <li><a href="annotated.html"><span>Classes</span></a></li>
  53. <li class="current"><a href="files.html"><span>Files</span></a></li>
  54. <li>
  55. <div id="MSearchBox" class="MSearchBoxInactive">
  56. <span class="left">
  57. <img id="MSearchSelect" src="search/mag_sel.png"
  58. onmouseover="return searchBox.OnSearchSelectShow()"
  59. onmouseout="return searchBox.OnSearchSelectHide()"
  60. alt=""/>
  61. <input type="text" id="MSearchField" value="Search" accesskey="S"
  62. onfocus="searchBox.OnSearchFieldFocus(true)"
  63. onblur="searchBox.OnSearchFieldFocus(false)"
  64. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  65. </span><span class="right">
  66. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  67. </span>
  68. </div>
  69. </li>
  70. </ul>
  71. </div>
  72. <div id="navrow2" class="tabs2">
  73. <ul class="tablist">
  74. <li><a href="files.html"><span>File&#160;List</span></a></li>
  75. <li><a href="globals.html"><span>File&#160;Members</span></a></li>
  76. </ul>
  77. </div>
  78. </div><!-- top -->
  79. <div id="side-nav" class="ui-resizable side-nav-resizable">
  80. <div id="nav-tree">
  81. <div id="nav-tree-contents">
  82. <div id="nav-sync" class="sync"></div>
  83. </div>
  84. </div>
  85. <div id="splitbar" style="-moz-user-select:none;"
  86. class="ui-resizable-handle">
  87. </div>
  88. </div>
  89. <script type="text/javascript">
  90. $(document).ready(function(){initNavTree('_version_8h_source.html','');});
  91. </script>
  92. <div id="doc-content">
  93. <!-- window showing the filter options -->
  94. <div id="MSearchSelectWindow"
  95. onmouseover="return searchBox.OnSearchSelectShow()"
  96. onmouseout="return searchBox.OnSearchSelectHide()"
  97. onkeydown="return searchBox.OnSearchSelectKey(event)">
  98. <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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  99. <!-- iframe showing the search results (closed by default) -->
  100. <div id="MSearchResultsWindow">
  101. <iframe src="javascript:void(0)" frameborder="0"
  102. name="MSearchResults" id="MSearchResults">
  103. </iframe>
  104. </div>
  105. <div class="header">
  106. <div class="headertitle">
  107. <div class="title">Version.h</div> </div>
  108. </div><!--header-->
  109. <div class="contents">
  110. <a href="_version_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
  111. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#pragma once</span></div>
  112. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span></div>
  113. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_def_8h.html">Def.h</a>&quot;</span></div>
  114. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
  115. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
  116. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span>fsdk {</div>
  117. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
  118. <div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structfsdk_1_1_version.html"> 24</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structfsdk_1_1_version.html">Version</a> {</div>
  119. <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfsdk_1_1_version.html#aa51eaf974da4d0a2fdc3bd41bd43df36"> 25</a></span>&#160; uint8_t <a class="code" href="structfsdk_1_1_version.html#aa51eaf974da4d0a2fdc3bd41bd43df36">major</a>; </div>
  120. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structfsdk_1_1_version.html#a6ac214dbaed6cb0c9af597a0ce45fa73"> 26</a></span>&#160; uint8_t <a class="code" href="structfsdk_1_1_version.html#a6ac214dbaed6cb0c9af597a0ce45fa73">minor</a>; </div>
  121. <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structfsdk_1_1_version.html#a720d91d998895868039802a5e26f0df2"> 27</a></span>&#160; uint16_t <a class="code" href="structfsdk_1_1_version.html#a720d91d998895868039802a5e26f0df2">patch</a>; </div>
  122. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; };</div>
  123. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
  124. <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="group___version_group.html#gad429c6eae9f032debb9416947550009b"> 36</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="group___version_group.html#gad429c6eae9f032debb9416947550009b">operator &lt; </a>(<a class="code" href="structfsdk_1_1_version.html">Version</a> lhs, <a class="code" href="structfsdk_1_1_version.html">Version</a> rhs) noexcept {</div>
  125. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> (lhs.major &lt; rhs.major)</div>
  126. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  127. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">if</span> (lhs.minor &lt; rhs.minor)</div>
  128. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
  129. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> lhs.patch &lt; rhs.patch;</div>
  130. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div>
  131. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
  132. <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group___version_group.html#gaa1f550339ca96028e8c0115d201e02a0"> 50</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="group___version_group.html#gaa1f550339ca96028e8c0115d201e02a0">operator == </a>(<a class="code" href="structfsdk_1_1_version.html">Version</a> lhs, <a class="code" href="structfsdk_1_1_version.html">Version</a> rhs) noexcept {</div>
  133. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> lhs.major == rhs.major &amp;&amp; </div>
  134. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; lhs.minor == rhs.minor &amp;&amp; </div>
  135. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; lhs.patch == rhs.patch;</div>
  136. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
  137. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
  138. <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group___version_group.html#ga525b65b20d219073604d14d7d845bf14"> 62</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="group___version_group.html#ga525b65b20d219073604d14d7d845bf14">operator != </a>(<a class="code" href="structfsdk_1_1_version.html">Version</a> lhs, <a class="code" href="structfsdk_1_1_version.html">Version</a> rhs) noexcept {</div>
  139. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> !(lhs == rhs);</div>
  140. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div>
  141. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
  142. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> Version <a class="code" href="group___version_group.html#gadf18bd918c6a2390201ce2110ef17717">getVersion</a>() noexcept;</div>
  143. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
  144. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const <span class="keywordtype">char</span>* <a class="code" href="group___version_group.html#gadc959b5a3e56b4c12f7c19e01c8091c7">getVersionHash</a>() noexcept;</div>
  145. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
  146. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const <span class="keywordtype">char</span>* <a class="code" href="group___version_group.html#ga34ebbd7511e7bda7ace0f6a65d8cea12">getVersionString</a>() noexcept;</div>
  147. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
  148. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="code" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const <span class="keywordtype">char</span>* <a class="code" href="group___version_group.html#gac221ff93065b829ca0e059f0dfa248e3">getBuildInfo</a>() noexcept;</div>
  149. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// end of VersionGroup</span></div>
  150. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;}</div>
  151. <div class="ttc" id="_def_8h_html_a5dc4c3043f171426dafe6fc800218945"><div class="ttname"><a href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a></div><div class="ttdeci">#define FSDK_API</div><div class="ttdoc">Dummy. </div><div class="ttdef"><b>Definition:</b> Def.h:27</div></div>
  152. <div class="ttc" id="structfsdk_1_1_version_html_aa51eaf974da4d0a2fdc3bd41bd43df36"><div class="ttname"><a href="structfsdk_1_1_version.html#aa51eaf974da4d0a2fdc3bd41bd43df36">fsdk::Version::major</a></div><div class="ttdeci">uint8_t major</div><div class="ttdoc">Major version number. </div><div class="ttdef"><b>Definition:</b> Version.h:25</div></div>
  153. <div class="ttc" id="group___version_group_html_ga34ebbd7511e7bda7ace0f6a65d8cea12"><div class="ttname"><a href="group___version_group.html#ga34ebbd7511e7bda7ace0f6a65d8cea12">fsdk::getVersionString</a></div><div class="ttdeci">FSDK_API const char * getVersionString() noexcept</div><div class="ttdoc">Get FaceEngine version string. </div></div>
  154. <div class="ttc" id="structfsdk_1_1_version_html"><div class="ttname"><a href="structfsdk_1_1_version.html">fsdk::Version</a></div><div class="ttdef"><b>Definition:</b> Version.h:24</div></div>
  155. <div class="ttc" id="group___version_group_html_gaa1f550339ca96028e8c0115d201e02a0"><div class="ttname"><a href="group___version_group.html#gaa1f550339ca96028e8c0115d201e02a0">fsdk::operator==</a></div><div class="ttdeci">bool operator==(Version lhs, Version rhs) noexcept</div><div class="ttdoc">Check if versions are equal. </div><div class="ttdef"><b>Definition:</b> Version.h:50</div></div>
  156. <div class="ttc" id="structfsdk_1_1_version_html_a6ac214dbaed6cb0c9af597a0ce45fa73"><div class="ttname"><a href="structfsdk_1_1_version.html#a6ac214dbaed6cb0c9af597a0ce45fa73">fsdk::Version::minor</a></div><div class="ttdeci">uint8_t minor</div><div class="ttdoc">Minor version number. </div><div class="ttdef"><b>Definition:</b> Version.h:26</div></div>
  157. <div class="ttc" id="_def_8h_html"><div class="ttname"><a href="_def_8h.html">Def.h</a></div><div class="ttdoc">Common SDK definitions. </div></div>
  158. <div class="ttc" id="group___version_group_html_gad429c6eae9f032debb9416947550009b"><div class="ttname"><a href="group___version_group.html#gad429c6eae9f032debb9416947550009b">fsdk::operator&lt;</a></div><div class="ttdeci">bool operator&lt;(Version lhs, Version rhs) noexcept</div><div class="ttdoc">Check if one version is less than another. </div><div class="ttdef"><b>Definition:</b> Version.h:36</div></div>
  159. <div class="ttc" id="group___version_group_html_gadc959b5a3e56b4c12f7c19e01c8091c7"><div class="ttname"><a href="group___version_group.html#gadc959b5a3e56b4c12f7c19e01c8091c7">fsdk::getVersionHash</a></div><div class="ttdeci">FSDK_API const char * getVersionHash() noexcept</div><div class="ttdoc">Get FaceEngine commit hash. </div></div>
  160. <div class="ttc" id="group___version_group_html_ga525b65b20d219073604d14d7d845bf14"><div class="ttname"><a href="group___version_group.html#ga525b65b20d219073604d14d7d845bf14">fsdk::operator!=</a></div><div class="ttdeci">bool operator!=(Version lhs, Version rhs) noexcept</div><div class="ttdoc">Check if versions are not equal. </div><div class="ttdef"><b>Definition:</b> Version.h:62</div></div>
  161. <div class="ttc" id="structfsdk_1_1_version_html_a720d91d998895868039802a5e26f0df2"><div class="ttname"><a href="structfsdk_1_1_version.html#a720d91d998895868039802a5e26f0df2">fsdk::Version::patch</a></div><div class="ttdeci">uint16_t patch</div><div class="ttdoc">Revision number. </div><div class="ttdef"><b>Definition:</b> Version.h:27</div></div>
  162. <div class="ttc" id="group___version_group_html_gac221ff93065b829ca0e059f0dfa248e3"><div class="ttname"><a href="group___version_group.html#gac221ff93065b829ca0e059f0dfa248e3">fsdk::getBuildInfo</a></div><div class="ttdeci">FSDK_API const char * getBuildInfo() noexcept</div><div class="ttdoc">Get FaceEngine build description. The descripton contains used flags and compler settings. </div></div>
  163. <div class="ttc" id="group___version_group_html_gadf18bd918c6a2390201ce2110ef17717"><div class="ttname"><a href="group___version_group.html#gadf18bd918c6a2390201ce2110ef17717">fsdk::getVersion</a></div><div class="ttdeci">FSDK_API Version getVersion() noexcept</div><div class="ttdoc">Get FaceEngine version. </div></div>
  164. </div><!-- fragment --></div><!-- contents -->
  165. </div><!-- doc-content -->
  166. <!-- start footer part -->
  167. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  168. <ul>
  169. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f55a93227fda83d5dd4a3d796702467d.html">fsdk</a></li><li class="navelem"><a class="el" href="_version_8h.html">Version.h</a></li>
  170. <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
  171. <a href="http://www.doxygen.org/index.html">
  172. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
  173. </ul>
  174. </div>
  175. </body>
  176. </html>