Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1e23a1131122fef897be4ffffd08bca00a7d291b
entt/classentt_1_1basic__entt__traits.html
Michele Caini 1e23a11311 API reference v3.15.0
2025-03-19 15:49:42 +01:00

541 lines
31 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" lang="en-US">
<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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_entt_traits&lt; Traits &gt; 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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-awesome.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">&#160;3.15.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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__entt__traits.html">basic_entt_traits</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classentt_1_1basic__entt__traits-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_entt_traits&lt; Traits &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Common basic entity traits implementation.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="entity_8hpp_source.html">entity.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for entt::basic_entt_traits&lt; Traits &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classentt_1_1basic__entt__traits__inherit__graph.png" border="0" usemap="#aentt_1_1basic__entt__traits_3_01Traits_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aentt_1_1basic__entt__traits_3_01Traits_01_4_inherit__map" id="aentt_1_1basic__entt__traits_3_01Traits_01_4_inherit__map">
<area shape="rect" title="Common basic entity traits implementation." alt="" coords="80,5,228,45"/>
<area shape="rect" href="structentt_1_1entt__traits.html" title=" " alt="" coords="5,93,148,148"/>
<area shape="poly" title=" " alt="" coords="132,58,100,95,96,92,128,54"/>
<area shape="rect" href="structentt_1_1entt__traits.html" title=" " alt="" coords="172,101,291,141"/>
<area shape="poly" title=" " alt="" coords="180,54,218,99,214,102,176,58"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a8d3ccdc302fc7dc567541fa12eca6b4e" id="r_a8d3ccdc302fc7dc567541fa12eca6b4e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> = typename Traits::value_type</td></tr>
<tr class="memdesc:a8d3ccdc302fc7dc567541fa12eca6b4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value type. <br /></td></tr>
<tr class="separator:a8d3ccdc302fc7dc567541fa12eca6b4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a066f3db5d13496df1e1fbc8659197793" id="r_a066f3db5d13496df1e1fbc8659197793"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> = typename Traits::entity_type</td></tr>
<tr class="memdesc:a066f3db5d13496df1e1fbc8659197793"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity type. <br /></td></tr>
<tr class="separator:a066f3db5d13496df1e1fbc8659197793"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3fe33d19b228d07c5560b907f910c10" id="r_aa3fe33d19b228d07c5560b907f910c10"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3fe33d19b228d07c5560b907f910c10">version_type</a> = typename Traits::version_type</td></tr>
<tr class="memdesc:aa3fe33d19b228d07c5560b907f910c10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying version type. <br /></td></tr>
<tr class="separator:aa3fe33d19b228d07c5560b907f910c10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4eb435084cf47d4fbc840654f2e8c9e0" id="r_a4eb435084cf47d4fbc840654f2e8c9e0"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4eb435084cf47d4fbc840654f2e8c9e0">to_integral</a> (const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> value) noexcept</td></tr>
<tr class="memdesc:a4eb435084cf47d4fbc840654f2e8c9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an entity to its underlying type. <br /></td></tr>
<tr class="separator:a4eb435084cf47d4fbc840654f2e8c9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c02bc8db33817ec509b7d32773fa463" id="r_a8c02bc8db33817ec509b7d32773fa463"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c02bc8db33817ec509b7d32773fa463">to_entity</a> (const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> value) noexcept</td></tr>
<tr class="memdesc:a8c02bc8db33817ec509b7d32773fa463"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the entity part once converted to the underlying type. <br /></td></tr>
<tr class="separator:a8c02bc8db33817ec509b7d32773fa463"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e3c418f09660a761fab21078df6700" id="r_af1e3c418f09660a761fab21078df6700"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#aa3fe33d19b228d07c5560b907f910c10">version_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1e3c418f09660a761fab21078df6700">to_version</a> (const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> value) noexcept</td></tr>
<tr class="memdesc:af1e3c418f09660a761fab21078df6700"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the version part once converted to the underlying type. <br /></td></tr>
<tr class="separator:af1e3c418f09660a761fab21078df6700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42a94cfb5923165804979505731ad7c6" id="r_a42a94cfb5923165804979505731ad7c6"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42a94cfb5923165804979505731ad7c6">next</a> (const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> value) noexcept</td></tr>
<tr class="memdesc:a42a94cfb5923165804979505731ad7c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the successor of a given identifier. <br /></td></tr>
<tr class="separator:a42a94cfb5923165804979505731ad7c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d3c3e8fd538fb4394ea505dd0415ec5" id="r_a3d3c3e8fd538fb4394ea505dd0415ec5"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d3c3e8fd538fb4394ea505dd0415ec5">construct</a> (const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> <a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</a>, const <a class="el" href="#aa3fe33d19b228d07c5560b907f910c10">version_type</a> version) noexcept</td></tr>
<tr class="memdesc:a3d3c3e8fd538fb4394ea505dd0415ec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an identifier from its parts. <br /></td></tr>
<tr class="separator:a3d3c3e8fd538fb4394ea505dd0415ec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad00358aea03a19c59efae2f8c005ae9b" id="r_ad00358aea03a19c59efae2f8c005ae9b"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad00358aea03a19c59efae2f8c005ae9b">combine</a> (const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> lhs, const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> rhs) noexcept</td></tr>
<tr class="memdesc:ad00358aea03a19c59efae2f8c005ae9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines two identifiers in a single one. <br /></td></tr>
<tr class="separator:ad00358aea03a19c59efae2f8c005ae9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a6b93920c3b3347171c485fdbdead14ec" id="r_a6b93920c3b3347171c485fdbdead14ec"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b93920c3b3347171c485fdbdead14ec">entity_mask</a> = Traits::entity_mask</td></tr>
<tr class="memdesc:a6b93920c3b3347171c485fdbdead14ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entity mask size. <br /></td></tr>
<tr class="separator:a6b93920c3b3347171c485fdbdead14ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bd49c229b049ac5dc0fb21195b4bcc3" id="r_a0bd49c229b049ac5dc0fb21195b4bcc3"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bd49c229b049ac5dc0fb21195b4bcc3">version_mask</a> = Traits::version_mask</td></tr>
<tr class="memdesc:a0bd49c229b049ac5dc0fb21195b4bcc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Version mask size. <br /></td></tr>
<tr class="separator:a0bd49c229b049ac5dc0fb21195b4bcc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Traits&gt;<br />
class entt::basic_entt_traits&lt; Traits &gt;</div><p>Common basic entity traits implementation. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Traits</td><td>Actual entity traits to use. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00061">61</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a066f3db5d13496df1e1fbc8659197793" name="a066f3db5d13496df1e1fbc8659197793"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a066f3db5d13496df1e1fbc8659197793">&#9670;&#160;</a></span>entity_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::entity_type = typename Traits::entity_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying entity type. </p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00071">71</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a8d3ccdc302fc7dc567541fa12eca6b4e" name="a8d3ccdc302fc7dc567541fa12eca6b4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3ccdc302fc7dc567541fa12eca6b4e">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::value_type = typename Traits::value_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Value type. </p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00069">69</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="aa3fe33d19b228d07c5560b907f910c10" name="aa3fe33d19b228d07c5560b907f910c10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3fe33d19b228d07c5560b907f910c10">&#9670;&#160;</a></span>version_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::version_type = typename Traits::version_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying version type. </p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00073">73</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad00358aea03a19c59efae2f8c005ae9b" name="ad00358aea03a19c59efae2f8c005ae9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad00358aea03a19c59efae2f8c005ae9b">&#9670;&#160;</a></span>combine()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::combine </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a></td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a></td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Combines two identifiers in a single one. </p>
<p>The returned identifier is a copy of the first element except for its version, which is taken from the second element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The identifier from which to take the entity part. </td></tr>
<tr><td class="paramname">rhs</td><td>The identifier from which to take the version part. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A properly constructed identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00149">149</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a3d3c3e8fd538fb4394ea505dd0415ec5" name="a3d3c3e8fd538fb4394ea505dd0415ec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d3c3e8fd538fb4394ea505dd0415ec5">&#9670;&#160;</a></span>construct()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::construct </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entity</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="#aa3fe33d19b228d07c5560b907f910c10">version_type</a></td> <td class="paramname"><span class="paramname"><em>version</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an identifier from its parts. </p>
<p>If the version part is not provided, a tombstone is returned.<br />
If the entity part is not provided, a null identifier is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>The entity part of the identifier. </td></tr>
<tr><td class="paramname">version</td><td>The version part of the identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A properly constructed identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00131">131</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a42a94cfb5923165804979505731ad7c6" name="a42a94cfb5923165804979505731ad7c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42a94cfb5923165804979505731ad7c6">&#9670;&#160;</a></span>next()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::next </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a></td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the successor of a given identifier. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The identifier of which to return the successor. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The successor of the given identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00116">116</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a8c02bc8db33817ec509b7d32773fa463" name="a8c02bc8db33817ec509b7d32773fa463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c02bc8db33817ec509b7d32773fa463">&#9670;&#160;</a></span>to_entity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::to_entity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a></td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the entity part once converted to the underlying type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The integral representation of the entity part. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00094">94</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a4eb435084cf47d4fbc840654f2e8c9e0" name="a4eb435084cf47d4fbc840654f2e8c9e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eb435084cf47d4fbc840654f2e8c9e0">&#9670;&#160;</a></span>to_integral()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::to_integral </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a></td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts an entity to its underlying type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The integral representation of the given value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00085">85</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="af1e3c418f09660a761fab21078df6700" name="af1e3c418f09660a761fab21078df6700"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1e3c418f09660a761fab21078df6700">&#9670;&#160;</a></span>to_version()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="#aa3fe33d19b228d07c5560b907f910c10">version_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::to_version </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="#a8d3ccdc302fc7dc567541fa12eca6b4e">value_type</a></td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the version part once converted to the underlying type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The integral representation of the version part. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00103">103</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6b93920c3b3347171c485fdbdead14ec" name="a6b93920c3b3347171c485fdbdead14ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b93920c3b3347171c485fdbdead14ec">&#9670;&#160;</a></span>entity_mask</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::entity_mask = Traits::entity_mask</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Entity mask size. </p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00076">76</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<a id="a0bd49c229b049ac5dc0fb21195b4bcc3" name="a0bd49c229b049ac5dc0fb21195b4bcc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bd49c229b049ac5dc0fb21195b4bcc3">&#9670;&#160;</a></span>version_mask</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a066f3db5d13496df1e1fbc8659197793">entity_type</a> <a class="el" href="classentt_1_1basic__entt__traits.html">entt::basic_entt_traits</a>&lt; Traits &gt;::version_mask = Traits::version_mask</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Version mask size. </p>
<p class="definition">Definition at line <a class="el" href="entity_8hpp_source.html#l00078">78</a> of file <a class="el" href="entity_8hpp_source.html">entity.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class 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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink