457 lines
24 KiB
HTML
457 lines
24 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.8.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::handle< Resource > 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
|
|
 <span id="projectnumber">3.3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<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');
|
|
/* @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="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1handle.html">handle</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classentt_1_1handle-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::handle< Resource > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Shared resource handle.
|
|
<a href="classentt_1_1handle.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="handle_8hpp_source.html">handle.hpp</a>></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:ac084be205973fb5feedd3c5795955f97"><td class="memItemLeft" align="right" valign="top"><a id="ac084be205973fb5feedd3c5795955f97"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#ac084be205973fb5feedd3c5795955f97">handle</a> () ENTT_NOEXCEPT=default</td></tr>
|
|
<tr class="memdesc:ac084be205973fb5feedd3c5795955f97"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:ac084be205973fb5feedd3c5795955f97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa206e76d351ac2c502996e08f858612"><td class="memItemLeft" align="right" valign="top">const Resource & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#afa206e76d351ac2c502996e08f858612">get</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:afa206e76d351ac2c502996e08f858612"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#afa206e76d351ac2c502996e08f858612">More...</a><br /></td></tr>
|
|
<tr class="separator:afa206e76d351ac2c502996e08f858612"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c67da714dbde0cd2f2a35143ea36f3b"><td class="memItemLeft" align="right" valign="top">Resource & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a7c67da714dbde0cd2f2a35143ea36f3b">get</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a7c67da714dbde0cd2f2a35143ea36f3b"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#a7c67da714dbde0cd2f2a35143ea36f3b">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c67da714dbde0cd2f2a35143ea36f3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a6fe485f3d1af803a941f5dba9e444f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a5a6fe485f3d1af803a941f5dba9e444f">operator const Resource &</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a5a6fe485f3d1af803a941f5dba9e444f"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#a5a6fe485f3d1af803a941f5dba9e444f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a6fe485f3d1af803a941f5dba9e444f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38ed3e151650b67f26339b380db76c2a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a38ed3e151650b67f26339b380db76c2a">operator Resource &</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a38ed3e151650b67f26339b380db76c2a"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#a38ed3e151650b67f26339b380db76c2a">More...</a><br /></td></tr>
|
|
<tr class="separator:a38ed3e151650b67f26339b380db76c2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20a3b1865543ce4ad19262470c72d4e5"><td class="memItemLeft" align="right" valign="top">const Resource & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a20a3b1865543ce4ad19262470c72d4e5">operator*</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a20a3b1865543ce4ad19262470c72d4e5"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#a20a3b1865543ce4ad19262470c72d4e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a20a3b1865543ce4ad19262470c72d4e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b1aa9bace6bdef7e5788f48abaad3da"><td class="memItemLeft" align="right" valign="top">Resource & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a0b1aa9bace6bdef7e5788f48abaad3da">operator*</a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a0b1aa9bace6bdef7e5788f48abaad3da"><td class="mdescLeft"> </td><td class="mdescRight">Gets a reference to the managed resource. <a href="classentt_1_1handle.html#a0b1aa9bace6bdef7e5788f48abaad3da">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b1aa9bace6bdef7e5788f48abaad3da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73df220e891ca8418f5f5fd476997e13"><td class="memItemLeft" align="right" valign="top">const Resource * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a73df220e891ca8418f5f5fd476997e13">operator-></a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a73df220e891ca8418f5f5fd476997e13"><td class="mdescLeft"> </td><td class="mdescRight">Gets a pointer to the managed resource. <a href="classentt_1_1handle.html#a73df220e891ca8418f5f5fd476997e13">More...</a><br /></td></tr>
|
|
<tr class="separator:a73df220e891ca8418f5f5fd476997e13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7f9d864894ae2c8835c9b95d95db841"><td class="memItemLeft" align="right" valign="top">Resource * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#ad7f9d864894ae2c8835c9b95d95db841">operator-></a> () ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:ad7f9d864894ae2c8835c9b95d95db841"><td class="mdescLeft"> </td><td class="mdescRight">Gets a pointer to the managed resource. <a href="classentt_1_1handle.html#ad7f9d864894ae2c8835c9b95d95db841">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7f9d864894ae2c8835c9b95d95db841"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a119640192d7f9202a64aea4f8f5cf9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#a6a119640192d7f9202a64aea4f8f5cf9">operator bool</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a6a119640192d7f9202a64aea4f8f5cf9"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a handle contains a resource, false otherwise. <a href="classentt_1_1handle.html#a6a119640192d7f9202a64aea4f8f5cf9">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a119640192d7f9202a64aea4f8f5cf9"><td class="memSeparator" colspan="2"> </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:adcd47fa89dbe180ef0db46d3f0c43762"><td class="memItemLeft" align="right" valign="top"><a id="adcd47fa89dbe180ef0db46d3f0c43762"></a>
|
|
struct </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1handle.html#adcd47fa89dbe180ef0db46d3f0c43762">cache< Resource ></a></td></tr>
|
|
<tr class="memdesc:adcd47fa89dbe180ef0db46d3f0c43762"><td class="mdescLeft"> </td><td class="mdescRight">Resource handles are friends of their caches. <br /></td></tr>
|
|
<tr class="separator:adcd47fa89dbe180ef0db46d3f0c43762"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename Resource><br />
|
|
class entt::handle< Resource ></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="resource_2fwd_8hpp_source.html#l00014">14</a> of file <a class="el" href="resource_2fwd_8hpp_source.html">fwd.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="afa206e76d351ac2c502996e08f858612"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa206e76d351ac2c502996e08f858612">◆ </a></span>get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const Resource& <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::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> </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#l00049">49</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c67da714dbde0cd2f2a35143ea36f3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c67da714dbde0cd2f2a35143ea36f3b">◆ </a></span>get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Resource& <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::get </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</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#l00055">55</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a119640192d7f9202a64aea4f8f5cf9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a119640192d7f9202a64aea4f8f5cf9">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::operator bool </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">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a handle contains a resource, false otherwise. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the handle contains a resource, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00096">96</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a6fe485f3d1af803a941f5dba9e444f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a6fe485f3d1af803a941f5dba9e444f">◆ </a></span>operator const Resource &()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::operator const Resource & </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> </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#l00060">60</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38ed3e151650b67f26339b380db76c2a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38ed3e151650b67f26339b380db76c2a">◆ </a></span>operator Resource &()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::operator Resource & </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</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#l00063">63</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20a3b1865543ce4ad19262470c72d4e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20a3b1865543ce4ad19262470c72d4e5">◆ </a></span>operator*() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const Resource& <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::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> </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#l00066">66</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b1aa9bace6bdef7e5788f48abaad3da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b1aa9bace6bdef7e5788f48abaad3da">◆ </a></span>operator*() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Resource& <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::operator* </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</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#l00069">69</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73df220e891ca8418f5f5fd476997e13"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73df220e891ca8418f5f5fd476997e13">◆ </a></span>operator->() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const Resource* <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a pointer 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 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#l00082">82</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7f9d864894ae2c8835c9b95d95db841"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7f9d864894ae2c8835c9b95d95db841">◆ </a></span>operator->() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Resource > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Resource* <a class="el" href="classentt_1_1handle.html">entt::handle</a>< Resource >::operator-> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a pointer 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 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#l00088">88</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/resource/<a class="el" href="resource_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|