Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1546c8982e6172a6f01334caaeb89a32bb494004
entt/structentt_1_1tombstone__t.html
Michele Caini 1546c8982e API reference v3.8.0
2021-07-21 14:02:37 +02:00

371 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::tombstone_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1tombstone__t.html">tombstone_t</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1tombstone__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::tombstone_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Tombstone object for all entity identifiers. <br />
<a href="structentt_1_1tombstone__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="entity_8hpp_source.html">entity.hpp</a>&gt;</code></p>
<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:a486219c88fe6ca91248095914fca745e"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:a486219c88fe6ca91248095914fca745e"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#a486219c88fe6ca91248095914fca745e">operator Entity</a> () const</td></tr>
<tr class="memdesc:a486219c88fe6ca91248095914fca745e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the tombstone object to identifiers of any type. <a href="structentt_1_1tombstone__t.html#a486219c88fe6ca91248095914fca745e">More...</a><br /></td></tr>
<tr class="separator:a486219c88fe6ca91248095914fca745e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa54c795fa1a8e817e56f14e29fc8beee"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#aa54c795fa1a8e817e56f14e29fc8beee">operator==</a> ([[maybe_unused]] const <a class="el" href="structentt_1_1tombstone__t.html">tombstone_t</a> other) const</td></tr>
<tr class="memdesc:aa54c795fa1a8e817e56f14e29fc8beee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two tombstone objects. <a href="structentt_1_1tombstone__t.html#aa54c795fa1a8e817e56f14e29fc8beee">More...</a><br /></td></tr>
<tr class="separator:aa54c795fa1a8e817e56f14e29fc8beee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2e901bd03a7676aa3596f8c55f91d1e"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#af2e901bd03a7676aa3596f8c55f91d1e">operator!=</a> ([[maybe_unused]] const <a class="el" href="structentt_1_1tombstone__t.html">tombstone_t</a> other) const</td></tr>
<tr class="memdesc:af2e901bd03a7676aa3596f8c55f91d1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two tombstone objects. <a href="structentt_1_1tombstone__t.html#af2e901bd03a7676aa3596f8c55f91d1e">More...</a><br /></td></tr>
<tr class="separator:af2e901bd03a7676aa3596f8c55f91d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa55c02c8ea69dc462ea78e4ad20c385f"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:aa55c02c8ea69dc462ea78e4ad20c385f"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#aa55c02c8ea69dc462ea78e4ad20c385f">operator==</a> (const Entity <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>) const</td></tr>
<tr class="memdesc:aa55c02c8ea69dc462ea78e4ad20c385f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares a tombstone object and an entity identifier of any type. <a href="structentt_1_1tombstone__t.html#aa55c02c8ea69dc462ea78e4ad20c385f">More...</a><br /></td></tr>
<tr class="separator:aa55c02c8ea69dc462ea78e4ad20c385f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae75cbf2733dcde452dd782d3c7eda923"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:ae75cbf2733dcde452dd782d3c7eda923"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#ae75cbf2733dcde452dd782d3c7eda923">operator!=</a> (const Entity <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>) const</td></tr>
<tr class="memdesc:ae75cbf2733dcde452dd782d3c7eda923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares a tombstone object and an entity identifier of any type. <a href="structentt_1_1tombstone__t.html#ae75cbf2733dcde452dd782d3c7eda923">More...</a><br /></td></tr>
<tr class="separator:ae75cbf2733dcde452dd782d3c7eda923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a42dff828c6f8f68c9edf4655863ca4"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:a6a42dff828c6f8f68c9edf4655863ca4"><td class="memTemplItemLeft" align="right" valign="top">constexpr Entity&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1tombstone__t.html#a6a42dff828c6f8f68c9edf4655863ca4">operator|</a> (const Entity <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>) const</td></tr>
<tr class="memdesc:a6a42dff828c6f8f68c9edf4655863ca4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a tombstone object from an entity identifier of any type. <a href="structentt_1_1tombstone__t.html#a6a42dff828c6f8f68c9edf4655863ca4">More...</a><br /></td></tr>
<tr class="separator:a6a42dff828c6f8f68c9edf4655863ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Tombstone object for all entity identifiers. <br />
</p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00238">238</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a486219c88fe6ca91248095914fca745e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a486219c88fe6ca91248095914fca745e">&#9670;&nbsp;</a></span>operator Entity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr entt::tombstone_t::operator Entity </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the tombstone object to identifiers of any type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>Type of entity identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The tombstone representation for the given type. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00245">245</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="af2e901bd03a7676aa3596f8c55f91d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2e901bd03a7676aa3596f8c55f91d1e">&#9670;&nbsp;</a></span>operator!=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool entt::tombstone_t::operator!= </td>
<td>(</td>
<td class="paramtype">[[maybe_unused] ] const <a class="el" href="structentt_1_1tombstone__t.html">tombstone_t</a>&#160;</td>
<td class="paramname"><em>other</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two tombstone objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>A tombstone object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>False in all cases. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00263">263</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="ae75cbf2733dcde452dd782d3c7eda923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae75cbf2733dcde452dd782d3c7eda923">&#9670;&nbsp;</a></span>operator!=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool entt::tombstone_t::operator!= </td>
<td>(</td>
<td class="paramtype">const Entity&#160;</td>
<td class="paramname"><em>entity</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares a tombstone object and an entity identifier of any type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>Type of entity identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>Entity identifier with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two elements differ, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00285">285</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="aa54c795fa1a8e817e56f14e29fc8beee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa54c795fa1a8e817e56f14e29fc8beee">&#9670;&nbsp;</a></span>operator==() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool entt::tombstone_t::operator== </td>
<td>(</td>
<td class="paramtype">[[maybe_unused] ] const <a class="el" href="structentt_1_1tombstone__t.html">tombstone_t</a>&#160;</td>
<td class="paramname"><em>other</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two tombstone objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>A tombstone object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True in all cases. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00254">254</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="aa55c02c8ea69dc462ea78e4ad20c385f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa55c02c8ea69dc462ea78e4ad20c385f">&#9670;&nbsp;</a></span>operator==() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool entt::tombstone_t::operator== </td>
<td>(</td>
<td class="paramtype">const Entity&#160;</td>
<td class="paramname"><em>entity</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares a tombstone object and an entity identifier of any type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>Type of entity identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>Entity identifier with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>False if the two elements differ, true otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00274">274</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a6a42dff828c6f8f68c9edf4655863ca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a42dff828c6f8f68c9edf4655863ca4">&#9670;&nbsp;</a></span>operator|()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr Entity entt::tombstone_t::operator| </td>
<td>(</td>
<td class="paramtype">const Entity&#160;</td>
<td class="paramname"><em>entity</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a tombstone object from an entity identifier of any type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>Type of entity identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>Entity identifier to turn into a tombstone object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The tombstone representation for the given identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00296">296</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/entity/<a class="el" href="entity_8hpp_source.html">entity.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink