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

API reference v3.10.0

Browse Source
This commit is contained in:
Michele Caini
2022-04-18 19:54:29 +02:00
parent 6fdc43199c
commit 378182736c
1056 changed files with 21834 additions and 21924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
enum_8hpp_source.html
View File

@@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.9.0</span>
&#160;<span id="projectnumber">3.10.0</span>
</div>
</td>
</tr>
@@ -70,8 +70,8 @@ $(function() {
<div class="title">enum.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef ENTT_CORE_FLAG_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ENTT_CORE_FLAG_HPP</span></div>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef ENTT_CORE_ENUM_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ENTT_CORE_ENUM_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;../config/config.h&quot;</span></div>
@@ -82,7 +82,7 @@ $(function() {
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structentt_1_1enum__as__bitmask.html"> 14</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1enum__as__bitmask.html">enum_as_bitmask</a>: std::false_type {};</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structentt_1_1enum__as__bitmask_3_01Type_00_01std_1_1void__t_3_01decltype_07Type_1_1__entt__enum__as__bitmask_08_4_01_4.html"> 18</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1enum__as__bitmask.html">enum_as_bitmask</a>&lt;Type, std::void_t&lt;decltype(Type::_entt_enum_as_bitmask)&gt;&gt;: std::true_type {};</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structentt_1_1enum__as__bitmask_3_01Type_00_01std_1_1void__t_3_01decltype_07Type_1_1__entt__enum__as__bitmask_08_4_01_4.html"> 18</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1enum__as__bitmask.html">enum_as_bitmask</a>&lt;Type, std::void_t&lt;decltype(Type::_entt_enum_as_bitmask)&gt;&gt;: std::is_enum&lt;Type&gt; {};</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceentt.html#a8378b9330b5c90b6b11deee3637ebca6"> 25</a></span>&#160;<span class="keyword">inline</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#a8378b9330b5c90b6b11deee3637ebca6">enum_as_bitmask_v</a> = <a class="code" href="structentt_1_1enum__as__bitmask.html">enum_as_bitmask&lt;Type&gt;::value</a>;</div>
@@ -90,69 +90,56 @@ $(function() {
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;} <span class="comment">// namespace entt</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;operator|(<span class="keyword">const</span> Type lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> Type{<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) | <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs)};</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Type<span class="keyword">&gt;</span>(<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) | <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs));</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;operator&amp;(<span class="keyword">const</span> Type lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> Type{<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) &amp; <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs)};</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Type<span class="keyword">&gt;</span>(<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) &amp; <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs));</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;operator^(<span class="keyword">const</span> Type lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> Type{<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) ^ <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs)};</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Type<span class="keyword">&gt;</span>(<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) ^ <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs));</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;operator~(<span class="keyword">const</span> Type value) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> Type{~static_cast&lt;std::underlying_type_t&lt;Type&gt;&gt;(value)};</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Type<span class="keyword">&gt;</span>(~static_cast&lt;std::underlying_type_t&lt;Type&gt;&gt;(value));</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, <span class="keywordtype">bool</span>&gt;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, <span class="keywordtype">bool</span>&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;operator!(<span class="keyword">const</span> Type value) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> !<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(value);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;operator|=(Type &amp;lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> (lhs = (lhs | rhs));</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;operator&amp;=(Type &amp;lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> (lhs = (lhs &amp; rhs));</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;}</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;constexpr std::enable_if_t&lt;entt::enum_as_bitmask_v&lt;Type&gt;, Type &amp;&gt;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;operator^=(Type &amp;lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">return</span> (lhs = (lhs ^ rhs));</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;}</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;operator==(<span class="keyword">const</span> Type lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> (<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(lhs) == <span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Type&gt;<span class="keyword">&gt;</span>(rhs));</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;}</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type&gt;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;[[nodiscard]] constexpr std::enable_if_t&lt;std::is_enum_v&lt;Type&gt; &amp;&amp; entt::enum_as_bitmask_v&lt;Type&gt;, Type&gt;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<a class="code" href="namespaceentt.html#ae38ac5bc7b9097ec21eb1058db206cff">operator!=</a>(<span class="keyword">const</span> Type lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> !(lhs == rhs);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;}</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<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__hash__map_8hpp_source.html#l00021">dense_hash_map.hpp:21</a></div></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<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="anamespaceentt_html_a8378b9330b5c90b6b11deee3637ebca6"><div class="ttname"><a href="namespaceentt.html#a8378b9330b5c90b6b11deee3637ebca6">entt::enum_as_bitmask_v</a></div><div class="ttdeci">constexpr bool enum_as_bitmask_v</div><div class="ttdoc">Helper variable template.</div><div class="ttdef"><b>Definition:</b> <a href="enum_8hpp_source.html#l00025">enum.hpp:25</a></div></div>
<div class="ttc" id="anamespaceentt_html_ae38ac5bc7b9097ec21eb1058db206cff"><div class="ttname"><a href="namespaceentt.html#ae38ac5bc7b9097ec21eb1058db206cff">entt::operator!=</a></div><div class="ttdeci">bool operator!=(const basic_any&lt; Len, Align &gt; &amp;lhs, const basic_any&lt; Len, Align &gt; &amp;rhs)</div><div class="ttdoc">Checks if two wrappers differ in their content.</div><div class="ttdef"><b>Definition:</b> <a href="any_8hpp_source.html#l00406">any.hpp:406</a></div></div>
<div class="ttc" id="astructentt_1_1enum__as__bitmask_html"><div class="ttname"><a href="structentt_1_1enum__as__bitmask.html">entt::enum_as_bitmask</a></div><div class="ttdoc">Enable bitmask support for enum classes.</div><div class="ttdef"><b>Definition:</b> <a href="enum_8hpp_source.html#l00014">enum.hpp:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->