tami/MYNT-EYE-S-SDK
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cd8b53210e
MYNT-EYE-S-SDK/group__utils.html
John Zhao cd8b53210e docs(gh-pages): update doc 2.2.4
2018-12-31 10:15:46 +08:00

190 lines
8.5 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MYNT EYE S SDK: Utiliities</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MYNT EYE S SDK
&#160;<span id="projectnumber">2.2.4</span>
</div>
<div id="projectbrief">http://www.myntai.com/mynteye/standard</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__utils.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Utiliities</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadaaa451b569023317e4d224b44381d41"><td class="memItemLeft" align="right" valign="top">MYNTEYE_API std::shared_ptr&lt; <a class="el" href="classmynteye_1_1_device.html">Device</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__utils.html#gadaaa451b569023317e4d224b44381d41">mynteye::device::select</a> ()</td></tr>
<tr class="memdesc:gadaaa451b569023317e4d224b44381d41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detecting MYNT EYE devices and prompt user to select one. <a href="group__utils.html#gadaaa451b569023317e4d224b44381d41">More...</a><br /></td></tr>
<tr class="separator:gadaaa451b569023317e4d224b44381d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc64aeffd4ae830d5a57b9e503f09254"><td class="memItemLeft" align="right" valign="top">MYNTEYE_API float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__utils.html#gafc64aeffd4ae830d5a57b9e503f09254">mynteye::utils::get_real_exposure_time</a> (std::int32_t frame_rate, std::uint16_t exposure_time)</td></tr>
<tr class="memdesc:gafc64aeffd4ae830d5a57b9e503f09254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get real exposure time in ms from virtual value, according to its frame rate. <a href="group__utils.html#gafc64aeffd4ae830d5a57b9e503f09254">More...</a><br /></td></tr>
<tr class="separator:gafc64aeffd4ae830d5a57b9e503f09254"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gafc64aeffd4ae830d5a57b9e503f09254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc64aeffd4ae830d5a57b9e503f09254">&#9670;&nbsp;</a></span>get_real_exposure_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MYNTEYE_API float mynteye::utils::get_real_exposure_time </td>
<td>(</td>
<td class="paramtype">std::int32_t&#160;</td>
<td class="paramname"><em>frame_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::uint16_t&#160;</td>
<td class="paramname"><em>exposure_time</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get real exposure time in ms from virtual value, according to its frame rate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frame_rate</td><td>the frame rate of the device. </td></tr>
<tr><td class="paramname">exposure_time</td><td>the virtual exposure time. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the real exposure time in ms, or the virtual value if frame rate is invalid. </dd></dl>
</div>
</div>
<a id="gadaaa451b569023317e4d224b44381d41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadaaa451b569023317e4d224b44381d41">&#9670;&nbsp;</a></span>select()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MYNTEYE_API std::shared_ptr&lt;<a class="el" href="classmynteye_1_1_device.html">Device</a>&gt; mynteye::device::select </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detecting MYNT EYE devices and prompt user to select one. </p>
<dl class="section return"><dt>Returns</dt><dd>the selected device, or <code>nullptr</code> if none. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink