Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c49227d82878de2cd4ae3decf93cfe4d097e994e
entt/structentt_1_1null__t.html
Michele Caini c49227d828 API reference v3.5.2
2020-09-22 08:42:41 +02:00

310 lines
15 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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::null_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.5.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @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_1null__t.html">null_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_1null__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::null_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Null object for all entity identifiers. <br />
<a href="structentt_1_1null__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:a645f6d96cbb99f7b245058a05bf0e28b"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:a645f6d96cbb99f7b245058a05bf0e28b"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1null__t.html#a645f6d96cbb99f7b245058a05bf0e28b">operator Entity</a> () const noexcept</td></tr>
<tr class="memdesc:a645f6d96cbb99f7b245058a05bf0e28b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the null object to identifiers of any type. <a href="structentt_1_1null__t.html#a645f6d96cbb99f7b245058a05bf0e28b">More...</a><br /></td></tr>
<tr class="separator:a645f6d96cbb99f7b245058a05bf0e28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08efcdfd647bd11c7a96683ffd2b1233"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1null__t.html#a08efcdfd647bd11c7a96683ffd2b1233">operator==</a> (<a class="el" href="structentt_1_1null__t.html">null_t</a>) const noexcept</td></tr>
<tr class="memdesc:a08efcdfd647bd11c7a96683ffd2b1233"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two null objects. <a href="structentt_1_1null__t.html#a08efcdfd647bd11c7a96683ffd2b1233">More...</a><br /></td></tr>
<tr class="separator:a08efcdfd647bd11c7a96683ffd2b1233"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab934a6abf738e0bc2c1d6eb6c0caeb32"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1null__t.html#ab934a6abf738e0bc2c1d6eb6c0caeb32">operator!=</a> (<a class="el" href="structentt_1_1null__t.html">null_t</a>) const noexcept</td></tr>
<tr class="memdesc:ab934a6abf738e0bc2c1d6eb6c0caeb32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two null objects. <a href="structentt_1_1null__t.html#ab934a6abf738e0bc2c1d6eb6c0caeb32">More...</a><br /></td></tr>
<tr class="separator:ab934a6abf738e0bc2c1d6eb6c0caeb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b143232fe50fc52fee376f4f8e23a76"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:a1b143232fe50fc52fee376f4f8e23a76"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1null__t.html#a1b143232fe50fc52fee376f4f8e23a76">operator==</a> (const Entity <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>) const noexcept</td></tr>
<tr class="memdesc:a1b143232fe50fc52fee376f4f8e23a76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares a null object and an entity identifier of any type. <a href="structentt_1_1null__t.html#a1b143232fe50fc52fee376f4f8e23a76">More...</a><br /></td></tr>
<tr class="separator:a1b143232fe50fc52fee376f4f8e23a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c8a4bdade66b7f7520d10b4bb4fc858"><td class="memTemplParams" colspan="2">template&lt;typename Entity &gt; </td></tr>
<tr class="memitem:a2c8a4bdade66b7f7520d10b4bb4fc858"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1null__t.html#a2c8a4bdade66b7f7520d10b4bb4fc858">operator!=</a> (const Entity <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>) const noexcept</td></tr>
<tr class="memdesc:a2c8a4bdade66b7f7520d10b4bb4fc858"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares a null object and an entity identifier of any type. <a href="structentt_1_1null__t.html#a2c8a4bdade66b7f7520d10b4bb4fc858">More...</a><br /></td></tr>
<tr class="separator:a2c8a4bdade66b7f7520d10b4bb4fc858"><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>Null object for all entity identifiers. <br />
</p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00099">99</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="a645f6d96cbb99f7b245058a05bf0e28b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a645f6d96cbb99f7b245058a05bf0e28b">&#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::null_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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the null 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 null representation for the given identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00106">106</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a2c8a4bdade66b7f7520d10b4bb4fc858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c8a4bdade66b7f7520d10b4bb4fc858">&#9670;&nbsp;</a></span>operator!=() <span class="overload">[1/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::null_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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares a null 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#l00144">144</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="ab934a6abf738e0bc2c1d6eb6c0caeb32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab934a6abf738e0bc2c1d6eb6c0caeb32">&#9670;&nbsp;</a></span>operator!=() <span class="overload">[2/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::null_t::operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1null__t.html">null_t</a>&#160;</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>Compares two null objects. </p>
<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#l00122">122</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a1b143232fe50fc52fee376f4f8e23a76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b143232fe50fc52fee376f4f8e23a76">&#9670;&nbsp;</a></span>operator==() <span class="overload">[1/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::null_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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares a null 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#l00133">133</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a08efcdfd647bd11c7a96683ffd2b1233"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08efcdfd647bd11c7a96683ffd2b1233">&#9670;&nbsp;</a></span>operator==() <span class="overload">[2/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::null_t::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1null__t.html">null_t</a>&#160;</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>Compares two null objects. </p>
<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#l00114">114</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="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink