510 lines
26 KiB
HTML
510 lines
26 KiB
HTML
<!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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>entt: entt::Process< Derived, Delta > Class 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
|
|
 <span id="projectnumber">2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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="classentt_1_1Process.html">Process</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classentt_1_1Process-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::Process< Derived, Delta > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for processes.
|
|
<a href="classentt_1_1Process.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="process_8hpp_source.html">process.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aaa304f69a0344fffd3a53daa922284ad"><td class="memItemLeft" align="right" valign="top"><a id="aaa304f69a0344fffd3a53daa922284ad"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aaa304f69a0344fffd3a53daa922284ad">delta_type</a> = Delta</td></tr>
|
|
<tr class="memdesc:aaa304f69a0344fffd3a53daa922284ad"><td class="mdescLeft"> </td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
|
|
<tr class="separator:aaa304f69a0344fffd3a53daa922284ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ab57f21bb526920b97ac6250003c5255a"><td class="memItemLeft" align="right" valign="top"><a id="ab57f21bb526920b97ac6250003c5255a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ab57f21bb526920b97ac6250003c5255a">~Process</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ab57f21bb526920b97ac6250003c5255a"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:ab57f21bb526920b97ac6250003c5255a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3678846862a819a23361bca2982251d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a3678846862a819a23361bca2982251d5">abort</a> (bool immediately=false) noexcept</td></tr>
|
|
<tr class="memdesc:a3678846862a819a23361bca2982251d5"><td class="mdescLeft"> </td><td class="mdescRight">Aborts a process if it's still alive. <a href="#a3678846862a819a23361bca2982251d5">More...</a><br /></td></tr>
|
|
<tr class="separator:a3678846862a819a23361bca2982251d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5c72a70dc7d5b7b5ac61f288cb11193"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ab5c72a70dc7d5b7b5ac61f288cb11193">alive</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ab5c72a70dc7d5b7b5ac61f288cb11193"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is either running or paused. <a href="#ab5c72a70dc7d5b7b5ac61f288cb11193">More...</a><br /></td></tr>
|
|
<tr class="separator:ab5c72a70dc7d5b7b5ac61f288cb11193"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ad2531bcae25f29be5081a94afac443"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a4ad2531bcae25f29be5081a94afac443">dead</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4ad2531bcae25f29be5081a94afac443"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is already terminated. <a href="#a4ad2531bcae25f29be5081a94afac443">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ad2531bcae25f29be5081a94afac443"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1d836570be05da08c487c1ee185f25d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#ad1d836570be05da08c487c1ee185f25d">paused</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ad1d836570be05da08c487c1ee185f25d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is currently paused. <a href="#ad1d836570be05da08c487c1ee185f25d">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1d836570be05da08c487c1ee185f25d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2333d8cb6c488f8f3d50aed2c3997d28"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a2333d8cb6c488f8f3d50aed2c3997d28">rejected</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a2333d8cb6c488f8f3d50aed2c3997d28"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process terminated with errors. <a href="#a2333d8cb6c488f8f3d50aed2c3997d28">More...</a><br /></td></tr>
|
|
<tr class="separator:a2333d8cb6c488f8f3d50aed2c3997d28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d2bd2fb6112a8df87d873102c20f462"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a6d2bd2fb6112a8df87d873102c20f462">tick</a> (Delta delta, void *data=nullptr)</td></tr>
|
|
<tr class="memdesc:a6d2bd2fb6112a8df87d873102c20f462"><td class="mdescLeft"> </td><td class="mdescRight">Updates a process and its internal state if required. <a href="#a6d2bd2fb6112a8df87d873102c20f462">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d2bd2fb6112a8df87d873102c20f462"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa30460eaadd9a6f2a58f4a5b0cda2b87"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#aa30460eaadd9a6f2a58f4a5b0cda2b87">succeed</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aa30460eaadd9a6f2a58f4a5b0cda2b87"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with success if it's still alive. <a href="#aa30460eaadd9a6f2a58f4a5b0cda2b87">More...</a><br /></td></tr>
|
|
<tr class="separator:aa30460eaadd9a6f2a58f4a5b0cda2b87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74e4e8b18cbd68eee49458a3e39ed6de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a74e4e8b18cbd68eee49458a3e39ed6de">fail</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a74e4e8b18cbd68eee49458a3e39ed6de"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with errors if it's still alive. <a href="#a74e4e8b18cbd68eee49458a3e39ed6de">More...</a><br /></td></tr>
|
|
<tr class="separator:a74e4e8b18cbd68eee49458a3e39ed6de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af62b8af0bcf3dc679d8d7f9dbf85eed9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#af62b8af0bcf3dc679d8d7f9dbf85eed9">pause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:af62b8af0bcf3dc679d8d7f9dbf85eed9"><td class="mdescLeft"> </td><td class="mdescRight">Stops a process if it's in a running state. <a href="#af62b8af0bcf3dc679d8d7f9dbf85eed9">More...</a><br /></td></tr>
|
|
<tr class="separator:af62b8af0bcf3dc679d8d7f9dbf85eed9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59de73e844b4fcc0db760e1f03fcfa67"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Process.html#a59de73e844b4fcc0db760e1f03fcfa67">unpause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a59de73e844b4fcc0db760e1f03fcfa67"><td class="mdescLeft"> </td><td class="mdescRight">Restarts a process if it's paused. <a href="#a59de73e844b4fcc0db760e1f03fcfa67">More...</a><br /></td></tr>
|
|
<tr class="separator:a59de73e844b4fcc0db760e1f03fcfa67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename Derived, typename Delta><br />
|
|
class entt::Process< Derived, Delta ></h3>
|
|
|
|
<p>Base class for processes. </p>
|
|
<p>This class stays true to the CRTP idiom. Derived classes must specify what's the intended type for elapsed times.<br />
|
|
A process should expose publicly the following member functions whether required:</p>
|
|
<ul>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> update(Delta);</div></div><!-- fragment --> It's invoked once per tick until a process is explicitly aborted or it terminates either with or without errors. Even though it's not mandatory to declare this member function, as a rule of thumb each process should at least define it to work properly.</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> init();</div></div><!-- fragment --> It's invoked at the first tick, immediately before an update.</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> succeeded();</div></div><!-- fragment --> It's invoked in case of success, immediately after an update and during the same tick.</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> failed();</div></div><!-- fragment --> It's invoked in case of errors, immediately after an update and during the same tick.</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> aborted();</div></div><!-- fragment --> It's invoked only if a process is explicitly aborted. There is no guarantee that it executes in the same tick, this depends solely on whether the process is aborted immediately or not.</li>
|
|
</ul>
|
|
<p>Derived classes can change the internal state of a process by invoking the <code>succeed</code> and <code>fail</code> protected member functions and even pause or unpause the process itself.</p>
|
|
<dl class="section see"><dt>See also</dt><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">Derived</td><td>Actual type of process that extends the class template. </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#l00063">63</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3678846862a819a23361bca2982251d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3678846862a819a23361bca2982251d5">◆ </a></span>abort()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::abort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>immediately</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Aborts a process if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">immediately</td><td>Requests an immediate operation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00176">176</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab5c72a70dc7d5b7b5ac61f288cb11193"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab5c72a70dc7d5b7b5ac61f288cb11193">◆ </a></span>alive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::alive </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is either running or paused. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is still alive, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00190">190</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ad2531bcae25f29be5081a94afac443"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ad2531bcae25f29be5081a94afac443">◆ </a></span>dead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::dead </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is already terminated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is terminated, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00198">198</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74e4e8b18cbd68eee49458a3e39ed6de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74e4e8b18cbd68eee49458a3e39ed6de">◆ </a></span>fail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::fail </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 class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates a process with errors if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00129">129</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af62b8af0bcf3dc679d8d7f9dbf85eed9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af62b8af0bcf3dc679d8d7f9dbf85eed9">◆ </a></span>pause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::pause </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 class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stops a process if it's in a running state. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't running. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00141">141</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1d836570be05da08c487c1ee185f25d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1d836570be05da08c487c1ee185f25d">◆ </a></span>paused()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::paused </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is currently paused. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is paused, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00206">206</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2333d8cb6c488f8f3d50aed2c3997d28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2333d8cb6c488f8f3d50aed2c3997d28">◆ </a></span>rejected()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::rejected </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process terminated with errors. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process terminated with errors, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00214">214</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa30460eaadd9a6f2a58f4a5b0cda2b87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa30460eaadd9a6f2a58f4a5b0cda2b87">◆ </a></span>succeed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::succeed </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 class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates a process with success if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00117">117</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6d2bd2fb6112a8df87d873102c20f462"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d2bd2fb6112a8df87d873102c20f462">◆ </a></span>tick()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Delta </td>
|
|
<td class="paramname"><em>delta</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>data</em> = <code>nullptr</code> </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#l00223">223</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59de73e844b4fcc0db760e1f03fcfa67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59de73e844b4fcc0db760e1f03fcfa67">◆ </a></span>unpause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1Process.html">entt::Process</a>< Derived, Delta >::unpause </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 class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restarts a process if it's paused. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't paused. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00153">153</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class 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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|