Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API reference v3.15.0

Browse Source
This commit is contained in:
Michele Caini
2025-03-19 15:49:42 +01:00
parent 4b4d0ab7ed
commit 1e23a11311
1334 changed files with 46058 additions and 36285 deletions
Download Patch File Download Diff File Expand all files Collapse all files
component_8hpp_source.html
+37 -25
View File
@@ -3,13 +3,15 @@
<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.10.0"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: src/entt/entity/component.hpp Source File</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>
@@ -23,7 +25,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.14.0</span>
<div id="projectname">EnTT<span id="projectnumber">&#160;3.15.0</span>
</div>
</td>
</tr>
@@ -31,18 +33,23 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<!-- 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');
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
@@ -50,7 +57,7 @@ $(function() {
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
@@ -79,6 +86,7 @@ $(function() { codefold.init(0); });
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_e3a7bb56c55e5c2286e2fe96e197d4f5.html">entity</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">component.hpp</div></div>
</div><!--header-->
@@ -92,7 +100,7 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;fwd.hpp&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceentt.html">entt</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span>internal {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type, <span class="keyword">typename</span> = <span class="keywordtype">void</span>&gt;</div>
@@ -116,30 +124,34 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> : std::integral_constant&lt;std::size_t, Type::page_size&gt; {};</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>} <span class="comment">// namespace internal</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type, <span class="keyword">typename</span> = <span class="keywordtype">void</span>&gt;</div>
<div class="foldopen" id="foldopen00042" data-start="{" data-end="};">
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html"> 42</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structentt_1_1component__traits.html">component_traits</a> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static_assert</span>(std::is_same_v&lt;std::decay_t&lt;Type&gt;, Type&gt;, <span class="stringliteral">&quot;Unsupported type&quot;</span>);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ad27a54129d408c38d21365a1bab4c93f"> 46</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="structentt_1_1component__traits.html#ad27a54129d408c38d21365a1bab4c93f">type</a> = Type;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f"> 49</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f">in_place_delete</a> = internal::in_place_delete&lt;Type&gt;::value;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b"> 51</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::size_t <a class="code hl_variable" href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b">page_size</a> = internal::page_size&lt;Type&gt;::value;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type, <span class="keyword">typename</span> Entity, <span class="keyword">typename</span>&gt;</div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="};">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html"> 43</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structentt_1_1component__traits.html">component_traits</a> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">static_assert</span>(std::is_same_v&lt;std::decay_t&lt;Type&gt;, Type&gt;, <span class="stringliteral">&quot;Unsupported type&quot;</span>);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ad991611996fcdc1dcaae38c6035199f9"> 47</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="structentt_1_1component__traits.html#ad991611996fcdc1dcaae38c6035199f9">element_type</a> = Type;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ae234a374ad21f25c234a88230eb5b928"> 49</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="structentt_1_1component__traits.html#ae234a374ad21f25c234a88230eb5b928">entity_type</a> = Entity;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#a1c3296904a082d8ca44d77344ad002ec"> 52</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structentt_1_1component__traits.html#a1c3296904a082d8ca44d77344ad002ec">in_place_delete</a> = internal::in_place_delete&lt;Type&gt;::value;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ae37a0cf9d057ff1ae12261be2abde7b3"> 54</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::size_t <a class="code hl_variable" href="structentt_1_1component__traits.html#ae37a0cf9d057ff1ae12261be2abde7b3">page_size</a> = internal::page_size&lt;Type&gt;::value;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace entt</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>} <span class="comment">// namespace entt</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition</b> <a href="dense__map_8hpp_source.html#l00022">dense_map.hpp:22</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html"><div class="ttname"><a href="structentt_1_1component__traits.html">entt::component_traits</a></div><div class="ttdoc">Common way to access various properties of components.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">component.hpp:42</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_a8fa4acd0fc9b0c554ea805961a5b6f8b"><div class="ttname"><a href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b">entt::component_traits::page_size</a></div><div class="ttdeci">static constexpr std::size_t page_size</div><div class="ttdoc">Page size, default is ENTT_PACKED_PAGE for non-empty types.</div><div class="ttdef"><b>Definition</b> <a href="#l00051">component.hpp:51</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_ac3efe50eb183fe2a31b642ade474017f"><div class="ttname"><a href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f">entt::component_traits::in_place_delete</a></div><div class="ttdeci">static constexpr bool in_place_delete</div><div class="ttdoc">Pointer stability, default is false.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">component.hpp:49</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_ad27a54129d408c38d21365a1bab4c93f"><div class="ttname"><a href="structentt_1_1component__traits.html#ad27a54129d408c38d21365a1bab4c93f">entt::component_traits::type</a></div><div class="ttdeci">Type type</div><div class="ttdoc">Component type.</div><div class="ttdef"><b>Definition</b> <a href="#l00046">component.hpp:46</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html"><div class="ttname"><a href="structentt_1_1component__traits.html">entt::component_traits</a></div><div class="ttdoc">Common way to access various properties of components.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">component.hpp:43</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_a1c3296904a082d8ca44d77344ad002ec"><div class="ttname"><a href="structentt_1_1component__traits.html#a1c3296904a082d8ca44d77344ad002ec">entt::component_traits&lt; Type, Entity &gt;::in_place_delete</a></div><div class="ttdeci">static constexpr bool in_place_delete</div><div class="ttdef"><b>Definition</b> <a href="#l00052">component.hpp:52</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_ad991611996fcdc1dcaae38c6035199f9"><div class="ttname"><a href="structentt_1_1component__traits.html#ad991611996fcdc1dcaae38c6035199f9">entt::component_traits::element_type</a></div><div class="ttdeci">Type element_type</div><div class="ttdoc">Element type.</div><div class="ttdef"><b>Definition</b> <a href="#l00047">component.hpp:47</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_ae234a374ad21f25c234a88230eb5b928"><div class="ttname"><a href="structentt_1_1component__traits.html#ae234a374ad21f25c234a88230eb5b928">entt::component_traits::entity_type</a></div><div class="ttdeci">Entity entity_type</div><div class="ttdoc">Underlying entity identifier.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">component.hpp:49</a></div></div>
<div class="ttc" id="astructentt_1_1component__traits_html_ae37a0cf9d057ff1ae12261be2abde7b3"><div class="ttname"><a href="structentt_1_1component__traits.html#ae37a0cf9d057ff1ae12261be2abde7b3">entt::component_traits&lt; Type, Entity &gt;::page_size</a></div><div class="ttdeci">static constexpr std::size_t page_size</div><div class="ttdef"><b>Definition</b> <a href="#l00054">component.hpp:54</a></div></div>
</div><!-- fragment --></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.10.0
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>