86 lines
15 KiB
HTML
86 lines
15 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: src/entt/resource/handle.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.1.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>
|
|
<!-- 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_85dbee8884f1b3a817fa7eff8dff73ec.html">resource</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">handle.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_RESOURCE_HANDLE_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_RESOURCE_HANDLE_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> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../config/config.h"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "fwd.hpp"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">template</span><<span class="keyword">typename</span> Resource></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>resource_handle {</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#aa58438d97a0e80057bbb837e2a4477d6"> 29</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classentt_1_1resource__cache.html">resource_cache</a><Resource>;</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>  <a class="code" href="classentt_1_1resource__handle.html#ac0346238aa57dbf5df3ce775ceba856f">resource_handle</a>(std::shared_ptr<Resource> res) ENTT_NOEXCEPT</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  : resource{std::move(res)}</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> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classentt_1_1resource__handle.html#ac0346238aa57dbf5df3ce775ceba856f">resource_handle</a>() ENTT_NOEXCEPT = default;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#a694112d96f6c6f4e1c803aa2824996c7"> 49</a></span>  const Resource & <a class="code" href="classentt_1_1resource__handle.html#a694112d96f6c6f4e1c803aa2824996c7">get</a>() const ENTT_NOEXCEPT {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  ENTT_ASSERT(static_cast<bool>(resource));</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> *resource;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#acc5633b4cd5282afe2f7783a515fb131"> 55</a></span>  Resource & <span class="keyword">get</span>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> <span class="keyword">const_cast<</span>Resource &<span class="keyword">></span>(std::as_const(*this).get());</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#ab22a293cb18602690309a561b97d28cb"> 60</a></span>  <span class="keyword">operator</span> <span class="keyword">const</span> Resource & () <span class="keyword">const</span> ENTT_NOEXCEPT { <span class="keywordflow">return</span> <span class="keyword">get</span>(); }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#a018fc3493748b50c4c523737203a2720"> 63</a></span>  <span class="keyword">operator</span> Resource & () ENTT_NOEXCEPT { <span class="keywordflow">return</span> <span class="keyword">get</span>(); }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#a2b014e1f6f871f25329c6bed1048f0ef"> 66</a></span>  <span class="keyword">const</span> Resource & <a class="code" href="classentt_1_1resource__handle.html#a2b014e1f6f871f25329c6bed1048f0ef">operator *</a>() const ENTT_NOEXCEPT { <span class="keywordflow">return</span> <span class="keyword">get</span>(); }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#ad0ea25378f929f0d34db78d09e7b79c7"> 69</a></span>  Resource & <a class="code" href="classentt_1_1resource__handle.html#a2b014e1f6f871f25329c6bed1048f0ef">operator *</a>() ENTT_NOEXCEPT { <span class="keywordflow">return</span> <span class="keyword">get</span>(); }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#ab2b2301a2f2f81f14979a9278c565e78"> 82</a></span>  <span class="keyword">const</span> Resource * <a class="code" href="classentt_1_1resource__handle.html#ab2b2301a2f2f81f14979a9278c565e78">operator-></a>() const ENTT_NOEXCEPT {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  ENTT_ASSERT(static_cast<bool>(resource));</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> resource.get();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#ab8ef3d0c613cd42a30407b04537ea0f5"> 88</a></span>  Resource * <a class="code" href="classentt_1_1resource__handle.html#ab8ef3d0c613cd42a30407b04537ea0f5">operator-></a>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> <span class="keyword">const_cast<</span>Resource *<span class="keyword">></span>(std::as_const(*this).operator->());</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classentt_1_1resource__handle.html#a78608879425212e25817c16e3393ee07"> 96</a></span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">bool</span><span class="keyword">></span>(resource); }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::shared_ptr<Resource> resource;</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> </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> }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </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> <span class="preprocessor">#endif // ENTT_RESOURCE_HANDLE_HPP</span></div><div class="ttc" id="classentt_1_1resource__handle_html_ac0346238aa57dbf5df3ce775ceba856f"><div class="ttname"><a href="classentt_1_1resource__handle.html#ac0346238aa57dbf5df3ce775ceba856f">entt::resource_handle::resource_handle</a></div><div class="ttdeci">resource_handle() ENTT_NOEXCEPT=default</div><div class="ttdoc">Default constructor. </div></div>
|
|
<div class="ttc" id="classentt_1_1resource__cache_html"><div class="ttname"><a href="classentt_1_1resource__cache.html">entt::resource_cache</a></div><div class="ttdoc">Simple cache for resources of a given type. </div><div class="ttdef"><b>Definition:</b> <a href="cache_8hpp_source.html#l00029">cache.hpp:29</a></div></div>
|
|
<div class="ttc" id="namespaceentt_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="algorithm_8hpp_source.html#l00012">algorithm.hpp:12</a></div></div>
|
|
<div class="ttc" id="classentt_1_1resource__handle_html_ab8ef3d0c613cd42a30407b04537ea0f5"><div class="ttname"><a href="classentt_1_1resource__handle.html#ab8ef3d0c613cd42a30407b04537ea0f5">entt::resource_handle::operator-></a></div><div class="ttdeci">Resource * operator->() ENTT_NOEXCEPT</div><div class="ttdoc">Gets a pointer to the managed resource. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00088">handle.hpp:88</a></div></div>
|
|
<div class="ttc" id="classentt_1_1resource__handle_html_a2b014e1f6f871f25329c6bed1048f0ef"><div class="ttname"><a href="classentt_1_1resource__handle.html#a2b014e1f6f871f25329c6bed1048f0ef">entt::resource_handle::operator*</a></div><div class="ttdeci">const Resource & operator*() const ENTT_NOEXCEPT</div><div class="ttdoc">Gets a reference to the managed resource. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00066">handle.hpp:66</a></div></div>
|
|
<div class="ttc" id="classentt_1_1resource__handle_html_ab2b2301a2f2f81f14979a9278c565e78"><div class="ttname"><a href="classentt_1_1resource__handle.html#ab2b2301a2f2f81f14979a9278c565e78">entt::resource_handle::operator-></a></div><div class="ttdeci">const Resource * operator->() const ENTT_NOEXCEPT</div><div class="ttdoc">Gets a pointer to the managed resource. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00082">handle.hpp:82</a></div></div>
|
|
<div class="ttc" id="classentt_1_1resource__handle_html_a694112d96f6c6f4e1c803aa2824996c7"><div class="ttname"><a href="classentt_1_1resource__handle.html#a694112d96f6c6f4e1c803aa2824996c7">entt::resource_handle::get</a></div><div class="ttdeci">const Resource & get() const ENTT_NOEXCEPT</div><div class="ttdoc">Gets a reference to the managed resource. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00049">handle.hpp:49</a></div></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>
|