126 lines
12 KiB
HTML
126 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/entity/component.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">EnTT
|
|
 <span id="projectnumber">3.10.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_e3a7bb56c55e5c2286e2fe96e197d4f5.html">entity</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">component.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef ENTT_ENTITY_COMPONENT_HPP</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_ENTITY_COMPONENT_HPP</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <cstddef></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "../config/config.h"</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>internal {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">template</span><<span class="keyword">typename</span>, <span class="keyword">typename</span> = <span class="keywordtype">void</span>></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">struct </span>in_place_delete: std::false_type {};</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">struct </span>in_place_delete<Type, std::enable_if_t<Type::in_place_delete>></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  : std::true_type {};</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> <span class="keyword">template</span><<span class="keyword">typename</span> Type, <span class="keyword">typename</span> = <span class="keywordtype">void</span>></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">struct </span>page_size: std::integral_constant<std::size_t, (ENTT_IGNORE_IF_EMPTY && std::is_empty_v<Type>) ? 0u : ENTT_PACKED_PAGE> {};</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">struct </span>page_size<Type, std::enable_if_t<std::is_convertible_v<decltype(Type::page_size), std::size_t>>></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  : std::integral_constant<std::size_t, Type::page_size> {};</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> } <span class="comment">// namespace internal</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type, <span class="keyword">typename</span> = <span class="keywordtype">void</span>></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html"> 43</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1component__traits.html">component_traits</a> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  static_assert(std::is_same_v<std::decay_t<Type>, Type>, <span class="stringliteral">"Unsupported type"</span>);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f"> 47</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f">in_place_delete</a> = internal::in_place_delete<Type>::value;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b"> 49</a></span>  <span class="keyword">static</span> constexpr std::size_t <a class="code" href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b">page_size</a> = internal::page_size<Type>::value;</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>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">template</span><<span class="keyword">class</span> Type></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="namespaceentt.html#ab9f9b531ebde614244a0da111d4b66ff"> 57</a></span> <span class="keyword">inline</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#ab9f9b531ebde614244a0da111d4b66ff">ignore_as_empty_v</a> = (<a class="code" href="structentt_1_1component__traits.html">component_traits<Type>::page_size</a> == 0u);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace entt</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="dense__map_8hpp_source.html#l00022">dense_map.hpp:22</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_ab9f9b531ebde614244a0da111d4b66ff"><div class="ttname"><a href="namespaceentt.html#ab9f9b531ebde614244a0da111d4b66ff">entt::ignore_as_empty_v</a></div><div class="ttdeci">constexpr bool ignore_as_empty_v</div><div class="ttdoc">Helper variable template.</div><div class="ttdef"><b>Definition:</b> <a href="component_8hpp_source.html#l00057">component.hpp:57</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1component__traits_html"><div class="ttname"><a href="structentt_1_1component__traits.html">entt::component_traits</a></div><div class="ttdoc">Common way to access various properties of components.</div><div class="ttdef"><b>Definition:</b> <a href="component_8hpp_source.html#l00043">component.hpp:43</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1component__traits_html_a8fa4acd0fc9b0c554ea805961a5b6f8b"><div class="ttname"><a href="structentt_1_1component__traits.html#a8fa4acd0fc9b0c554ea805961a5b6f8b">entt::component_traits::page_size</a></div><div class="ttdeci">static constexpr std::size_t page_size</div><div class="ttdoc">Page size, default is ENTT_PACKED_PAGE for non-empty types.</div><div class="ttdef"><b>Definition:</b> <a href="component_8hpp_source.html#l00049">component.hpp:49</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1component__traits_html_ac3efe50eb183fe2a31b642ade474017f"><div class="ttname"><a href="structentt_1_1component__traits.html#ac3efe50eb183fe2a31b642ade474017f">entt::component_traits::in_place_delete</a></div><div class="ttdeci">static constexpr bool in_place_delete</div><div class="ttdoc">Pointer stability, default is false.</div><div class="ttdef"><b>Definition:</b> <a href="component_8hpp_source.html#l00047">component.hpp:47</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|