1192 lines
63 KiB
HTML
1192 lines
63 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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_dispatcher< Allocator > 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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">EnTT<span id="projectnumber"> 3.11.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @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');
|
|
$(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_1basic__dispatcher.html">basic_dispatcher</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="classentt_1_1basic__dispatcher-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::basic_dispatcher< Allocator > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic dispatcher implementation.
|
|
<a href="classentt_1_1basic__dispatcher.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a25129aec45c14bb934e9e9db3ed28015"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> = Allocator</td></tr>
|
|
<tr class="memdesc:a25129aec45c14bb934e9e9db3ed28015"><td class="mdescLeft"> </td><td class="mdescRight">Allocator type. <a href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">More...</a><br /></td></tr>
|
|
<tr class="separator:a25129aec45c14bb934e9e9db3ed28015"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5be4fb80f4bb0055ffaf3b573a4681a6"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:a5be4fb80f4bb0055ffaf3b573a4681a6"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <a href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a5be4fb80f4bb0055ffaf3b573a4681a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ad479b016e5261d80b30c25a540cc4fbd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#ad479b016e5261d80b30c25a540cc4fbd">basic_dispatcher</a> ()</td></tr>
|
|
<tr class="memdesc:ad479b016e5261d80b30c25a540cc4fbd"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classentt_1_1basic__dispatcher.html#ad479b016e5261d80b30c25a540cc4fbd">More...</a><br /></td></tr>
|
|
<tr class="separator:ad479b016e5261d80b30c25a540cc4fbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9f651ee2a41ecf134790e203d4f3654"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#ad9f651ee2a41ecf134790e203d4f3654">basic_dispatcher</a> (const <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ad9f651ee2a41ecf134790e203d4f3654"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a dispatcher with a given allocator. <a href="classentt_1_1basic__dispatcher.html#ad9f651ee2a41ecf134790e203d4f3654">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9f651ee2a41ecf134790e203d4f3654"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a942a4de622068676062ee1e47e9ef275"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a942a4de622068676062ee1e47e9ef275">basic_dispatcher</a> (<a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a942a4de622068676062ee1e47e9ef275"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="classentt_1_1basic__dispatcher.html#a942a4de622068676062ee1e47e9ef275">More...</a><br /></td></tr>
|
|
<tr class="separator:a942a4de622068676062ee1e47e9ef275"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a739ecc3e68ba6d1710d787bfb66d27a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a739ecc3e68ba6d1710d787bfb66d27a5">basic_dispatcher</a> (<a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> &&other, const <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> &allocator) noexcept</td></tr>
|
|
<tr class="memdesc:a739ecc3e68ba6d1710d787bfb66d27a5"><td class="mdescLeft"> </td><td class="mdescRight">Allocator-extended move constructor. <a href="classentt_1_1basic__dispatcher.html#a739ecc3e68ba6d1710d787bfb66d27a5">More...</a><br /></td></tr>
|
|
<tr class="separator:a739ecc3e68ba6d1710d787bfb66d27a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae743b9211b995d86eec1fba117fc9799"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#ae743b9211b995d86eec1fba117fc9799">operator=</a> (<a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:ae743b9211b995d86eec1fba117fc9799"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <a href="classentt_1_1basic__dispatcher.html#ae743b9211b995d86eec1fba117fc9799">More...</a><br /></td></tr>
|
|
<tr class="separator:ae743b9211b995d86eec1fba117fc9799"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0588bf4eef21b89fc716ab7c0ad8ce01"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a0588bf4eef21b89fc716ab7c0ad8ce01">swap</a> (<a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> &other)</td></tr>
|
|
<tr class="memdesc:a0588bf4eef21b89fc716ab7c0ad8ce01"><td class="mdescLeft"> </td><td class="mdescRight">Exchanges the contents with those of a given dispatcher. <a href="classentt_1_1basic__dispatcher.html#a0588bf4eef21b89fc716ab7c0ad8ce01">More...</a><br /></td></tr>
|
|
<tr class="separator:a0588bf4eef21b89fc716ab7c0ad8ce01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2491b6dfbb3fc48624e0765cfac8cc1"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#ad2491b6dfbb3fc48624e0765cfac8cc1">get_allocator</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ad2491b6dfbb3fc48624e0765cfac8cc1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the associated allocator. <a href="classentt_1_1basic__dispatcher.html#ad2491b6dfbb3fc48624e0765cfac8cc1">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2491b6dfbb3fc48624e0765cfac8cc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8259e6ff1cd028e2f498a47e7d594543"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a8259e6ff1cd028e2f498a47e7d594543"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">size_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a8259e6ff1cd028e2f498a47e7d594543">size</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value()) const noexcept</td></tr>
|
|
<tr class="memdesc:a8259e6ff1cd028e2f498a47e7d594543"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of pending events for a given type. <a href="classentt_1_1basic__dispatcher.html#a8259e6ff1cd028e2f498a47e7d594543">More...</a><br /></td></tr>
|
|
<tr class="separator:a8259e6ff1cd028e2f498a47e7d594543"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a568be9cdf0161098e8c87c5d7d924aca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a568be9cdf0161098e8c87c5d7d924aca">size</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a568be9cdf0161098e8c87c5d7d924aca"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of pending events. <a href="classentt_1_1basic__dispatcher.html#a568be9cdf0161098e8c87c5d7d924aca">More...</a><br /></td></tr>
|
|
<tr class="separator:a568be9cdf0161098e8c87c5d7d924aca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e76cd8379d9783423255c5d849dfd84"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a2e76cd8379d9783423255c5d849dfd84"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a2e76cd8379d9783423255c5d849dfd84">sink</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:a2e76cd8379d9783423255c5d849dfd84"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object for the given event and queue. <a href="classentt_1_1basic__dispatcher.html#a2e76cd8379d9783423255c5d849dfd84">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e76cd8379d9783423255c5d849dfd84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a106d465a66d82cfa2e664f0e14b498e3"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a106d465a66d82cfa2e664f0e14b498e3"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a106d465a66d82cfa2e664f0e14b498e3">trigger</a> (Type &&value={})</td></tr>
|
|
<tr class="memdesc:a106d465a66d82cfa2e664f0e14b498e3"><td class="mdescLeft"> </td><td class="mdescRight">Triggers an immediate event of a given type. <a href="classentt_1_1basic__dispatcher.html#a106d465a66d82cfa2e664f0e14b498e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a106d465a66d82cfa2e664f0e14b498e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a960ab280a72087de8077351ca8a3dbc8"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a960ab280a72087de8077351ca8a3dbc8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a960ab280a72087de8077351ca8a3dbc8">trigger</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id, Type &&value={})</td></tr>
|
|
<tr class="memdesc:a960ab280a72087de8077351ca8a3dbc8"><td class="mdescLeft"> </td><td class="mdescRight">Triggers an immediate event on a queue of a given type. <a href="classentt_1_1basic__dispatcher.html#a960ab280a72087de8077351ca8a3dbc8">More...</a><br /></td></tr>
|
|
<tr class="separator:a960ab280a72087de8077351ca8a3dbc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefeb6cfbb14cf16ad7bee0148a324867"><td class="memTemplParams" colspan="2">template<typename Type , typename... Args> </td></tr>
|
|
<tr class="memitem:aefeb6cfbb14cf16ad7bee0148a324867"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#aefeb6cfbb14cf16ad7bee0148a324867">enqueue</a> (Args &&...args)</td></tr>
|
|
<tr class="memdesc:aefeb6cfbb14cf16ad7bee0148a324867"><td class="mdescLeft"> </td><td class="mdescRight">Enqueues an event of the given type. <a href="classentt_1_1basic__dispatcher.html#aefeb6cfbb14cf16ad7bee0148a324867">More...</a><br /></td></tr>
|
|
<tr class="separator:aefeb6cfbb14cf16ad7bee0148a324867"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c13ef83ea854d2b974b9a6029064294"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a3c13ef83ea854d2b974b9a6029064294"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a3c13ef83ea854d2b974b9a6029064294">enqueue</a> (Type &&value)</td></tr>
|
|
<tr class="memdesc:a3c13ef83ea854d2b974b9a6029064294"><td class="mdescLeft"> </td><td class="mdescRight">Enqueues an event of the given type. <a href="classentt_1_1basic__dispatcher.html#a3c13ef83ea854d2b974b9a6029064294">More...</a><br /></td></tr>
|
|
<tr class="separator:a3c13ef83ea854d2b974b9a6029064294"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3da25e303527faa6f57616a077333681"><td class="memTemplParams" colspan="2">template<typename Type , typename... Args> </td></tr>
|
|
<tr class="memitem:a3da25e303527faa6f57616a077333681"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a3da25e303527faa6f57616a077333681">enqueue_hint</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a3da25e303527faa6f57616a077333681"><td class="mdescLeft"> </td><td class="mdescRight">Enqueues an event of the given type. <a href="classentt_1_1basic__dispatcher.html#a3da25e303527faa6f57616a077333681">More...</a><br /></td></tr>
|
|
<tr class="separator:a3da25e303527faa6f57616a077333681"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a223faf63a62726619ff0140d659037ee"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a223faf63a62726619ff0140d659037ee"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a223faf63a62726619ff0140d659037ee">enqueue_hint</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id, Type &&value)</td></tr>
|
|
<tr class="memdesc:a223faf63a62726619ff0140d659037ee"><td class="mdescLeft"> </td><td class="mdescRight">Enqueues an event of the given type. <a href="classentt_1_1basic__dispatcher.html#a223faf63a62726619ff0140d659037ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a223faf63a62726619ff0140d659037ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d3929fa7b3de337091f4305a564ba75"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a6d3929fa7b3de337091f4305a564ba75"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a6d3929fa7b3de337091f4305a564ba75">disconnect</a> (Type &value_or_instance)</td></tr>
|
|
<tr class="memdesc:a6d3929fa7b3de337091f4305a564ba75"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to disconnect everything related to a given value or instance from a dispatcher. <a href="classentt_1_1basic__dispatcher.html#a6d3929fa7b3de337091f4305a564ba75">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d3929fa7b3de337091f4305a564ba75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb5bc2c8ef847a296fe66c230f84569b"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:adb5bc2c8ef847a296fe66c230f84569b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#adb5bc2c8ef847a296fe66c230f84569b">disconnect</a> (Type *value_or_instance)</td></tr>
|
|
<tr class="memdesc:adb5bc2c8ef847a296fe66c230f84569b"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to disconnect everything related to a given value or instance from a dispatcher. <a href="classentt_1_1basic__dispatcher.html#adb5bc2c8ef847a296fe66c230f84569b">More...</a><br /></td></tr>
|
|
<tr class="separator:adb5bc2c8ef847a296fe66c230f84569b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02c856afb5d117366cc81543bece0cc8"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a02c856afb5d117366cc81543bece0cc8"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a02c856afb5d117366cc81543bece0cc8">clear</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:a02c856afb5d117366cc81543bece0cc8"><td class="mdescLeft"> </td><td class="mdescRight">Discards all the events stored so far in a given queue. <a href="classentt_1_1basic__dispatcher.html#a02c856afb5d117366cc81543bece0cc8">More...</a><br /></td></tr>
|
|
<tr class="separator:a02c856afb5d117366cc81543bece0cc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d149a28b16f00d36400022d5eb5546a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a1d149a28b16f00d36400022d5eb5546a">clear</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a1d149a28b16f00d36400022d5eb5546a"><td class="mdescLeft"> </td><td class="mdescRight">Discards all the events queued so far. <a href="classentt_1_1basic__dispatcher.html#a1d149a28b16f00d36400022d5eb5546a">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d149a28b16f00d36400022d5eb5546a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d0b2fc6d403b187f112798823c870dc"><td class="memTemplParams" colspan="2">template<typename Type > </td></tr>
|
|
<tr class="memitem:a7d0b2fc6d403b187f112798823c870dc"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a7d0b2fc6d403b187f112798823c870dc">update</a> (const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:a7d0b2fc6d403b187f112798823c870dc"><td class="mdescLeft"> </td><td class="mdescRight">Delivers all the pending events of a given queue. <a href="classentt_1_1basic__dispatcher.html#a7d0b2fc6d403b187f112798823c870dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d0b2fc6d403b187f112798823c870dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34b8c43b1d00707b09e9ea8cd53ff3fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__dispatcher.html#a34b8c43b1d00707b09e9ea8cd53ff3fd">update</a> () const</td></tr>
|
|
<tr class="memdesc:a34b8c43b1d00707b09e9ea8cd53ff3fd"><td class="mdescLeft"> </td><td class="mdescRight">Delivers all the pending events. <a href="classentt_1_1basic__dispatcher.html#a34b8c43b1d00707b09e9ea8cd53ff3fd">More...</a><br /></td></tr>
|
|
<tr class="separator:a34b8c43b1d00707b09e9ea8cd53ff3fd"><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 Allocator><br />
|
|
class entt::basic_dispatcher< Allocator ></div><p >Basic dispatcher implementation. </p>
|
|
<p >A dispatcher can be used either to trigger an immediate event or to enqueue events to be published all together once per tick.<br />
|
|
Listeners are provided in the form of member functions. For each event of type <code>Type</code>, listeners are such that they can be invoked with an argument of type <code>Type &</code>, no matter what the return type is.</p>
|
|
<p >The dispatcher creates instances of the <code>sigh</code> class internally. Refer to the documentation of the latter for more details.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Allocator</td><td>Type of allocator used to manage memory and elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00116">116</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a25129aec45c14bb934e9e9db3ed28015" name="a25129aec45c14bb934e9e9db3ed28015"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25129aec45c14bb934e9e9db3ed28015">◆ </a></span>allocator_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::allocator_type = Allocator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00154">154</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5be4fb80f4bb0055ffaf3b573a4681a6" name="a5be4fb80f4bb0055ffaf3b573a4681a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5be4fb80f4bb0055ffaf3b573a4681a6">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::size_type = std::size_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsigned integer type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00156">156</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad479b016e5261d80b30c25a540cc4fbd" name="ad479b016e5261d80b30c25a540cc4fbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad479b016e5261d80b30c25a540cc4fbd">◆ </a></span>basic_dispatcher() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::basic_dispatcher </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00159">159</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9f651ee2a41ecf134790e203d4f3654" name="ad9f651ee2a41ecf134790e203d4f3654"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9f651ee2a41ecf134790e203d4f3654">◆ </a></span>basic_dispatcher() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::basic_dispatcher </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> & </td>
|
|
<td class="paramname"><em>allocator</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a dispatcher with a given allocator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00166">166</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a942a4de622068676062ee1e47e9ef275" name="a942a4de622068676062ee1e47e9ef275"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a942a4de622068676062ee1e47e9ef275">◆ </a></span>basic_dispatcher() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::basic_dispatcher </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a>< Allocator > && </td>
|
|
<td class="paramname"><em>other</em></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>Move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00173">173</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a739ecc3e68ba6d1710d787bfb66d27a5" name="a739ecc3e68ba6d1710d787bfb66d27a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a739ecc3e68ba6d1710d787bfb66d27a5">◆ </a></span>basic_dispatcher() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::basic_dispatcher </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a>< Allocator > && </td>
|
|
<td class="paramname"><em>other</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> & </td>
|
|
<td class="paramname"><em>allocator</em> </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator-extended move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00181">181</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a1d149a28b16f00d36400022d5eb5546a" name="a1d149a28b16f00d36400022d5eb5546a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d149a28b16f00d36400022d5eb5546a">◆ </a></span>clear() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::clear </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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Discards all the events queued so far. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00361">361</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02c856afb5d117366cc81543bece0cc8" name="a02c856afb5d117366cc81543bece0cc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02c856afb5d117366cc81543bece0cc8">◆ </a></span>clear() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</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>Discards all the events stored so far in a given queue. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to discard. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00356">356</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6d3929fa7b3de337091f4305a564ba75" name="a6d3929fa7b3de337091f4305a564ba75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d3929fa7b3de337091f4305a564ba75">◆ </a></span>disconnect() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::disconnect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type & </td>
|
|
<td class="paramname"><em>value_or_instance</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>Utility function to disconnect everything related to a given value or instance from a dispatcher. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of class or type of payload. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value_or_instance</td><td>A valid object that fits the purpose. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00333">333</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb5bc2c8ef847a296fe66c230f84569b" name="adb5bc2c8ef847a296fe66c230f84569b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb5bc2c8ef847a296fe66c230f84569b">◆ </a></span>disconnect() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::disconnect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type * </td>
|
|
<td class="paramname"><em>value_or_instance</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>Utility function to disconnect everything related to a given value or instance from a dispatcher. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of class or type of payload. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value_or_instance</td><td>A valid object that fits the purpose. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00344">344</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefeb6cfbb14cf16ad7bee0148a324867" name="aefeb6cfbb14cf16ad7bee0148a324867"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefeb6cfbb14cf16ad7bee0148a324867">◆ </a></span>enqueue() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type , typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::enqueue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Args &&... </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>Enqueues an event of the given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to enqueue. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">args</td><td>Arguments to use to construct the event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00289">289</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c13ef83ea854d2b974b9a6029064294" name="a3c13ef83ea854d2b974b9a6029064294"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c13ef83ea854d2b974b9a6029064294">◆ </a></span>enqueue() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::enqueue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type && </td>
|
|
<td class="paramname"><em>value</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>Enqueues an event of the given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to enqueue. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>An instance of the given type of event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00299">299</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3da25e303527faa6f57616a077333681" name="a3da25e303527faa6f57616a077333681"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3da25e303527faa6f57616a077333681">◆ </a></span>enqueue_hint() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type , typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::enqueue_hint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&... </td>
|
|
<td class="paramname"><em>args</em> </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>Enqueues an event of the given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to enqueue. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Arguments to use to construct the event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00311">311</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a223faf63a62726619ff0140d659037ee" name="a223faf63a62726619ff0140d659037ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a223faf63a62726619ff0140d659037ee">◆ </a></span>enqueue_hint() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::enqueue_hint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Type && </td>
|
|
<td class="paramname"><em>value</em> </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>Enqueues an event of the given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to enqueue. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
<tr><td class="paramname">value</td><td>An instance of the given type of event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00322">322</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2491b6dfbb3fc48624e0765cfac8cc1" name="ad2491b6dfbb3fc48624e0765cfac8cc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2491b6dfbb3fc48624e0765cfac8cc1">◆ </a></span>get_allocator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__dispatcher.html#a25129aec45c14bb934e9e9db3ed28015">allocator_type</a> <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::get_allocator </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">constexpr</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the associated allocator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The associated allocator. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00207">207</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae743b9211b995d86eec1fba117fc9799" name="ae743b9211b995d86eec1fba117fc9799"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae743b9211b995d86eec1fba117fc9799">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a> & <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a>< Allocator > && </td>
|
|
<td class="paramname"><em>other</em></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>Move assignment operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This dispatcher. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00189">189</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e76cd8379d9783423255c5d849dfd84" name="a2e76cd8379d9783423255c5d849dfd84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e76cd8379d9783423255c5d849dfd84">◆ </a></span>sink()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::sink </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</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>Returns a sink object for the given event and queue. </p>
|
|
<p >A sink is an opaque object used to connect listeners to events.</p>
|
|
<p >The function type for a listener is <em>compatible</em> with:</p>
|
|
<div class="fragment"><div class="line">void(Type &);</div>
|
|
</div><!-- fragment --><p >The order of invocation of the listeners isn't guaranteed.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event of which to get the sink. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00257">257</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a568be9cdf0161098e8c87c5d7d924aca" name="a568be9cdf0161098e8c87c5d7d924aca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a568be9cdf0161098e8c87c5d7d924aca">◆ </a></span>size() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">size_type</a> <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::size </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the total number of pending events. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total number of pending events. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00227">227</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8259e6ff1cd028e2f498a47e7d594543" name="a8259e6ff1cd028e2f498a47e7d594543"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8259e6ff1cd028e2f498a47e7d594543">◆ </a></span>size() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__dispatcher.html#a5be4fb80f4bb0055ffaf3b573a4681a6">size_type</a> <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::size </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</code></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 the number of pending events for a given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event for which to return the count. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of pending events for the given type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00218">218</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0588bf4eef21b89fc716ab7c0ad8ce01" name="a0588bf4eef21b89fc716ab7c0ad8ce01"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0588bf4eef21b89fc716ab7c0ad8ce01">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__dispatcher.html">basic_dispatcher</a>< Allocator > & </td>
|
|
<td class="paramname"><em>other</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>Exchanges the contents with those of a given dispatcher. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>Dispatcher to exchange the content with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00198">198</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a960ab280a72087de8077351ca8a3dbc8" name="a960ab280a72087de8077351ca8a3dbc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a960ab280a72087de8077351ca8a3dbc8">◆ </a></span>trigger() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::trigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Type && </td>
|
|
<td class="paramname"><em>value</em> = <code>{}</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>Triggers an immediate event on a queue of a given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to trigger. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>An instance of the given type of event. </td></tr>
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00278">278</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a106d465a66d82cfa2e664f0e14b498e3" name="a106d465a66d82cfa2e664f0e14b498e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a106d465a66d82cfa2e664f0e14b498e3">◆ </a></span>trigger() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::trigger </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type && </td>
|
|
<td class="paramname"><em>value</em> = <code>{}</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>Triggers an immediate event of a given type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to trigger. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>An instance of the given type of event. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00267">267</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a34b8c43b1d00707b09e9ea8cd53ff3fd" name="a34b8c43b1d00707b09e9ea8cd53ff3fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a34b8c43b1d00707b09e9ea8cd53ff3fd">◆ </a></span>update() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::update </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>Delivers all the pending events. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00378">378</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d0b2fc6d403b187f112798823c870dc" name="a7d0b2fc6d403b187f112798823c870dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d0b2fc6d403b187f112798823c870dc">◆ </a></span>update() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Allocator > </div>
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__dispatcher.html">entt::basic_dispatcher</a>< Allocator >::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> </td>
|
|
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</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>Delivers all the pending events of a given queue. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of event to send. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the event queue within the dispatcher. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dispatcher_8hpp_source.html#l00373">373</a> of file <a class="el" href="dispatcher_8hpp_source.html">dispatcher.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/entt/signal/<a class="el" href="dispatcher_8hpp_source.html">dispatcher.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.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|