Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ac9898a17454fee86ed74dc419e51da222ec0c3a
entt/structentt_1_1process__adaptor.html
Michele Caini ac9898a174 API reference v3.3.0
2020-02-22 15:45:18 +01:00

298 lines
24 KiB
HTML
Raw Blame History

<!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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::process_adaptor&lt; Func, Delta &gt; Struct Template 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" />
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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>
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1process__adaptor.html">process_adaptor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1process__adaptor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::process_adaptor&lt; Func, Delta &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Adaptor for lambdas and functors to turn them into processes.
<a href="structentt_1_1process__adaptor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="process_8hpp_source.html">process.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for entt::process_adaptor&lt; Func, Delta &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structentt_1_1process__adaptor__inherit__graph.png" border="0" usemap="#entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_inherit__map" id="entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_inherit__map">
<area shape="rect" title="Adaptor for lambdas and functors to turn them into processes." alt="" coords="73,109,221,151"/>
<area shape="rect" href="classentt_1_1process.html" title=" " alt="" coords="5,5,161,61"/>
<area shape="rect" title=" " alt="" coords="186,20,237,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for entt::process_adaptor&lt; Func, Delta &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structentt_1_1process__adaptor__coll__graph.png" border="0" usemap="#entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_coll__map" id="entt_1_1process__adaptor_3_01Func_00_01Delta_01_4_coll__map">
<area shape="rect" title="Adaptor for lambdas and functors to turn them into processes." alt="" coords="73,109,221,151"/>
<area shape="rect" href="classentt_1_1process.html" title=" " alt="" coords="5,5,161,61"/>
<area shape="rect" title=" " alt="" coords="186,20,237,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ad1e2c8f3c44bf42abb05ef913b8267ce"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:ad1e2c8f3c44bf42abb05ef913b8267ce"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1process__adaptor.html#ad1e2c8f3c44bf42abb05ef913b8267ce">process_adaptor</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:ad1e2c8f3c44bf42abb05ef913b8267ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a process adaptor from a lambda or a functor. <a href="structentt_1_1process__adaptor.html#ad1e2c8f3c44bf42abb05ef913b8267ce">More...</a><br /></td></tr>
<tr class="separator:ad1e2c8f3c44bf42abb05ef913b8267ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7514fabbbda491742872bc0e52dde5c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1process__adaptor.html#a7514fabbbda491742872bc0e52dde5c2">update</a> (const Delta delta, void *data)</td></tr>
<tr class="memdesc:a7514fabbbda491742872bc0e52dde5c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates a process and its internal state if required. <a href="structentt_1_1process__adaptor.html#a7514fabbbda491742872bc0e52dde5c2">More...</a><br /></td></tr>
<tr class="separator:a7514fabbbda491742872bc0e52dde5c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classentt_1_1process"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classentt_1_1process')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classentt_1_1process.html">entt::process&lt; process_adaptor&lt; Func, Delta &gt;, Delta &gt;</a></td></tr>
<tr class="memitem:aacc7fe0ef3265113079c70ff8cd9478d inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#aacc7fe0ef3265113079c70ff8cd9478d">tick</a> (const Delta delta, void *data=nullptr)</td></tr>
<tr class="memdesc:aacc7fe0ef3265113079c70ff8cd9478d inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates a process and its internal state if required. <a href="classentt_1_1process.html#aacc7fe0ef3265113079c70ff8cd9478d">More...</a><br /></td></tr>
<tr class="separator:aacc7fe0ef3265113079c70ff8cd9478d inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2baf1b6aef37c1420a77cd3f8eadcf79 inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top"><a id="a2baf1b6aef37c1420a77cd3f8eadcf79"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a2baf1b6aef37c1420a77cd3f8eadcf79">~process</a> ()</td></tr>
<tr class="memdesc:a2baf1b6aef37c1420a77cd3f8eadcf79 inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a2baf1b6aef37c1420a77cd3f8eadcf79 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af27d28af408f1dfb260b8fe976e66ea3 inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#af27d28af408f1dfb260b8fe976e66ea3">abort</a> (const bool immediately=false)</td></tr>
<tr class="memdesc:af27d28af408f1dfb260b8fe976e66ea3 inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aborts a process if it's still alive. <a href="classentt_1_1process.html#af27d28af408f1dfb260b8fe976e66ea3">More...</a><br /></td></tr>
<tr class="separator:af27d28af408f1dfb260b8fe976e66ea3 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc92bd0304659eb2a034fae65f1eeb9 inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a8bc92bd0304659eb2a034fae65f1eeb9">alive</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a8bc92bd0304659eb2a034fae65f1eeb9 inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is either running or paused. <a href="classentt_1_1process.html#a8bc92bd0304659eb2a034fae65f1eeb9">More...</a><br /></td></tr>
<tr class="separator:a8bc92bd0304659eb2a034fae65f1eeb9 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad83f2550ca63e03af126a07e4ae5d9dd inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#ad83f2550ca63e03af126a07e4ae5d9dd">dead</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad83f2550ca63e03af126a07e4ae5d9dd inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is already terminated. <a href="classentt_1_1process.html#ad83f2550ca63e03af126a07e4ae5d9dd">More...</a><br /></td></tr>
<tr class="separator:ad83f2550ca63e03af126a07e4ae5d9dd inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f">paused</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process is currently paused. <a href="classentt_1_1process.html#a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f">More...</a><br /></td></tr>
<tr class="separator:a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac63863bf823806d813b046769b4419 inherit pub_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a6ac63863bf823806d813b046769b4419">rejected</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a6ac63863bf823806d813b046769b4419 inherit pub_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a process terminated with errors. <a href="classentt_1_1process.html#a6ac63863bf823806d813b046769b4419">More...</a><br /></td></tr>
<tr class="separator:a6ac63863bf823806d813b046769b4419 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classentt_1_1process"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classentt_1_1process')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classentt_1_1process.html">entt::process&lt; process_adaptor&lt; Func, Delta &gt;, Delta &gt;</a></td></tr>
<tr class="memitem:a625b574ea6d83e3a4933acc3d0279295 inherit pub_types_classentt_1_1process"><td class="memItemLeft" align="right" valign="top"><a id="a625b574ea6d83e3a4933acc3d0279295"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a625b574ea6d83e3a4933acc3d0279295">delta_type</a> = Delta</td></tr>
<tr class="memdesc:a625b574ea6d83e3a4933acc3d0279295 inherit pub_types_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
<tr class="separator:a625b574ea6d83e3a4933acc3d0279295 inherit pub_types_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classentt_1_1process"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classentt_1_1process')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classentt_1_1process.html">entt::process&lt; process_adaptor&lt; Func, Delta &gt;, Delta &gt;</a></td></tr>
<tr class="memitem:a43d63ba9304654f0209fc32d2c74f4ce inherit pro_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a43d63ba9304654f0209fc32d2c74f4ce">succeed</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a43d63ba9304654f0209fc32d2c74f4ce inherit pro_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates a process with success if it's still alive. <a href="classentt_1_1process.html#a43d63ba9304654f0209fc32d2c74f4ce">More...</a><br /></td></tr>
<tr class="separator:a43d63ba9304654f0209fc32d2c74f4ce inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81816bdd06dce4058bfe3cfa5d42a64c inherit pro_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a81816bdd06dce4058bfe3cfa5d42a64c">fail</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a81816bdd06dce4058bfe3cfa5d42a64c inherit pro_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates a process with errors if it's still alive. <a href="classentt_1_1process.html#a81816bdd06dce4058bfe3cfa5d42a64c">More...</a><br /></td></tr>
<tr class="separator:a81816bdd06dce4058bfe3cfa5d42a64c inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bf45a6c430f5e32fc7ab33a7a197abc inherit pro_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a9bf45a6c430f5e32fc7ab33a7a197abc">pause</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a9bf45a6c430f5e32fc7ab33a7a197abc inherit pro_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops a process if it's in a running state. <a href="classentt_1_1process.html#a9bf45a6c430f5e32fc7ab33a7a197abc">More...</a><br /></td></tr>
<tr class="separator:a9bf45a6c430f5e32fc7ab33a7a197abc inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91fd8adb2ea48c88c6f9fb5818890f67 inherit pro_methods_classentt_1_1process"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a91fd8adb2ea48c88c6f9fb5818890f67">unpause</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a91fd8adb2ea48c88c6f9fb5818890f67 inherit pro_methods_classentt_1_1process"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restarts a process if it's paused. <a href="classentt_1_1process.html#a91fd8adb2ea48c88c6f9fb5818890f67">More...</a><br /></td></tr>
<tr class="separator:a91fd8adb2ea48c88c6f9fb5818890f67 inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Func, typename Delta&gt;<br />
struct entt::process_adaptor&lt; Func, Delta &gt;</h3>
<p>Adaptor for lambdas and functors to turn them into processes. </p>
<p>Lambdas and functors can't be used directly with a scheduler for they are not properly defined processes with managed life cycles.<br />
This class helps in filling the gap and turning lambdas and functors into full featured processes usable by a scheduler.</p>
<p>The signature of the function call operator should be equivalent to the following:</p>
<div class="fragment"><div class="line">void(Delta delta, <span class="keywordtype">void</span> *data, <span class="keyword">auto</span> <a class="code" href="classentt_1_1process.html#a43d63ba9304654f0209fc32d2c74f4ce">succeed</a>, <span class="keyword">auto</span> <a class="code" href="classentt_1_1process.html#a81816bdd06dce4058bfe3cfa5d42a64c">fail</a>);</div>
</div><!-- fragment --><p>Where:</p>
<ul>
<li><code>delta</code> is the elapsed time.</li>
<li><code>data</code> is an opaque pointer to user data if any, <code>nullptr</code> otherwise.</li>
<li><code>succeed</code> is a function to call when a process terminates with success.</li>
<li><code>fail</code> is a function to call when a process terminates with errors.</li>
</ul>
<p>The signature of the function call operator of both <code>succeed</code> and <code>fail</code> is equivalent to the following:</p>
<div class="fragment"><div class="line">void();</div>
</div><!-- fragment --><p>Usually users shouldn't worry about creating adaptors. A scheduler will create them internally each and avery time a lambda or a functor is used as a process.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1process.html" title="Base class for processes.">process</a> </dd>
<dd>
<a class="el" href="classentt_1_1scheduler.html" title="Cooperative scheduler for processes.">scheduler</a></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Func</td><td>Actual type of process. </td></tr>
<tr><td class="paramname">Delta</td><td>Type to use to provide elapsed time. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00315">315</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad1e2c8f3c44bf42abb05ef913b8267ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1e2c8f3c44bf42abb05ef913b8267ce">&#9670;&nbsp;</a></span>process_adaptor()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func, typename Delta&gt; </div>
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1process__adaptor.html">entt::process_adaptor</a>&lt; Func, Delta &gt;::<a class="el" href="structentt_1_1process__adaptor.html">process_adaptor</a> </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></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>Constructs a process adaptor from a lambda or a functor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>Types of arguments to use to initialize the actual process. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the actual process. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00322">322</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7514fabbbda491742872bc0e52dde5c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7514fabbbda491742872bc0e52dde5c2">&#9670;&nbsp;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func, typename Delta&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1process__adaptor.html">entt::process_adaptor</a>&lt; Func, Delta &gt;::update </td>
<td>(</td>
<td class="paramtype">const Delta&#160;</td>
<td class="paramname"><em>delta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Updates a process and its internal state if required. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>Elapsed time. </td></tr>
<tr><td class="paramname">data</td><td>Optional data. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00331">331</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/process/<a class="el" href="process_8hpp_source.html">process.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassentt_1_1process_html_a81816bdd06dce4058bfe3cfa5d42a64c"><div class="ttname"><a href="classentt_1_1process.html#a81816bdd06dce4058bfe3cfa5d42a64c">entt::process&lt; process_adaptor&lt; Func, Delta &gt;, Delta &gt;::fail</a></div><div class="ttdeci">void fail() ENTT_NOEXCEPT</div><div class="ttdoc">Terminates a process with errors if it's still alive.</div><div class="ttdef"><b>Definition:</b> <a href="process_8hpp_source.html#l00139">process.hpp:139</a></div></div>
<div class="ttc" id="aclassentt_1_1process_html_a43d63ba9304654f0209fc32d2c74f4ce"><div class="ttname"><a href="classentt_1_1process.html#a43d63ba9304654f0209fc32d2c74f4ce">entt::process&lt; process_adaptor&lt; Func, Delta &gt;, Delta &gt;::succeed</a></div><div class="ttdeci">void succeed() ENTT_NOEXCEPT</div><div class="ttdoc">Terminates a process with success if it's still alive.</div><div class="ttdef"><b>Definition:</b> <a href="process_8hpp_source.html#l00127">process.hpp:127</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink