75 lines
51 KiB
HTML
75 lines
51 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">2.7.3</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://travis-ci.org/skypjack/entt)</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> [](https://ci.appveyor.com/project/skypjack/entt)</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> [](https://coveralls.io/github/skypjack/entt?branch=master)</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> [](https://gitter.im/skypjack/entt)</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> [](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=W2HF9FESD5LJY&lc=IT&item_name=Michele%20Caini&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> # Table of Contents</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> * [Introduction](#introduction)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  * [Code Example](#code-example)</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  * [Motivation](#motivation)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  * [Performance](#performance)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> * [Build Instructions](#build-instructions)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  * [Requirements](#requirements)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  * [Library](#library)</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  * [Documentation](#documentation)</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  * [Tests](#tests)</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> * [Packaging Tools](#packaging-tools)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> * [EnTT in Action](#entt-in-action)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> * [Contributors](#contributors)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> * [License](#license)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> * [Support](#support)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  * [Donation](#donation)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  * [Hire me](#hire-me)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <!--</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> --></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> # Introduction</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> `EnTT` is a header-only, tiny and easy to use entity-component system (and much</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> more) written in modern C++ and even</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> [used by Mojang in Minecraft](https://minecraft.net/en-us/attribution/).<br/></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> The entity-component-system (also known as _ECS_) is an architectural pattern</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> used mostly in game development. For further details:</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> * [Entity Systems Wiki](http://entity-systems.wikidot.com/)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> * [Evolve Your Hierarchy](http://cowboyprogramming.com/2007/01/05/evolve-your-heirachy/)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> * [ECS on Wikipedia](https://en.wikipedia.org/wiki/Entity%E2%80%93component%E2%80%93system)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> A long time ago, the sole entity-component system was part of the project. After</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> a while the codebase has grown and more and more classes have become part of the</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> repository.<br/></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> Here is a brief, yet incomplete list of what it offers today:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> * Statically generated integer identifiers for types (assigned either at</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  compile-time or at runtime).</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> * A constexpr utility for human readable resource identifiers.</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> * A minimal configuration system built on top of the monostate pattern.</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> * An incredibly fast entity-component system based on sparse sets, with its own</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  views and a _pay for what you use_ policy to adjust performance and memory</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  usage according to users' requirements.</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> * A lot of facilities built on top of the entity-component system to help</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  developers and avoid reinventing the wheel (ie dependencies, snapshot, actor</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  class for those who aren't confident with the architecture and so on).</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> * The smallest and most basic implementation of a service locator ever seen.</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> * A cooperative scheduler for processes of any type.</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> * All what is needed for resource management (cache, loaders, handles).</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> * Delegates, signal handlers (with built-in support for collectors) and a tiny</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  event dispatcher.</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> * A general purpose event emitter, that is a CRTP idiom based class template.</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> * An event dispatcher for immediate and delayed events to integrate in loops.</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> * Any other business.</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> Consider it a work in progress. The whole API is also fully documented in-code</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> for those who are brave enough to read it.</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> Currently, `EnTT` is tested on Linux, Microsoft Windows and OS X. It has proven</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> to work also on both Android and iOS.<br/></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> Most likely it will not be problematic on other systems as well, but has not</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> been sufficiently tested so far.</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> ## Code Example</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> ```cpp</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> #include <entt/entt.hpp></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> #include <cstdint></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> struct Position {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  float x;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  float y;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</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> struct Velocity {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  float dx;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  float dy;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> void update(entt::DefaultRegistry &registry) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  auto view = registry.view<Position, Velocity>();</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>  for(auto entity: view) {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  // gets only the components that are going to be used ...</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>  auto &velocity = view.get<Velocity>(entity);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  velocity.dx = 0.;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  velocity.dy = 0.;</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>  // ...</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> }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> void update(std::uint64_t dt, entt::DefaultRegistry &registry) {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  registry.view<Position, Velocity>().each([dt](auto entity, auto &position, auto &velocity) {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  // gets all the components of the view at once ...</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  position.x += velocity.dx * dt;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  position.y += velocity.dy * dt;</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>  // ...</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  });</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> }</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> int main() {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  entt::DefaultRegistry registry;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  std::uint64_t dt = 16;</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 i = 0; i < 10; ++i) {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  auto entity = registry.create();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  registry.assign<Position>(entity, i * 1.f, i * 1.f);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  if(i % 2 == 0) { registry.assign<Velocity>(entity, i * .1f, i * .1f); }</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> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  update(dt, registry);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  update(registry);</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> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> ## Motivation</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> I started working on `EnTT` because of the wrong reason: my goal was to design</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> an entity-component system that beated another well known open source solution</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> in terms of performance and used (possibly) less memory in the average</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> case.<br/></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> In the end, I did it, but it wasn't much satisfying. Actually it wasn't</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> satisfying at all. The fastest and nothing more, fairly little indeed. When I</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> realized it, I tried hard to keep intact the great performance of `EnTT` and to</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> add all the features I wanted to see in *my own library* at the same time.</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> Nowadays, `EnTT` is finally what I was looking for: still faster than its</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> _competitors_, lower memory usage in the average case, a really good API and an</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> amazing set of features. And even more, of course.</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> ## Performance</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> As it stands right now, `EnTT` is just fast enough for my requirements if</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> compared to my first choice (it was already amazingly fast actually).<br/></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> Below is a comparison between the two (both of them compiled with GCC 7.3.0 on a</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> Dell XPS 13 out of the mid 2014):</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> | Benchmark | EntityX (compile-time) | EnTT |</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> | Create 1M entities | 0.0147s | **0.0046s** |</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> | Destroy 1M entities | 0.0053s | **0.0045s** |</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> | 1M entities, one component | 0.0012s | **1.9e-07s** |</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> | 1M entities, two components | 0.0012s | **3.8e-07s** |</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> | 1M entities, two components<br/>Half of the entities have all the components | 0.0009s | **3.8e-07s** |</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> | 1M entities, two components<br/>One of the entities has all the components | 0.0008s | **1.0e-06s** |</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> | 1M entities, five components | 0.0010s | **7.0e-07s** |</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> | 1M entities, ten components | 0.0011s | **1.2e-06s** |</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> | 1M entities, ten components<br/>Half of the entities have all the components | 0.0010s | **1.2e-06s** |</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> | 1M entities, ten components<br/>One of the entities has all the components | 0.0008s | **1.2e-06s** |</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> | Sort 150k entities, one component<br/>Arrays are in reverse order | - | **0.0036s** |</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> | Sort 150k entities, enforce permutation<br/>Arrays are in reverse order | - | **0.0005s** |</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> | Sort 150k entities, one component<br/>Arrays are almost sorted, std::sort | - | **0.0035s** |</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> | Sort 150k entities, one component<br/>Arrays are almost sorted, insertion sort | - | **0.0007s** |</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> Note: The default version of `EntityX` (`master` branch) wasn't added to the</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> comparison because it's already much slower than its compile-time counterpart.</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> Pretty interesting, aren't them? In fact, these benchmarks are the same used by</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> `EntityX` to show _how fast it is_. To be honest, they aren't so good and these</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> results shouldn't be taken much seriously (they are completely unrealistic</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> indeed).<br/></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> The proposed entity-component system is incredibly fast to iterate entities,</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> this is a fact. The compiler can make a lot of optimizations because of how</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> `EnTT` works, even more when components aren't used at all. This is exactly the</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> case for these benchmarks. On the other hand and if we consider real world</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> cases, `EnTT` is in the middle between a bit and much faster than the other</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> solutions around when users also access the components and not just the</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> entities, although it is not as fast as reported by these benchmarks.<br/></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> This is why they are completely wrong and cannot be used to evaluate any of the</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> entity-component systems.</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> If you decide to use `EnTT`, choose it because of its API, features and</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> performance, not because there is a benchmark somewhere that makes it seem the</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> fastest.</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> Probably I'll try to get out of `EnTT` more features and even better performance</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> in the future, mainly for fun.<br/></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> If you want to contribute and/or have any suggestion, feel free to make a PR or</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> open an issue to discuss your idea.</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> # Build Instructions</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ## Requirements</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> To be able to use `EnTT`, users must provide a full-featured compiler that</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> supports at least C++14.<br/></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> The requirements below are mandatory to compile the tests and to extract the</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> documentation:</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> * CMake version 3.2 or later.</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> * Doxygen version 1.8 or later.</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> ## Library</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> `EnTT` is a header-only library. This means that including the `entt.hpp` header</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> is enough to include the library as a whole and use it. For those who are</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> interested only in the entity-component system, consider to include the sole</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> `entity/registry.hpp` header instead.<br/></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> It's a matter of adding the following line to the top of a file:</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> ```cpp</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> #include <entt/entt.hpp></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> ```</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> Use the line below to include only the entity-component system instead:</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> ```cpp</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> #include <entt/entity/registry.hpp></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> </div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> Then pass the proper `-I` argument to the compiler to add the `src` directory to</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> the include paths.</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> ## Documentation</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> The documentation is based on [doxygen](http://www.stack.nl/~dimitri/doxygen/).</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> To build it:</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  $ cd build</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  $ cmake .. -DBUILD_DOCS=ON</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  $ make</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> The API reference will be created in HTML format within the directory</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> `build/docs/html`. To navigate it with your favorite browser:</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  $ cd build</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  $ your_favorite_browser docs/html/index.html</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <!--</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> --></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> The API reference is also available [online](https://skypjack.github.io/entt/)</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> for the latest version.<br/></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> There exists also a [wiki](https://github.com/skypjack/entt/wiki) dedicated to</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> the project where users can find all related documentation pages.</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <!--</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> --></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> ## Tests</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> To compile and run the tests, `EnTT` requires *googletest*.<br/></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> `cmake` will download and compile the library before compiling anything else.</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> In order to build without tests set CMake option `BUILD_TESTING=OFF`.</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> To build the most basic set of tests:</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> * `$ cd build`</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> * `$ cmake ..`</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> * `$ make`</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> * `$ make test`</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> Note that benchmarks are not part of this set.</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> # Packaging Tools</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> `EnTT` is available for some of the most known packaging tools. In particular:</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> * [`vcpkg`](https://github.com/Microsoft/vcpkg/tree/master/ports/entt),</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  Microsoft VC++ Packaging Tool.</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> * [`Homebrew`](https://github.com/skypjack/homebrew-entt), the missing package</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  manager for macOS.<br/></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  Available as a homebrew formula. Just type the following to install it:</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>  brew install skypjack/entt/entt</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  ```</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> Consider this list a work in progress and help me to make it longer.</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> # EnTT in Action</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> `EnTT` is widely used in private and commercial applications. I cannot even</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> mention most of them because of some signatures I put on some documents time</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> ago.<br/></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> Fortunately, there are also people who took the time to implement open source</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> projects based on EnTT and did not hold back when it came to documenting them.</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> Below an incomplete list of projects and articles:</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> * [Minecraft](https://minecraft.net/en-us/attribution/): of course, **that**</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  Minecraft, by Mojang (see the open source attributions page).</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> * [Face Smash](https://play.google.com/store/apps/details?id=com.gamee.facesmash):</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  the emojis dominate the world, destroy them all with your facial expressions.</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> * [shiva](https://github.com/Milerius/shiva): modern C++ Engine with modularity.</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> * [Classic Tower Defence](https://github.com/kerndog73/Classic-Tower-Defence):</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  a tiny little tower defence game featuring a homemade font.</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  [Check it out](https://indi-kernick.itch.io/classic-tower-defence).</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> * [The Machine](https://github.com/Kerndog73/The-Machine): a box pushing puzzler</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  with logic gates and other cool stuff.</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  [Check it out](https://indi-kernick.itch.io/the-machine-web-version).</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> * [EnttPong](https://github.com/reworks/EnttPong): example game with `EnTT`.</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> * [Space Battle: Huge edition](http://victor.madtriangles.com/code%20experiment/2018/06/11/post-ecs-battle-huge.html):</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  huge space battle built entirely from scratch.</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> * [Space Battle](https://github.com/vblanco20-1/ECS_SpaceBattle): huge space</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  battle built on `UE4`.</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> * [Experimenting with ECS in UE4](http://victor.madtriangles.com/code%20experiment/2018/03/25/post-ue4-ecs-battle.html):</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  interesting article about `UE4` and `EnTT`.</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> * [Implementing ECS architecture in UE4](https://forums.unrealengine.com/development-discussion/c-gameplay-programming/1449913-implementing-ecs-architecture-in-ue4-giant-space-battle):</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  giant space battle.</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> * [MatchOneEntt](https://github.com/mhaemmerle/MatchOneEntt): port of</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  [Match One](https://github.com/sschmid/Match-One) for `Entitas-CSharp`.</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> * [Randballs](https://github.com/gale93/randballs): simple `SFML` and `EnTT`</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  playground.</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> </div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> If you know of other resources out there that are about `EnTT`, feel free to</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> open an issue or a PR and I'll be glad to add them to the list.</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> </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> @cond TURN_OFF_DOXYGEN</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> # Contributors</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> `EnTT` was written initially as a faster alternative to other well known and</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> open source entity-component systems. Nowadays this library is moving its first</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> steps. Much more will come in the future and hopefully I'm going to work on it</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> for a long time.<br/></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> Requests for features, PR, suggestions ad feedback are highly appreciated.</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> </div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> If you find you can help me and want to contribute to the project with your</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> experience or you do want to get part of the project for some other reasons,</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> feel free to contact me directly (you can find the mail in the</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> [profile](https://github.com/skypjack)).<br/></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> I can't promise that each and every contribution will be accepted, but I can</div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> assure that I'll do my best to take them all seriously.</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> If you decide to participate, please see the guidelines for</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> [contributing](docs/CONTRIBUTING.md) before to create issues or pull requests.<br/></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> Take also a look at the</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> know who has participated so far.</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> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> --></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> </div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> # License</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> </div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> Code and documentation Copyright (c) 2017-2018 Michele Caini.<br/></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> Logo Copyright (c) 2018 Richard Caseres.</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> </div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> Code released under</div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> [the MIT license](https://github.com/skypjack/entt/blob/master/LICENSE).</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> Documentation released under</div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).<br/></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> Logo released under</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).</div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> </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> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> --></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> # Support</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> </div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> ## Donation</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> Developing and maintaining `EnTT` takes some time and lots of coffee. I'd like</div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> to add more and more functionalities in future and turn it in a full-featured</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> solution.<br/></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> If you want to support this project, you can offer me an espresso. I'm from</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> Italy, we're used to turning the best coffee ever in code. If you find that</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> it's not enough, feel free to support me the way you prefer.<br/></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> Take a look at the donation button at the top of the page for more details or</div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> just click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=W2HF9FESD5LJY&lc=IT&item_name=Michele%20Caini&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted).</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> </div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> ## Hire me</div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> </div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> If you start using `EnTT` and need help, if you want a new feature and want me</div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> to give it the highest priority, if you have any other reason to contact me:</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> do not hesitate. I'm available for hiring.<br/></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> Feel free to take a look at my [profile](https://github.com/skypjack) and</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> contact me by mail.</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>
|