<!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">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MYNT EYE S SDK: mynteye::device::Frame Class 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="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&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&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
 <span id="projectnumber">2.3.2</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.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classmynteye_1_1device_1_1_frame.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="#pub-methods">Public Member Functions</a> |
<a href="classmynteye_1_1device_1_1_frame-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mynteye::device::Frame Class Reference<div class="ingroups"><a class="el" href="group__datatypes.html">Datatypes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmynteye_1_1device_1_1_frame.html" title="Frame with raw data.">Frame</a> with raw data.
<a href="classmynteye_1_1device_1_1_frame.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01db2013fb00320792c7e45698083bcc"><td class="memItemLeft" align="right" valign="top"><a id="a01db2013fb00320792c7e45698083bcc"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#a01db2013fb00320792c7e45698083bcc">Frame</a> (const <a class="el" href="structmynteye_1_1_stream_request.html">StreamRequest</a> &request, const void *<a class="el" href="classmynteye_1_1device_1_1_frame.html#a696374dacdeb662c0d2574aaa6873e32">data</a>)</td></tr>
<tr class="memdesc:a01db2013fb00320792c7e45698083bcc"><td class="mdescLeft"> </td><td class="mdescRight">Construct the frame with <a class="el" href="structmynteye_1_1_stream_request.html" title="Stream request.">StreamRequest</a> and raw data. <br /></td></tr>
<tr class="separator:a01db2013fb00320792c7e45698083bcc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2200786e674d4cbba106bc9cfd4e4f9"><td class="memItemLeft" align="right" valign="top"><a id="af2200786e674d4cbba106bc9cfd4e4f9"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#af2200786e674d4cbba106bc9cfd4e4f9">Frame</a> (std::uint16_t <a class="el" href="classmynteye_1_1device_1_1_frame.html#ade1bb1caeb4c1474afb844385c3f55bf">width</a>, std::uint16_t <a class="el" href="classmynteye_1_1device_1_1_frame.html#ae9eb0cb45c4d138448d5dfc5711233b1">height</a>, <a class="el" href="group__enumerations.html#ga40c22565756e51ccaf616884e3b3e9e2">Format</a> <a class="el" href="classmynteye_1_1device_1_1_frame.html#a0289fea1db18746e57f2b6b279a61b2c">format</a>, const void *<a class="el" href="classmynteye_1_1device_1_1_frame.html#a696374dacdeb662c0d2574aaa6873e32">data</a>)</td></tr>
<tr class="memdesc:af2200786e674d4cbba106bc9cfd4e4f9"><td class="mdescLeft"> </td><td class="mdescRight">Construct the frame with stream info and raw data. <br /></td></tr>
<tr class="separator:af2200786e674d4cbba106bc9cfd4e4f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade1bb1caeb4c1474afb844385c3f55bf"><td class="memItemLeft" align="right" valign="top">std::uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#ade1bb1caeb4c1474afb844385c3f55bf">width</a> () const</td></tr>
<tr class="memdesc:ade1bb1caeb4c1474afb844385c3f55bf"><td class="mdescLeft"> </td><td class="mdescRight">Get the width. <a href="#ade1bb1caeb4c1474afb844385c3f55bf">More...</a><br /></td></tr>
<tr class="separator:ade1bb1caeb4c1474afb844385c3f55bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9eb0cb45c4d138448d5dfc5711233b1"><td class="memItemLeft" align="right" valign="top">std::uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#ae9eb0cb45c4d138448d5dfc5711233b1">height</a> () const</td></tr>
<tr class="memdesc:ae9eb0cb45c4d138448d5dfc5711233b1"><td class="mdescLeft"> </td><td class="mdescRight">Get the height. <a href="#ae9eb0cb45c4d138448d5dfc5711233b1">More...</a><br /></td></tr>
<tr class="separator:ae9eb0cb45c4d138448d5dfc5711233b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0289fea1db18746e57f2b6b279a61b2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__enumerations.html#ga40c22565756e51ccaf616884e3b3e9e2">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#a0289fea1db18746e57f2b6b279a61b2c">format</a> () const</td></tr>
<tr class="memdesc:a0289fea1db18746e57f2b6b279a61b2c"><td class="mdescLeft"> </td><td class="mdescRight">Get the format. <a href="#a0289fea1db18746e57f2b6b279a61b2c">More...</a><br /></td></tr>
<tr class="separator:a0289fea1db18746e57f2b6b279a61b2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a696374dacdeb662c0d2574aaa6873e32"><td class="memItemLeft" align="right" valign="top">std::uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#a696374dacdeb662c0d2574aaa6873e32">data</a> ()</td></tr>
<tr class="memdesc:a696374dacdeb662c0d2574aaa6873e32"><td class="mdescLeft"> </td><td class="mdescRight">Get the data. <a href="#a696374dacdeb662c0d2574aaa6873e32">More...</a><br /></td></tr>
<tr class="separator:a696374dacdeb662c0d2574aaa6873e32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67c9430145f2888d5d4b91dc4ecdfca9"><td class="memItemLeft" align="right" valign="top">const std::uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#a67c9430145f2888d5d4b91dc4ecdfca9">data</a> () const</td></tr>
<tr class="memdesc:a67c9430145f2888d5d4b91dc4ecdfca9"><td class="mdescLeft"> </td><td class="mdescRight">Get the const data. <a href="#a67c9430145f2888d5d4b91dc4ecdfca9">More...</a><br /></td></tr>
<tr class="separator:a67c9430145f2888d5d4b91dc4ecdfca9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d3c39abf35be01cea42dfaddd9143c5"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#a1d3c39abf35be01cea42dfaddd9143c5">size</a> () const</td></tr>
<tr class="memdesc:a1d3c39abf35be01cea42dfaddd9143c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of data. <a href="#a1d3c39abf35be01cea42dfaddd9143c5">More...</a><br /></td></tr>
<tr class="separator:a1d3c39abf35be01cea42dfaddd9143c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc9c76f6ea4fc269efc00502805a63de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmynteye_1_1device_1_1_frame.html">Frame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmynteye_1_1device_1_1_frame.html#acc9c76f6ea4fc269efc00502805a63de">clone</a> () const</td></tr>
<tr class="memdesc:acc9c76f6ea4fc269efc00502805a63de"><td class="mdescLeft"> </td><td class="mdescRight">Clone a new frame. <a href="#acc9c76f6ea4fc269efc00502805a63de">More...</a><br /></td></tr>
<tr class="separator:acc9c76f6ea4fc269efc00502805a63de"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classmynteye_1_1device_1_1_frame.html" title="Frame with raw data.">Frame</a> with raw data. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acc9c76f6ea4fc269efc00502805a63de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc9c76f6ea4fc269efc00502805a63de">◆ </a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmynteye_1_1device_1_1_frame.html">Frame</a> mynteye::device::Frame::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone a new frame. </p>
</div>
</div>
<a id="a696374dacdeb662c0d2574aaa6873e32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a696374dacdeb662c0d2574aaa6873e32">◆ </a></span>data() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uint8_t* mynteye::device::Frame::data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the data. </p>
</div>
</div>
<a id="a67c9430145f2888d5d4b91dc4ecdfca9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c9430145f2888d5d4b91dc4ecdfca9">◆ </a></span>data() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::uint8_t* mynteye::device::Frame::data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the const data. </p>
</div>
</div>
<a id="a0289fea1db18746e57f2b6b279a61b2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0289fea1db18746e57f2b6b279a61b2c">◆ </a></span>format()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__enumerations.html#ga40c22565756e51ccaf616884e3b3e9e2">Format</a> mynteye::device::Frame::format </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the format. </p>
</div>
</div>
<a id="ae9eb0cb45c4d138448d5dfc5711233b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9eb0cb45c4d138448d5dfc5711233b1">◆ </a></span>height()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uint16_t mynteye::device::Frame::height </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the height. </p>
</div>
</div>
<a id="a1d3c39abf35be01cea42dfaddd9143c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3c39abf35be01cea42dfaddd9143c5">◆ </a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t mynteye::device::Frame::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of data. </p>
</div>
</div>
<a id="ade1bb1caeb4c1474afb844385c3f55bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade1bb1caeb4c1474afb844385c3f55bf">◆ </a></span>width()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uint16_t mynteye::device::Frame::width </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the width. </p>
</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="navelem"><b>mynteye</b></li><li class="navelem"><b>device</b></li><li class="navelem"><a class="el" href="classmynteye_1_1device_1_1_frame.html">Frame</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>