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.

392 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: Version</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><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><!-- top -->
  73. <div id="side-nav" class="ui-resizable side-nav-resizable">
  74. <div id="nav-tree">
  75. <div id="nav-tree-contents">
  76. <div id="nav-sync" class="sync"></div>
  77. </div>
  78. </div>
  79. <div id="splitbar" style="-moz-user-select:none;"
  80. class="ui-resizable-handle">
  81. </div>
  82. </div>
  83. <script type="text/javascript">
  84. $(document).ready(function(){initNavTree('group___version_group.html','');});
  85. </script>
  86. <div id="doc-content">
  87. <!-- window showing the filter options -->
  88. <div id="MSearchSelectWindow"
  89. onmouseover="return searchBox.OnSearchSelectShow()"
  90. onmouseout="return searchBox.OnSearchSelectHide()"
  91. onkeydown="return searchBox.OnSearchSelectKey(event)">
  92. <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>
  93. <!-- iframe showing the search results (closed by default) -->
  94. <div id="MSearchResultsWindow">
  95. <iframe src="javascript:void(0)" frameborder="0"
  96. name="MSearchResults" id="MSearchResults">
  97. </iframe>
  98. </div>
  99. <div class="header">
  100. <div class="summary">
  101. <a href="#nested-classes">Classes</a> &#124;
  102. <a href="#func-members">Functions</a> </div>
  103. <div class="headertitle">
  104. <div class="title">Version</div> </div>
  105. </div><!--header-->
  106. <div class="contents">
  107. <p>SDK Build type and version info.
  108. <a href="#details">More...</a></p>
  109. <table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  111. Classes</h2></td></tr>
  112. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_version.html">fsdk::Version</a></td></tr>
  113. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table><table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  116. Functions</h2></td></tr>
  117. <tr class="memitem:gad429c6eae9f032debb9416947550009b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#gad429c6eae9f032debb9416947550009b">fsdk::operator&lt;</a> (Version lhs, Version rhs) noexcept</td></tr>
  118. <tr class="memdesc:gad429c6eae9f032debb9416947550009b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if one version is less than another. <a href="#gad429c6eae9f032debb9416947550009b">More...</a><br/></td></tr>
  119. <tr class="separator:gad429c6eae9f032debb9416947550009b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaa1f550339ca96028e8c0115d201e02a0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#gaa1f550339ca96028e8c0115d201e02a0">fsdk::operator==</a> (Version lhs, Version rhs) noexcept</td></tr>
  121. <tr class="memdesc:gaa1f550339ca96028e8c0115d201e02a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if versions are equal. <a href="#gaa1f550339ca96028e8c0115d201e02a0">More...</a><br/></td></tr>
  122. <tr class="separator:gaa1f550339ca96028e8c0115d201e02a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ga525b65b20d219073604d14d7d845bf14"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#ga525b65b20d219073604d14d7d845bf14">fsdk::operator!=</a> (Version lhs, Version rhs) noexcept</td></tr>
  124. <tr class="memdesc:ga525b65b20d219073604d14d7d845bf14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if versions are not equal. <a href="#ga525b65b20d219073604d14d7d845bf14">More...</a><br/></td></tr>
  125. <tr class="separator:ga525b65b20d219073604d14d7d845bf14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:gadf18bd918c6a2390201ce2110ef17717"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> Version&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#gadf18bd918c6a2390201ce2110ef17717">fsdk::getVersion</a> () noexcept</td></tr>
  127. <tr class="memdesc:gadf18bd918c6a2390201ce2110ef17717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FaceEngine version. <a href="#gadf18bd918c6a2390201ce2110ef17717">More...</a><br/></td></tr>
  128. <tr class="separator:gadf18bd918c6a2390201ce2110ef17717"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:gadc959b5a3e56b4c12f7c19e01c8091c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#gadc959b5a3e56b4c12f7c19e01c8091c7">fsdk::getVersionHash</a> () noexcept</td></tr>
  130. <tr class="memdesc:gadc959b5a3e56b4c12f7c19e01c8091c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FaceEngine commit hash. <a href="#gadc959b5a3e56b4c12f7c19e01c8091c7">More...</a><br/></td></tr>
  131. <tr class="separator:gadc959b5a3e56b4c12f7c19e01c8091c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ga34ebbd7511e7bda7ace0f6a65d8cea12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#ga34ebbd7511e7bda7ace0f6a65d8cea12">fsdk::getVersionString</a> () noexcept</td></tr>
  133. <tr class="memdesc:ga34ebbd7511e7bda7ace0f6a65d8cea12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FaceEngine version string. <a href="#ga34ebbd7511e7bda7ace0f6a65d8cea12">More...</a><br/></td></tr>
  134. <tr class="separator:ga34ebbd7511e7bda7ace0f6a65d8cea12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:gac221ff93065b829ca0e059f0dfa248e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___version_group.html#gac221ff93065b829ca0e059f0dfa248e3">fsdk::getBuildInfo</a> () noexcept</td></tr>
  136. <tr class="memdesc:gac221ff93065b829ca0e059f0dfa248e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get FaceEngine build description. The descripton contains used flags and compler settings. <a href="#gac221ff93065b829ca0e059f0dfa248e3">More...</a><br/></td></tr>
  137. <tr class="separator:gac221ff93065b829ca0e059f0dfa248e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table>
  139. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  140. <p>SDK Build type and version info. </p>
  141. <h2 class="groupheader">Function Documentation</h2>
  142. <a class="anchor" id="gac221ff93065b829ca0e059f0dfa248e3"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="mlabels">
  146. <tr>
  147. <td class="mlabels-left">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char* fsdk::getBuildInfo </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </td>
  157. <td class="mlabels-right">
  158. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Get FaceEngine build description. The descripton contains used flags and compler settings. </p>
  163. <dl class="section return"><dt>Returns</dt><dd>description as a null-terminated string. </dd></dl>
  164. </div>
  165. </div>
  166. <a class="anchor" id="gadf18bd918c6a2390201ce2110ef17717"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> Version fsdk::getVersion </td>
  175. <td>(</td>
  176. <td class="paramname"></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Get FaceEngine version. </p>
  187. <dl class="section return"><dt>Returns</dt><dd>filled version structure. </dd></dl>
  188. </div>
  189. </div>
  190. <a class="anchor" id="gadc959b5a3e56b4c12f7c19e01c8091c7"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char* fsdk::getVersionHash </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>Get FaceEngine commit hash. </p>
  211. <dl class="section return"><dt>Returns</dt><dd>commit hash as a null-terminated string. </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="ga34ebbd7511e7bda7ace0f6a65d8cea12"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const char* fsdk::getVersionString </td>
  223. <td>(</td>
  224. <td class="paramname"></td><td>)</td>
  225. <td></td>
  226. </tr>
  227. </table>
  228. </td>
  229. <td class="mlabels-right">
  230. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>Get FaceEngine version string. </p>
  235. <dl class="section return"><dt>Returns</dt><dd>version as a null-terminated string. </dd></dl>
  236. </div>
  237. </div>
  238. <a class="anchor" id="ga525b65b20d219073604d14d7d845bf14"></a>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="mlabels">
  242. <tr>
  243. <td class="mlabels-left">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">bool fsdk::operator!= </td>
  247. <td>(</td>
  248. <td class="paramtype">Version&#160;</td>
  249. <td class="paramname"><em>lhs</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">Version&#160;</td>
  255. <td class="paramname"><em>rhs</em>&#160;</td>
  256. </tr>
  257. <tr>
  258. <td></td>
  259. <td>)</td>
  260. <td></td><td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Check if versions are not equal. </p>
  270. <dl class="params"><dt>Parameters</dt><dd>
  271. <table class="params">
  272. <tr><td class="paramname">lhs</td><td>first version </td></tr>
  273. <tr><td class="paramname">rhs</td><td>second version </td></tr>
  274. </table>
  275. </dd>
  276. </dl>
  277. <dl class="section return"><dt>Returns</dt><dd>true if versions are not equal </dd></dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="gad429c6eae9f032debb9416947550009b"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="mlabels">
  284. <tr>
  285. <td class="mlabels-left">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">bool fsdk::operator&lt; </td>
  289. <td>(</td>
  290. <td class="paramtype">Version&#160;</td>
  291. <td class="paramname"><em>lhs</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">Version&#160;</td>
  297. <td class="paramname"><em>rhs</em>&#160;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Check if one version is less than another. </p>
  312. <dl class="params"><dt>Parameters</dt><dd>
  313. <table class="params">
  314. <tr><td class="paramname">lhs</td><td>first version </td></tr>
  315. <tr><td class="paramname">rhs</td><td>second version </td></tr>
  316. </table>
  317. </dd>
  318. </dl>
  319. <dl class="section return"><dt>Returns</dt><dd>true if lhs is less than rhs </dd></dl>
  320. </div>
  321. </div>
  322. <a class="anchor" id="gaa1f550339ca96028e8c0115d201e02a0"></a>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="mlabels">
  326. <tr>
  327. <td class="mlabels-left">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">bool fsdk::operator== </td>
  331. <td>(</td>
  332. <td class="paramtype">Version&#160;</td>
  333. <td class="paramname"><em>lhs</em>, </td>
  334. </tr>
  335. <tr>
  336. <td class="paramkey"></td>
  337. <td></td>
  338. <td class="paramtype">Version&#160;</td>
  339. <td class="paramname"><em>rhs</em>&#160;</td>
  340. </tr>
  341. <tr>
  342. <td></td>
  343. <td>)</td>
  344. <td></td><td></td>
  345. </tr>
  346. </table>
  347. </td>
  348. <td class="mlabels-right">
  349. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Check if versions are equal. </p>
  354. <dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">lhs</td><td>first version </td></tr>
  357. <tr><td class="paramname">rhs</td><td>second version </td></tr>
  358. </table>
  359. </dd>
  360. </dl>
  361. <dl class="section return"><dt>Returns</dt><dd>true if versions are equal </dd></dl>
  362. </div>
  363. </div>
  364. </div><!-- contents -->
  365. </div><!-- doc-content -->
  366. <!-- start footer part -->
  367. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  368. <ul>
  369. <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
  370. <a href="http://www.doxygen.org/index.html">
  371. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
  372. </ul>
  373. </div>
  374. </body>
  375. </html>