151 lines
15 KiB
HTML
151 lines
15 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">
|
|
<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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/core/enum.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>
|
|
<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
|
|
 <span id="projectnumber">3.10.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @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&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="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 class="header">
|
|
<div class="headertitle">
|
|
<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> <span class="preprocessor">#ifndef ENTT_CORE_ENUM_HPP</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_CORE_ENUM_HPP</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "../config/config.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type, <span class="keyword">typename</span> = <span class="keywordtype">void</span>></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structentt_1_1enum__as__bitmask.html"> 14</a></span> <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>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">template</span><<span class="keyword">typename</span> 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> <span class="keyword">struct </span><a class="code" href="structentt_1_1enum__as__bitmask.html">enum_as_bitmask</a><Type, std::void_t<decltype(Type::_entt_enum_as_bitmask)>>: std::is_enum<Type> {};</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceentt.html#a8378b9330b5c90b6b11deee3637ebca6"> 25</a></span> <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<Type>::value</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> } <span class="comment">// namespace entt</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> [[nodiscard]] constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> 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>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>Type<span class="keyword">></span>(<span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(lhs) | <span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(rhs));</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> [[nodiscard]] constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> operator&(<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>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>Type<span class="keyword">></span>(<span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(lhs) & <span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(rhs));</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> [[nodiscard]] constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> 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>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>Type<span class="keyword">></span>(<span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(lhs) ^ <span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(rhs));</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> [[nodiscard]] constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> operator~(<span class="keyword">const</span> Type value) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>Type<span class="keyword">></span>(~static_cast<std::underlying_type_t<Type>>(value));</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> [[nodiscard]] constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, <span class="keywordtype">bool</span>></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> operator!(<span class="keyword">const</span> Type value) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> !<span class="keyword">static_cast<</span>std::underlying_type_t<Type><span class="keyword">></span>(value);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type &></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> operator|=(Type &lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> (lhs = (lhs | rhs));</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> }</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type &></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> operator&=(Type &lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> (lhs = (lhs & rhs));</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> constexpr std::enable_if_t<entt::enum_as_bitmask_v<Type>, Type &></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> operator^=(Type &lhs, <span class="keyword">const</span> Type rhs) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> (lhs = (lhs ^ rhs));</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</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="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="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 -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|