328 lines
28 KiB
HTML
328 lines
28 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::process_adaptor< Func, Delta > 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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-awesome.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">EnTT<span id="projectnumber"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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 id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structentt_1_1process__adaptor-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::process_adaptor< Func, Delta > Struct Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Adaptor for lambdas and functors to turn them into processes.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="process_8hpp_source.html">process.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for entt::process_adaptor< Func, Delta >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structentt_1_1process__adaptor__inherit__graph.png" border="0" usemap="#aentt_1_1process__adaptor_3_01Func_00_01Delta_01_4_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aentt_1_1process__adaptor_3_01Func_00_01Delta_01_4_inherit__map" id="aentt_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,108,221,148"/>
|
|
<area shape="rect" href="classentt_1_1process.html" title=" " alt="" coords="5,5,161,60"/>
|
|
<area shape="poly" title=" " alt="" coords="111,70,137,106,132,109,107,73"/>
|
|
<area shape="rect" title=" " alt="" coords="186,20,237,45"/>
|
|
<area shape="poly" title=" " alt="" coords="198,58,163,109,158,106,193,55"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for entt::process_adaptor< Func, Delta >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structentt_1_1process__adaptor__coll__graph.png" border="0" usemap="#aentt_1_1process__adaptor_3_01Func_00_01Delta_01_4_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aentt_1_1process__adaptor_3_01Func_00_01Delta_01_4_coll__map" id="aentt_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,108,221,148"/>
|
|
<area shape="rect" href="classentt_1_1process.html" title=" " alt="" coords="5,5,161,60"/>
|
|
<area shape="poly" title=" " alt="" coords="111,70,137,106,132,109,107,73"/>
|
|
<area shape="rect" title=" " alt="" coords="186,20,237,45"/>
|
|
<area shape="poly" title=" " alt="" coords="198,58,163,109,158,106,193,55"/>
|
|
</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 id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af065d57ac7c645279e4a5033f326abd8" id="r_af065d57ac7c645279e4a5033f326abd8"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr>
|
|
<tr class="memitem:af065d57ac7c645279e4a5033f326abd8"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af065d57ac7c645279e4a5033f326abd8">process_adaptor</a> (Args &&...args)</td></tr>
|
|
<tr class="memdesc:af065d57ac7c645279e4a5033f326abd8"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a process adaptor from a lambda or a functor. <br /></td></tr>
|
|
<tr class="separator:af065d57ac7c645279e4a5033f326abd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7514fabbbda491742872bc0e52dde5c2" id="r_a7514fabbbda491742872bc0e52dde5c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7514fabbbda491742872bc0e52dde5c2">update</a> (const Delta delta, void *data)</td></tr>
|
|
<tr class="memdesc:a7514fabbbda491742872bc0e52dde5c2"><td class="mdescLeft"> </td><td class="mdescRight">Updates a process and its internal state if required. <br /></td></tr>
|
|
<tr class="separator:a7514fabbbda491742872bc0e52dde5c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classentt_1_1process"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classentt_1_1process')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classentt_1_1process.html">entt::process< process_adaptor< Func, Delta >, Delta ></a></td></tr>
|
|
<tr class="memitem:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9 inherit pub_methods_classentt_1_1process" id="r_a4a5cf6bbe22a8b5b60b8b6c7221bc3b9"><td class="memItemLeft" align="right" valign="top">
|
|
constexpr </td><td class="memItemRight" valign="bottom"><b>process</b> ()=default</td></tr>
|
|
<tr class="memdesc:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23a46de31f2f5e8eeefcc07739b28038 inherit pub_methods_classentt_1_1process" id="r_a23a46de31f2f5e8eeefcc07739b28038"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>process</b> (const <a class="el" href="classentt_1_1process.html">process</a> &)=default</td></tr>
|
|
<tr class="memdesc:a23a46de31f2f5e8eeefcc07739b28038 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <br /></td></tr>
|
|
<tr class="separator:a23a46de31f2f5e8eeefcc07739b28038 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bd3a2e2889ad05c3314367652bf3223 inherit pub_methods_classentt_1_1process" id="r_a5bd3a2e2889ad05c3314367652bf3223"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>process</b> (<a class="el" href="classentt_1_1process.html">process</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:a5bd3a2e2889ad05c3314367652bf3223 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
|
|
<tr class="separator:a5bd3a2e2889ad05c3314367652bf3223 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72788a7962cf5001746c4714659f4630 inherit pub_methods_classentt_1_1process" id="r_a72788a7962cf5001746c4714659f4630"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1process.html">process</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a72788a7962cf5001746c4714659f4630">operator=</a> (const <a class="el" href="classentt_1_1process.html">process</a> &)=default</td></tr>
|
|
<tr class="memdesc:a72788a7962cf5001746c4714659f4630 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <br /></td></tr>
|
|
<tr class="separator:a72788a7962cf5001746c4714659f4630 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0bf8ba1041e6fccd9062dc113ede77e inherit pub_methods_classentt_1_1process" id="r_aa0bf8ba1041e6fccd9062dc113ede77e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1process.html">process</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#aa0bf8ba1041e6fccd9062dc113ede77e">operator=</a> (<a class="el" href="classentt_1_1process.html">process</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:aa0bf8ba1041e6fccd9062dc113ede77e inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
|
|
<tr class="separator:aa0bf8ba1041e6fccd9062dc113ede77e inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2baf1b6aef37c1420a77cd3f8eadcf79 inherit pub_methods_classentt_1_1process" id="r_a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a2baf1b6aef37c1420a77cd3f8eadcf79 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdcca68a2cd65bbece91ca7b504dfe60 inherit pub_methods_classentt_1_1process" id="r_abdcca68a2cd65bbece91ca7b504dfe60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#abdcca68a2cd65bbece91ca7b504dfe60">abort</a> (const bool immediate=false)</td></tr>
|
|
<tr class="memdesc:abdcca68a2cd65bbece91ca7b504dfe60 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Aborts a process if it's still alive. <br /></td></tr>
|
|
<tr class="separator:abdcca68a2cd65bbece91ca7b504dfe60 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacb0108ddb7ee68eac145c092b4e4163 inherit pub_methods_classentt_1_1process" id="r_aacb0108ddb7ee68eac145c092b4e4163"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#aacb0108ddb7ee68eac145c092b4e4163">alive</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aacb0108ddb7ee68eac145c092b4e4163 inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is either running or paused. <br /></td></tr>
|
|
<tr class="separator:aacb0108ddb7ee68eac145c092b4e4163 inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0385aa714f8fe603a7d89c960b22751e inherit pub_methods_classentt_1_1process" id="r_a0385aa714f8fe603a7d89c960b22751e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a0385aa714f8fe603a7d89c960b22751e">finished</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a0385aa714f8fe603a7d89c960b22751e inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is already terminated. <br /></td></tr>
|
|
<tr class="separator:a0385aa714f8fe603a7d89c960b22751e inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7738f4e908293a072a89981a004669a inherit pub_methods_classentt_1_1process" id="r_ac7738f4e908293a072a89981a004669a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#ac7738f4e908293a072a89981a004669a">paused</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ac7738f4e908293a072a89981a004669a inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is currently paused. <br /></td></tr>
|
|
<tr class="separator:ac7738f4e908293a072a89981a004669a inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c716b08baea91192512aeb14f26328b inherit pub_methods_classentt_1_1process" id="r_a6c716b08baea91192512aeb14f26328b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a6c716b08baea91192512aeb14f26328b">rejected</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a6c716b08baea91192512aeb14f26328b inherit pub_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process terminated with errors. <br /></td></tr>
|
|
<tr class="separator:a6c716b08baea91192512aeb14f26328b inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacc7fe0ef3265113079c70ff8cd9478d inherit pub_methods_classentt_1_1process" id="r_aacc7fe0ef3265113079c70ff8cd9478d"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Updates a process and its internal state if required. <br /></td></tr>
|
|
<tr class="separator:aacc7fe0ef3265113079c70ff8cd9478d inherit pub_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classentt_1_1process"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_classentt_1_1process')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classentt_1_1process.html">entt::process< process_adaptor< Func, Delta >, Delta ></a></td></tr>
|
|
<tr class="memitem:a625b574ea6d83e3a4933acc3d0279295 inherit pub_types_classentt_1_1process" id="r_a625b574ea6d83e3a4933acc3d0279295"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a625b574ea6d83e3a4933acc3d0279295">delta_type</a></td></tr>
|
|
<tr class="memdesc:a625b574ea6d83e3a4933acc3d0279295 inherit pub_types_classentt_1_1process"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classentt_1_1process"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classentt_1_1process')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classentt_1_1process.html">entt::process< process_adaptor< Func, Delta >, Delta ></a></td></tr>
|
|
<tr class="memitem:a4380dab12dc4c7559ada2182468aa1db inherit pro_methods_classentt_1_1process" id="r_a4380dab12dc4c7559ada2182468aa1db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a4380dab12dc4c7559ada2182468aa1db">succeed</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a4380dab12dc4c7559ada2182468aa1db inherit pro_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with success if it's still alive. <br /></td></tr>
|
|
<tr class="separator:a4380dab12dc4c7559ada2182468aa1db inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac7438533f769e1d24836ca04f86ec7c inherit pro_methods_classentt_1_1process" id="r_aac7438533f769e1d24836ca04f86ec7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#aac7438533f769e1d24836ca04f86ec7c">fail</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aac7438533f769e1d24836ca04f86ec7c inherit pro_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with errors if it's still alive. <br /></td></tr>
|
|
<tr class="separator:aac7438533f769e1d24836ca04f86ec7c inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bcdfd9f2ec24b591ba1fbf38f563023 inherit pro_methods_classentt_1_1process" id="r_a2bcdfd9f2ec24b591ba1fbf38f563023"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a2bcdfd9f2ec24b591ba1fbf38f563023">pause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a2bcdfd9f2ec24b591ba1fbf38f563023 inherit pro_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Stops a process if it's in a running state. <br /></td></tr>
|
|
<tr class="separator:a2bcdfd9f2ec24b591ba1fbf38f563023 inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b024d8b110a8ab631132acc6abfb9e1 inherit pro_methods_classentt_1_1process" id="r_a5b024d8b110a8ab631132acc6abfb9e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a5b024d8b110a8ab631132acc6abfb9e1">unpause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a5b024d8b110a8ab631132acc6abfb9e1 inherit pro_methods_classentt_1_1process"><td class="mdescLeft"> </td><td class="mdescRight">Restarts a process if it's paused. <br /></td></tr>
|
|
<tr class="separator:a5b024d8b110a8ab631132acc6abfb9e1 inherit pro_methods_classentt_1_1process"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Func, typename Delta><br />
|
|
struct entt::process_adaptor< Func, Delta ></div><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 hl_function" href="classentt_1_1process.html#a4380dab12dc4c7559ada2182468aa1db">succeed</a>, <span class="keyword">auto</span> <a class="code hl_function" href="classentt_1_1process.html#aac7438533f769e1d24836ca04f86ec7c">fail</a>);</div>
|
|
<div class="ttc" id="aclassentt_1_1process_html_a4380dab12dc4c7559ada2182468aa1db"><div class="ttname"><a href="classentt_1_1process.html#a4380dab12dc4c7559ada2182468aa1db">entt::process< process_adaptor< Func, Delta >, Delta >::succeed</a></div><div class="ttdeci">void succeed() noexcept</div><div class="ttdef"><b>Definition</b> <a href="process_8hpp_source.html#l00123">process.hpp:123</a></div></div>
|
|
<div class="ttc" id="aclassentt_1_1process_html_aac7438533f769e1d24836ca04f86ec7c"><div class="ttname"><a href="classentt_1_1process.html#aac7438533f769e1d24836ca04f86ec7c">entt::process< process_adaptor< Func, Delta >, Delta >::fail</a></div><div class="ttdeci">void fail() noexcept</div><div class="ttdef"><b>Definition</b> <a href="process_8hpp_source.html#l00135">process.hpp:135</a></div></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="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4" title="Alias declaration for the most common use case.">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#l00328">328</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af065d57ac7c645279e4a5033f326abd8" name="af065d57ac7c645279e4a5033f326abd8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af065d57ac7c645279e4a5033f326abd8">◆ </a></span>process_adaptor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Func, typename Delta> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Args> </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>< Func, Delta >::process_adaptor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">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#l00335">335</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" name="a7514fabbbda491742872bc0e52dde5c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7514fabbbda491742872bc0e52dde5c2">◆ </a></span>update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Func, typename Delta> </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>< Func, Delta >::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const Delta</td> <td class="paramname"><span class="paramname"><em>delta</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">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#l00343">343</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 -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|