Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5bad99476dc36272c2e9983b90ca647fc2297b65
entt/classentt_1_1ResourceHandle.html
Michele Caini 5bad99476d API reference v2.3.0
2017-12-14 23:18:50 +01:00

345 lines
20 KiB
HTML
Raw Blame History

<!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: entt::ResourceHandle&lt; Resource &gt; Class Template Reference</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
&#160;<span id="projectnumber">2.3.0</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="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classentt_1_1ResourceHandle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::ResourceHandle&lt; Resource &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Shared resource handle.
<a href="classentt_1_1ResourceHandle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="handle_8hpp_source.html">handle.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6da91b6620f8c09df53b2220a373f93c"><td class="memItemLeft" align="right" valign="top"><a id="a6da91b6620f8c09df53b2220a373f93c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a6da91b6620f8c09df53b2220a373f93c">ResourceHandle</a> (const <a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;) noexcept=default</td></tr>
<tr class="memdesc:a6da91b6620f8c09df53b2220a373f93c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy constructor. <br /></td></tr>
<tr class="separator:a6da91b6620f8c09df53b2220a373f93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe33f3477ed48f194aeebc59d585265c"><td class="memItemLeft" align="right" valign="top"><a id="abe33f3477ed48f194aeebc59d585265c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#abe33f3477ed48f194aeebc59d585265c">ResourceHandle</a> (<a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:abe33f3477ed48f194aeebc59d585265c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:abe33f3477ed48f194aeebc59d585265c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c916cfcc6dc57c19bd5f436cd1efa8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#ad0c916cfcc6dc57c19bd5f436cd1efa8">operator=</a> (const <a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;) noexcept=default</td></tr>
<tr class="memdesc:ad0c916cfcc6dc57c19bd5f436cd1efa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator. <a href="#ad0c916cfcc6dc57c19bd5f436cd1efa8">More...</a><br /></td></tr>
<tr class="separator:ad0c916cfcc6dc57c19bd5f436cd1efa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5081d90ddb0622320203bdea2b8c9853"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a5081d90ddb0622320203bdea2b8c9853">operator=</a> (<a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:a5081d90ddb0622320203bdea2b8c9853"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <a href="#a5081d90ddb0622320203bdea2b8c9853">More...</a><br /></td></tr>
<tr class="separator:a5081d90ddb0622320203bdea2b8c9853"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a031c890952df1307c771e24166860be8"><td class="memItemLeft" align="right" valign="top">const Resource &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a031c890952df1307c771e24166860be8">get</a> () const noexcept</td></tr>
<tr class="memdesc:a031c890952df1307c771e24166860be8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a reference to the managed resource. <a href="#a031c890952df1307c771e24166860be8">More...</a><br /></td></tr>
<tr class="separator:a031c890952df1307c771e24166860be8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae0864f654b4de3c8428ff7ba36c21e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a0ae0864f654b4de3c8428ff7ba36c21e">operator const Resource &amp;</a> () const noexcept</td></tr>
<tr class="memdesc:a0ae0864f654b4de3c8428ff7ba36c21e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Casts a handle and gets a reference to the managed resource. <a href="#a0ae0864f654b4de3c8428ff7ba36c21e">More...</a><br /></td></tr>
<tr class="separator:a0ae0864f654b4de3c8428ff7ba36c21e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f3e705ca1221f37550bfeccc0dab5c7"><td class="memItemLeft" align="right" valign="top">const Resource &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a7f3e705ca1221f37550bfeccc0dab5c7">operator*</a> () const noexcept</td></tr>
<tr class="memdesc:a7f3e705ca1221f37550bfeccc0dab5c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereferences a handle to obtain the managed resource. <a href="#a7f3e705ca1221f37550bfeccc0dab5c7">More...</a><br /></td></tr>
<tr class="separator:a7f3e705ca1221f37550bfeccc0dab5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf3e08d80a1865eee22143d4c6b612d5"><td class="memItemLeft" align="right" valign="top">const Resource *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#adf3e08d80a1865eee22143d4c6b612d5">operator-&gt;</a> () const noexcept</td></tr>
<tr class="memdesc:adf3e08d80a1865eee22143d4c6b612d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a pointer to the managed resource from a handle . <a href="#adf3e08d80a1865eee22143d4c6b612d5">More...</a><br /></td></tr>
<tr class="separator:adf3e08d80a1865eee22143d4c6b612d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4da18e304419e8d070fbc095236b4403"><td class="memItemLeft" align="right" valign="top"><a id="a4da18e304419e8d070fbc095236b4403"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a4da18e304419e8d070fbc095236b4403">operator bool</a> () const</td></tr>
<tr class="memdesc:a4da18e304419e8d070fbc095236b4403"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the handle contains a resource, false otherwise. <br /></td></tr>
<tr class="separator:a4da18e304419e8d070fbc095236b4403"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a302c9d1bd54cf8e7e958d5e505773b23"><td class="memItemLeft" align="right" valign="top"><a id="a302c9d1bd54cf8e7e958d5e505773b23"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1ResourceHandle.html#a302c9d1bd54cf8e7e958d5e505773b23">ResourceCache&lt; Resource &gt;</a></td></tr>
<tr class="memdesc:a302c9d1bd54cf8e7e958d5e505773b23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resource handles are friends of their caches. <br /></td></tr>
<tr class="separator:a302c9d1bd54cf8e7e958d5e505773b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Resource&gt;<br />
class entt::ResourceHandle&lt; Resource &gt;</h3>
<p>Shared resource handle. </p>
<p>A shared resource handle is a small class that wraps a resource and keeps it alive even if it's deleted from the cache. It can be either copied or moved. A handle shares a reference to the same resource with all the other handles constructed for the same identifier.<br />
As a rule of thumb, resources should never be copied nor moved. Handles are the way to go to keep references to them.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Resource</td><td>Type of resource managed by a handle. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00030">30</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a031c890952df1307c771e24166860be8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a031c890952df1307c771e24166860be8">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Resource&amp; <a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a reference to the managed resource. </p>
<dl class="section warning"><dt>Warning</dt><dd>The behavior is undefined if the handle doesn't contain a resource.<br />
An assertion will abort the execution at runtime in debug mode if the handle is empty.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the managed resource. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00059">59</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a0ae0864f654b4de3c8428ff7ba36c21e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae0864f654b4de3c8428ff7ba36c21e">&#9670;&nbsp;</a></span>operator const Resource &()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::operator const Resource &amp; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Casts a handle and gets a reference to the managed resource. </p>
<dl class="section warning"><dt>Warning</dt><dd>The behavior is undefined if the handle doesn't contain a resource.<br />
An assertion will abort the execution at runtime in debug mode if the handle is empty. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00072">72</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a7f3e705ca1221f37550bfeccc0dab5c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f3e705ca1221f37550bfeccc0dab5c7">&#9670;&nbsp;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Resource&amp; <a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dereferences a handle to obtain the managed resource. </p>
<dl class="section warning"><dt>Warning</dt><dd>The behavior is undefined if the handle doesn't contain a resource.<br />
An assertion will abort the execution at runtime in debug mode if the handle is empty.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the managed resource. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00084">84</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="adf3e08d80a1865eee22143d4c6b612d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf3e08d80a1865eee22143d4c6b612d5">&#9670;&nbsp;</a></span>operator->()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Resource* <a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::operator-&gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a pointer to the managed resource from a handle . </p>
<dl class="section warning"><dt>Warning</dt><dd>The behavior is undefined if the handle doesn't contain a resource.<br />
An assertion will abort the execution at runtime in debug mode if the handle is empty.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the managed resource or <code>nullptr</code> if the handle contains no resource at all. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00097">97</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ad0c916cfcc6dc57c19bd5f436cd1efa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c916cfcc6dc57c19bd5f436cd1efa8">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>&amp; <a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>&lt; Resource &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default copy assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This handle. </dd></dl>
</div>
</div>
<a id="a5081d90ddb0622320203bdea2b8c9853"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5081d90ddb0622320203bdea2b8c9853">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Resource &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>&amp; <a class="el" href="classentt_1_1ResourceHandle.html">entt::ResourceHandle</a>&lt; Resource &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1ResourceHandle.html">ResourceHandle</a>&lt; Resource &gt; &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This handle. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/resource/<a class="el" href="handle_8hpp_source.html">handle.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink