Files
entt/core_2fwd_8hpp_source.html
2025-03-19 15:49:42 +01:00

160 lines
17 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" 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: src/entt/core/fwd.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>
<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="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_de8f4e6ba3f54a2a21309f742e93a373.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">fwd.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ENTT_CORE_FWD_HPP</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ENTT_CORE_FWD_HPP</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;cstddef&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;../config/config.h&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceentt.html">entt</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549"> 11</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549">any_policy</a> : std::uint8_t {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549aa2e4822a98337283e39f7b60acf85ec9"> 13</a></span> <a class="code hl_enumvalue" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549aa2e4822a98337283e39f7b60acf85ec9">empty</a>,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549ab72f3bd391ba731a35708bfd8cd8a68f"> 15</a></span> <a class="code hl_enumvalue" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549ab72f3bd391ba731a35708bfd8cd8a68f">dynamic</a>,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a605abe26d014c72e3df9deb267e73756"> 17</a></span> <a class="code hl_enumvalue" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a605abe26d014c72e3df9deb267e73756">embedded</a>,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a18389a4a9ad5795744699cff0ba66c15"> 19</a></span> <a class="code hl_enumvalue" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a18389a4a9ad5795744699cff0ba66c15">ref</a>,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a1e67f2ff0161fbaf51eccefa9abc6ad2"> 21</a></span> <a class="code hl_enumvalue" href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a1e67f2ff0161fbaf51eccefa9abc6ad2">cref</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>};</div>
</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays, modernize-avoid-c-arrays)</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">template</span>&lt;std::<span class="keywordtype">size_t</span> Len = sizeof(<span class="keywordtype">double</span>[2]), std::<span class="keywordtype">size_t</span> = alignof(<span class="keywordtype">double</span>[2])&gt;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">class </span>basic_any;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303"> 29</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> = ENTT_ID_TYPE;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespaceentt.html#a74619fe0ddf5ff5ea9cf98812a3d70ce"> 32</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceentt.html#a74619fe0ddf5ff5ea9cf98812a3d70ce">any</a> = <a class="code hl_class" href="classentt_1_1basic__any.html">basic_any&lt;&gt;</a>;</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="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">class </span><a class="code hl_class" href="classentt_1_1compressed__pair.html">compressed_pair</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">class </span><a class="code hl_class" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="namespaceentt.html#a1a4c166c8989e0afebf8180e6c85683a"> 41</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceentt.html#a1a4c166c8989e0afebf8180e6c85683a">hashed_string</a> = <a class="code hl_class" href="classentt_1_1basic__hashed__string.html">basic_hashed_string&lt;char&gt;</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespaceentt.html#ac577734cb888e132ce8d87efc5c28ec4"> 44</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceentt.html#ac577734cb888e132ce8d87efc5c28ec4">hashed_wstring</a> = <a class="code hl_class" href="classentt_1_1basic__hashed__string.html">basic_hashed_string&lt;wchar_t&gt;</a>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">// NOLINTNEXTLINE(bugprone-forward-declaration-namespace)</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">struct </span><a class="code hl_struct" href="structentt_1_1type__info.html">type_info</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace entt</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassentt_1_1basic__any_html"><div class="ttname"><a href="classentt_1_1basic__any.html">entt::basic_any&lt;&gt;</a></div></div>
<div class="ttc" id="aclassentt_1_1basic__hashed__string_html"><div class="ttname"><a href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a></div><div class="ttdoc">Zero overhead unique identifier.</div><div class="ttdef"><b>Definition</b> <a href="hashed__string_8hpp_source.html#l00059">hashed_string.hpp:59</a></div></div>
<div class="ttc" id="aclassentt_1_1compressed__pair_html"><div class="ttname"><a href="classentt_1_1compressed__pair.html">entt::compressed_pair</a></div><div class="ttdoc">A compressed pair.</div><div class="ttdef"><b>Definition</b> <a href="compressed__pair_8hpp_source.html#l00085">compressed_pair.hpp:87</a></div></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="anamespaceentt_html_a1a4c166c8989e0afebf8180e6c85683a"><div class="ttname"><a href="namespaceentt.html#a1a4c166c8989e0afebf8180e6c85683a">entt::hashed_string</a></div><div class="ttdeci">basic_hashed_string&lt; char &gt; hashed_string</div><div class="ttdoc">Aliases for common character types.</div><div class="ttdef"><b>Definition</b> <a href="#l00041">fwd.hpp:41</a></div></div>
<div class="ttc" id="anamespaceentt_html_a620d583c0e6d64acf3d394524bb72303"><div class="ttname"><a href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">entt::id_type</a></div><div class="ttdeci">std::uint32_t id_type</div><div class="ttdoc">Alias declaration for type identifiers.</div><div class="ttdef"><b>Definition</b> <a href="#l00029">fwd.hpp:29</a></div></div>
<div class="ttc" id="anamespaceentt_html_a74619fe0ddf5ff5ea9cf98812a3d70ce"><div class="ttname"><a href="namespaceentt.html#a74619fe0ddf5ff5ea9cf98812a3d70ce">entt::any</a></div><div class="ttdeci">basic_any&lt;&gt; any</div><div class="ttdoc">Alias declaration for the most common use case.</div><div class="ttdef"><b>Definition</b> <a href="#l00032">fwd.hpp:32</a></div></div>
<div class="ttc" id="anamespaceentt_html_ac577734cb888e132ce8d87efc5c28ec4"><div class="ttname"><a href="namespaceentt.html#ac577734cb888e132ce8d87efc5c28ec4">entt::hashed_wstring</a></div><div class="ttdeci">basic_hashed_string&lt; wchar_t &gt; hashed_wstring</div><div class="ttdoc">Aliases for common character types.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">fwd.hpp:44</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549">entt::any_policy</a></div><div class="ttdeci">any_policy</div><div class="ttdoc">Possible modes of an any object.</div><div class="ttdef"><b>Definition</b> <a href="#l00011">fwd.hpp:11</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549a18389a4a9ad5795744699cff0ba66c15"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a18389a4a9ad5795744699cff0ba66c15">entt::any_policy::ref</a></div><div class="ttdeci">@ ref</div><div class="ttdoc">Aliasing mode, the object points to a non-const element.</div><div class="ttdef"><b>Definition</b> <a href="#l00019">fwd.hpp:19</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549a1e67f2ff0161fbaf51eccefa9abc6ad2"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a1e67f2ff0161fbaf51eccefa9abc6ad2">entt::any_policy::cref</a></div><div class="ttdeci">@ cref</div><div class="ttdoc">Const aliasing mode, the object points to a const element.</div><div class="ttdef"><b>Definition</b> <a href="#l00021">fwd.hpp:21</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549a605abe26d014c72e3df9deb267e73756"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549a605abe26d014c72e3df9deb267e73756">entt::any_policy::embedded</a></div><div class="ttdeci">@ embedded</div><div class="ttdoc">Owning mode, the object owns an embedded element.</div><div class="ttdef"><b>Definition</b> <a href="#l00017">fwd.hpp:17</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549aa2e4822a98337283e39f7b60acf85ec9"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549aa2e4822a98337283e39f7b60acf85ec9">entt::any_policy::empty</a></div><div class="ttdeci">@ empty</div><div class="ttdoc">Default mode, the object does not own any elements.</div><div class="ttdef"><b>Definition</b> <a href="#l00013">fwd.hpp:13</a></div></div>
<div class="ttc" id="anamespaceentt_html_add777bc22ff30abfbf52abd37d4e1549ab72f3bd391ba731a35708bfd8cd8a68f"><div class="ttname"><a href="namespaceentt.html#add777bc22ff30abfbf52abd37d4e1549ab72f3bd391ba731a35708bfd8cd8a68f">entt::any_policy::dynamic</a></div><div class="ttdeci">@ dynamic</div><div class="ttdoc">Owning mode, the object owns a dynamically allocated element.</div><div class="ttdef"><b>Definition</b> <a href="#l00015">fwd.hpp:15</a></div></div>
<div class="ttc" id="astructentt_1_1type__info_html"><div class="ttname"><a href="structentt_1_1type__info.html">entt::type_info</a></div><div class="ttdoc">Implementation specific information about a type.</div><div class="ttdef"><b>Definition</b> <a href="type__info_8hpp_source.html#l00133">type_info.hpp:133</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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>