75 lines
49 KiB
HTML
75 lines
49 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: README.md 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.2.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">README.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00002"></a><span class="lineno"> 2</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> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> --></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> [](https://github.com/skypjack/entt/releases)</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> [](https://github.com/skypjack/entt/actions)</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> [](https://codecov.io/gh/skypjack/entt)</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> [](https://godbolt.org/z/v8txVr)</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> [](https://gitter.im/skypjack/entt)</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> [](https://www.paypal.me/skypjack)</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> [](https://www.patreon.com/bePatron?c=1772573)</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> `EnTT` is a header-only, tiny and easy to use library for game programming and</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> much more written in **modern C++**, mainly known for its innovative</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> **entity-component-system (ECS)** model.<br/></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> [Among others](https://github.com/skypjack/entt/wiki/EnTT-in-Action), it's used</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> in [**Minecraft**](https://minecraft.net/en-us/attribution/) by Mojang and the</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> [**ArcGIS Runtime SDKs**](https://developers.arcgis.com/arcgis-runtime/) by</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> Esri. Open an issue or submit a PR if you don't see your project in the list!</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> ---</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> Do you want to **keep up with changes** or do you have a **question** that</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> doesn't require you to open an issue?<br/></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> Join the [gitter channel](https://gitter.im/skypjack/entt) and meet other users</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> like you. The more we are, the better for everyone.</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> Wondering why your **debug build** is so slow on Windows or how to represent a</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> **hierarchy** with components?<br/></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> Check out the</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> [FAQ](https://github.com/skypjack/entt/wiki/Frequently-Asked-Questions) and the</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> [wiki](https://github.com/skypjack/entt/wiki) if you have these or other doubts,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> your answers may already be there.</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> If you use `EnTT` and you want to say thanks or support the project, please</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> **consider becoming a</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> [sponsor](https://github.com/users/skypjack/sponsorship)**.<br/></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> You can help me make the difference.</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> [Many thanks](https://skypjack.github.io/sponsorship/) to those who supported me</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> and still support me today.</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> # Table of Contents</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> * [Introduction](#introduction)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  * [Code Example](#code-example)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  * [Motivation](#motivation)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  * [Performance](#performance)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> * [Build Instructions](#build-instructions)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  * [Requirements](#requirements)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  * [Library](#library)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  * [Documentation](#documentation)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  * [Tests](#tests)</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> * [Packaging Tools](#packaging-tools)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> * [EnTT in Action](#entt-in-action)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> * [Contributors](#contributors)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> * [License](#license)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> * [Support](#support)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <!--</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> --></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> # Introduction</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> The entity-component-system (also known as _ECS_) is an architectural pattern</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> used mostly in game development. For further details:</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> * [Entity Systems Wiki](http://entity-systems.wikidot.com/)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> * [Evolve Your Hierarchy](http://cowboyprogramming.com/2007/01/05/evolve-your-heirachy/)</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> * [ECS on Wikipedia](https://en.wikipedia.org/wiki/Entity%E2%80%93component%E2%80%93system)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> This project started off as a pure entity-component system. Over time the</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> codebase has grown as more and more classes and functionalities were added.<br/></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> Here is a brief, yet incomplete list of what it offers today:</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> * Statically generated integer **identifiers** for types (assigned either at</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  compile-time or at runtime).</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> * A `constexpr` utility for human readable **resource names**.</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> * A minimal **configuration system** built using the monostate pattern.</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> * An incredibly fast **entity-component system** based on sparse sets, with its</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  own _pay for what you use_ policy to adjust performance and memory usage</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  according to the users' requirements.</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> * Views and groups to iterate entities and components and allow different access</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  patterns, from **perfect SoA** to fully random.</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> * A lot of **facilities** built on top of the entity-component system to help</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  the users and avoid reinventing the wheel (dependencies, snapshot, actor</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  class, support for **reactive systems** and so on).</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> * The smallest and most basic implementation of a **service locator** ever seen.</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> * A built-in, non-intrusive and macro-free runtime **reflection system**.</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> * A **cooperative scheduler** for processes of any type.</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> * All that is needed for **resource management** (cache, loaders, handles).</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> * Delegates, **signal handlers** (with built-in support for collectors) and a</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  tiny event dispatcher for immediate and delayed events to integrate in loops.</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> * A general purpose **event emitter** as a CRTP idiom based class template.</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> * And **much more**! Check out the</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  [**wiki**](https://github.com/skypjack/entt/wiki).</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> Consider this list a work in progress as well as the project. The whole API is</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> fully documented in-code for those who are brave enough to read it.</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> Currently, `EnTT` is tested on Linux, Microsoft Windows and OSX. It has proven</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> to work also on both Android and iOS.<br/></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> Most likely it won't be problematic on other systems as well, but it hasn't been</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> sufficiently tested so far.</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> ## Code Example</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> ```cpp</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> #include <entt/entt.hpp></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> #include <cstdint></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> struct position {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  float x;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  float y;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> struct velocity {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  float dx;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  float dy;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> };</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> void update(entt::registry &registry) {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  auto view = registry.view<position, velocity>();</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  for(auto entity: view) {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  // gets only the components that are going to be used ...</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  auto &vel = view.get<velocity>(entity);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  vel.dx = 0.;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  vel.dy = 0.;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  // ...</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> }</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> void update(std::uint64_t dt, entt::registry &registry) {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  registry.view<position, velocity>().each([dt](auto &pos, auto &vel) {</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  // gets all the components of the view at once ...</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  pos.x += vel.dx * dt;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  pos.y += vel.dy * dt;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  // ...</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  });</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> }</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> int main() {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  entt::registry registry;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  std::uint64_t dt = 16;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  for(auto i = 0; i < 10; ++i) {</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  auto entity = registry.create();</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  registry.assign<position>(entity, i * 1.f, i * 1.f);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  if(i % 2 == 0) { registry.assign<velocity>(entity, i * .1f, i * .1f); }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  }</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  update(dt, registry);</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  update(registry);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  // ...</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> }</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> ```</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> ## Motivation</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> I started developing `EnTT` for the _wrong_ reason: my goal was to design an</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> entity-component system to beat another well known open source solution both in</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> terms of performance and possibly memory usage.<br/></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> In the end, I did it, but it wasn't very satisfying. Actually it wasn't</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> satisfying at all. The fastest and nothing more, fairly little indeed. When I</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> realized it, I tried hard to keep intact the great performance of `EnTT` and to</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> add all the features I wanted to see in *my own library* at the same time.</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> Nowadays, `EnTT` is finally what I was looking for: still faster than its</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> _competitors_, lower memory usage in the average case, a really good API and an</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> amazing set of features. And even more, of course.</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> ## Performance</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> The proposed entity-component system is incredibly fast to iterate entities and</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> components, this is a fact. Some compilers make a lot of optimizations because</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> of how `EnTT` works, some others aren't that good. In general, if we consider</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> real world cases, `EnTT` is somewhere between a bit and much faster than many of</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> the other solutions around, although I couldn't check them all for obvious</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> reasons.</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> If you are interested, you can compile the `benchmark` test in release mode (to</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> enable compiler optimizations, otherwise it would make little sense) by setting</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> the `BUILD_BENCHMARK` option of `CMake` to `ON`, then evaluate yourself whether</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> you're satisfied with the results or not.</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> Honestly I got tired of updating the README file whenever there is an</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> improvement.<br/></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> There are already a lot of projects out there that use `EnTT` as a basis for</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> comparison (this should already tell you a lot). Many of these benchmarks are</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> completely wrong, many others are simply incomplete, good at omitting some</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> information and using the wrong function to compare a given feature. Certainly</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> there are also good ones but they age quickly if nobody updates them, especially</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> when the library they are dealing with is actively developed.</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> The choice to use `EnTT` should be based on its carefully designed API, its</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> set of features and the general performance, **not** because some single</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> benchmark shows it to be the fastest tool available.</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> In the future I'll likely try to get even better performance while still adding</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> new features, mainly for fun.<br/></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> If you want to contribute and/or have suggestions, feel free to make a PR or</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> open an issue to discuss your idea.</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> # Build Instructions</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> ## Requirements</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> To be able to use `EnTT`, users must provide a full-featured compiler that</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> supports at least C++17.<br/></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> The requirements below are mandatory to compile the tests and to extract the</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> documentation:</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> * `CMake` version 3.2 or later.</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> * `Doxygen` version 1.8 or later.</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> Alternatively, `Bazel` is also supported as a build system (credits to</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> [zaucy](https://github.com/zaucy) who introduced what's required with</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> [this](https://github.com/skypjack/entt/pull/291) pull request and offered to</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> maintain it).<br/></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> In the documentation below I'll still refer to `CMake`, this being the official</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> build system of the library.</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> If you are looking for a C++14 version of `EnTT`, check out the git tag `cpp14`.</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> ## Library</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> `EnTT` is a header-only library. This means that including the `entt.hpp` header</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> is enough to include the library as a whole and use it. For those who are</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> interested only in the entity-component system, consider to include the sole</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> `entity/registry.hpp` header instead.<br/></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> It's a matter of adding the following line to the top of a file:</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> ```cpp</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> #include <entt/entt.hpp></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> ```</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> Use the line below to include only the entity-component system instead:</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> ```cpp</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> #include <entt/entity/registry.hpp></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> ```</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> Then pass the proper `-I` argument to the compiler to add the `src` directory to</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> the include paths.</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> ## Documentation</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> The documentation is based on [doxygen](http://www.doxygen.nl/).</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> To build it:</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  $ cd build</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  $ cmake .. -DBUILD_DOCS=ON</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  $ make</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> The API reference will be created in HTML format within the directory</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> `build/docs/html`. To navigate it with your favorite browser:</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  $ cd build</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  $ your_favorite_browser docs/html/index.html</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <!--</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> --></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> It's also available [online](https://skypjack.github.io/entt/) for the latest</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> version.<br/></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> Finally, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> to the project where users can find all related documentation pages.</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <!--</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> --></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> ## Tests</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> To compile and run the tests, `EnTT` requires *googletest*.<br/></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> `cmake` will download and compile the library before compiling anything else.</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> In order to build the tests, set the CMake option `BUILD_TESTING` to `ON`.</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> To build the most basic set of tests:</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> * `$ cd build`</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> * `$ cmake -DBUILD_TESTING=ON ..`</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> * `$ make`</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> * `$ make test`</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> Note that benchmarks are not part of this set.</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> # Packaging Tools</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> `EnTT` is available for some of the most known packaging tools. In particular:</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> * [`Conan`](https://bintray.com/skypjack/conan/entt%3Askypjack/_latestVersion),</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  the C/C++ Package Manager for Developers.</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> * [`vcpkg`](https://github.com/Microsoft/vcpkg/tree/master/ports/entt),</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  Microsoft VC++ Packaging Tool.<br/></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  You can download and install `EnTT` in just a few simple steps:</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  ```</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  $ git clone https://github.com/Microsoft/vcpkg.git</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  $ cd vcpkg</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  $ ./bootstrap-vcpkg.sh</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  $ ./vcpkg integrate install</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  $ vcpkg install entt</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  ```</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  The `EnTT` port in `vcpkg` is kept up to date by Microsoft team members and</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  community contributors.<br/></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  If the version is out of date, please</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  `vcpkg` repository.</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> </div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> * [`Homebrew`](https://github.com/skypjack/homebrew-entt), the missing package</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  manager for macOS.<br/></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  Available as a homebrew formula. Just type the following to install it:</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> </div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  ```</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  brew install skypjack/entt/entt</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  ```</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> </div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> Consider this list a work in progress and help me to make it longer.</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <!--</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> --></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> # EnTT in Action</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> </div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> `EnTT` is widely used in private and commercial applications. I cannot even</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> mention most of them because of some signatures I put on some documents time</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> ago. Fortunately, there are also people who took the time to implement open</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> source projects based on `EnTT` and did not hold back when it came to</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> documenting them.</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> </div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> [Here](https://github.com/skypjack/entt/wiki/EnTT-in-Action) you can find an</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> incomplete list of games, applications and articles that can be used as a</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> reference.</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> If you know of other resources out there that are about `EnTT`, feel free to</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> open an issue or a PR and I'll be glad to add them to the list.</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> # Contributors</div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> </div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> `EnTT` was written initially as a faster alternative to other well known and</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> open source entity-component systems. Nowadays this library is moving its first</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> steps. Much more will come in the future and hopefully I'm going to work on it</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> for a long time.<br/></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> Requests for features, PR, suggestions ad feedback are highly appreciated.</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> </div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> If you find you can help me and want to contribute to the project with your</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> experience or you do want to get part of the project for some other reasons,</div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> feel free to contact me directly (you can find the mail in the</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> [profile](https://github.com/skypjack)).<br/></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> I can't promise that each and every contribution will be accepted, but I can</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> assure that I'll do my best to take them all seriously.</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> If you decide to participate, please see the guidelines for</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> [contributing](CONTRIBUTING.md) before to create issues or pull</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> requests.<br/></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> Take also a look at the</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> know who has participated so far.</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <!--</div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> --></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> # License</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> </div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> Code and documentation Copyright (c) 2017-2019 Michele Caini.<br/></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> Logo Copyright (c) 2018-2019 Richard Caseres.</div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> Code released under</div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> [the MIT license](https://github.com/skypjack/entt/blob/master/LICENSE).</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> Documentation released under</div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).<br/></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> Logo released under</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <!--</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> --></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> # Support</div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> If you want to support this project, you can</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> [offer me](https://github.com/users/skypjack/sponsorship) an espresso.<br/></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> If you find that it's not enough, feel free to</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> [help me](https://www.paypal.me/skypjack) the way you prefer.</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <!--</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span> --></div></div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|