523 lines
27 KiB
HTML
523 lines
27 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">
|
|
<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< 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">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&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&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="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:a625b574ea6d83e3a4933acc3d0279295"><td class="memItemLeft" align="right" valign="top"><a id="a625b574ea6d83e3a4933acc3d0279295"></a>
|
|
using </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"><td class="mdescLeft"> </td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
|
|
<tr class="separator:a625b574ea6d83e3a4933acc3d0279295"><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:a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="memItemLeft" align="right" valign="top"><a id="a2baf1b6aef37c1420a77cd3f8eadcf79"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1process.html#a2baf1b6aef37c1420a77cd3f8eadcf79">~process</a> ()</td></tr>
|
|
<tr class="memdesc:a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af27d28af408f1dfb260b8fe976e66ea3"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bc92bd0304659eb2a034fae65f1eeb9"><td class="memItemLeft" align="right" valign="top">bool </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad83f2550ca63e03af126a07e4ae5d9dd"><td class="memItemLeft" align="right" valign="top">bool </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f"><td class="memItemLeft" align="right" valign="top">bool </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ac63863bf823806d813b046769b4419"><td class="memItemLeft" align="right" valign="top">bool </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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"><td class="mdescLeft"> </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"><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:a43d63ba9304654f0209fc32d2c74f4ce"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81816bdd06dce4058bfe3cfa5d42a64c"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9bf45a6c430f5e32fc7ab33a7a197abc"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91fd8adb2ea48c88c6f9fb5818890f67"><td class="memItemLeft" align="right" valign="top">void </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"><td class="mdescLeft"> </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"><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, <span class="keywordtype">void</span> *);</div>
|
|
</div><!-- fragment --><p class="startli">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. The <code>void *</code> parameter is an opaque pointer to user data (if any) forwarded directly to the process during an update.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> init();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked when the process joins the running queue of a scheduler. This happens as soon as it's attached to the scheduler if the process is a top level one, otherwise when it replaces its parent if the process is a continuation.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> succeeded();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked in case of success, immediately after an update and during the same tick.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> failed();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked in case of errors, immediately after an update and during the same tick.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> aborted();</div>
|
|
</div><!-- fragment --><p class="startli">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.</p>
|
|
</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#l00073">73</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="af27d28af408f1dfb260b8fe976e66ea3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af27d28af408f1dfb260b8fe976e66ea3">◆ </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">const 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> </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#l00186">186</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8bc92bd0304659eb2a034fae65f1eeb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8bc92bd0304659eb2a034fae65f1eeb9">◆ </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> </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#l00200">200</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad83f2550ca63e03af126a07e4ae5d9dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad83f2550ca63e03af126a07e4ae5d9dd">◆ </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> </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#l00208">208</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81816bdd06dce4058bfe3cfa5d42a64c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81816bdd06dce4058bfe3cfa5d42a64c">◆ </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> </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#l00139">139</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9bf45a6c430f5e32fc7ab33a7a197abc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9bf45a6c430f5e32fc7ab33a7a197abc">◆ </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> </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#l00151">151</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c1c1f5ea78d3b2fc87cfcdbf7a1b40f">◆ </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> </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#l00216">216</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ac63863bf823806d813b046769b4419"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ac63863bf823806d813b046769b4419">◆ </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> </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#l00224">224</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a43d63ba9304654f0209fc32d2c74f4ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43d63ba9304654f0209fc32d2c74f4ce">◆ </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> </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#l00127">127</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacc7fe0ef3265113079c70ff8cd9478d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacc7fe0ef3265113079c70ff8cd9478d">◆ </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">const 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#l00233">233</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a91fd8adb2ea48c88c6f9fb5818890f67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91fd8adb2ea48c88c6f9fb5818890f67">◆ </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> </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#l00163">163</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.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|