85 lines
14 KiB
HTML
85 lines
14 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">2.7.2</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 <cassert></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../config/config.h"</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="l00014"></a><span class="lineno"> 14</span> <span class="keyword">template</span><<span class="keyword">typename</span> Resource></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">class </span>ResourceCache;</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> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> Resource></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> final {</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#a302c9d1bd54cf8e7e958d5e505773b23"> 33</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classentt_1_1ResourceCache.html">ResourceCache</a><Resource>;</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>  <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>(std::shared_ptr<Resource> res) ENTT_NOEXCEPT</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  : resource{std::move(res)}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &) ENTT_NOEXCEPT = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>(<a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &&) ENTT_NOEXCEPT = default;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> & operator=(const <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &) ENTT_NOEXCEPT = default;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> & operator=(<a class="code" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &&) ENTT_NOEXCEPT = default;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#a32e791c4556d040273643ca5f42755a9"> 60</a></span>  const Resource & <a class="code" href="classentt_1_1ResourceHandle.html#a32e791c4556d040273643ca5f42755a9">get</a>() const ENTT_NOEXCEPT {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  assert(static_cast<bool>(resource));</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> *resource;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#aa728424029a170454b7e61056af0926a"> 73</a></span>  <span class="keyword">inline</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="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#a737a5c2e623d30f372ba4876fe3d0fd3"> 85</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> Resource & <a class="code" href="classentt_1_1ResourceHandle.html#a737a5c2e623d30f372ba4876fe3d0fd3">operator *</a>() const ENTT_NOEXCEPT { <span class="keywordflow">return</span> <span class="keyword">get</span>(); }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#a55727b34cb2bcbff11a680bae2fd793e"> 98</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> Resource * <a class="code" href="classentt_1_1ResourceHandle.html#a55727b34cb2bcbff11a680bae2fd793e">operator -></a>() const ENTT_NOEXCEPT {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  assert(static_cast<bool>(resource));</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">return</span> resource.get();</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="l00106"></a><span class="lineno"><a class="line" href="classentt_1_1ResourceHandle.html#a4da18e304419e8d070fbc095236b4403"> 106</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="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  std::shared_ptr<Resource> resource;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> };</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> </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> </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> <span class="preprocessor">#endif // ENTT_RESOURCE_HANDLE_HPP</span></div><div class="ttc" id="classentt_1_1ResourceHandle_html_a32e791c4556d040273643ca5f42755a9"><div class="ttname"><a href="classentt_1_1ResourceHandle.html#a32e791c4556d040273643ca5f42755a9">entt::ResourceHandle::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#l00060">handle.hpp:60</a></div></div>
|
|
<div class="ttc" id="classentt_1_1ResourceHandle_html_a55727b34cb2bcbff11a680bae2fd793e"><div class="ttname"><a href="classentt_1_1ResourceHandle.html#a55727b34cb2bcbff11a680bae2fd793e">entt::ResourceHandle::operator-></a></div><div class="ttdeci">const Resource * operator->() const ENTT_NOEXCEPT</div><div class="ttdoc">Gets a pointer to the managed resource from a handle. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00098">handle.hpp:98</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#l00010">algorithm.hpp:10</a></div></div>
|
|
<div class="ttc" id="classentt_1_1ResourceHandle_html"><div class="ttname"><a href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a></div><div class="ttdoc">Shared resource handle. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00031">handle.hpp:31</a></div></div>
|
|
<div class="ttc" id="classentt_1_1ResourceHandle_html_a737a5c2e623d30f372ba4876fe3d0fd3"><div class="ttname"><a href="classentt_1_1ResourceHandle.html#a737a5c2e623d30f372ba4876fe3d0fd3">entt::ResourceHandle::operator*</a></div><div class="ttdeci">const Resource & operator*() const ENTT_NOEXCEPT</div><div class="ttdoc">Dereferences a handle to obtain the managed resource. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00085">handle.hpp:85</a></div></div>
|
|
<div class="ttc" id="classentt_1_1ResourceCache_html"><div class="ttname"><a href="classentt_1_1ResourceCache.html">entt::ResourceCache</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><!-- 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>
|