683 lines
36 KiB
HTML
683 lines
36 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: entt::resource< Type > 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.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="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1resource.html">resource</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_1resource-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::resource< Type > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic resource handle.
|
|
<a href="classentt_1_1resource.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="resource_8hpp_source.html">resource.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:a5d2a41b70dfa8111f9c6dbab77f736ad"><td class="memItemLeft" align="right" valign="top"><a id="a5d2a41b70dfa8111f9c6dbab77f736ad"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a5d2a41b70dfa8111f9c6dbab77f736ad">resource</a> ()</td></tr>
|
|
<tr class="memdesc:a5d2a41b70dfa8111f9c6dbab77f736ad"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a5d2a41b70dfa8111f9c6dbab77f736ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f76bc2b33dc5808f851085b3bf22901"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a6f76bc2b33dc5808f851085b3bf22901">resource</a> (std::shared_ptr< Type > res)</td></tr>
|
|
<tr class="memdesc:a6f76bc2b33dc5808f851085b3bf22901"><td class="mdescLeft"> </td><td class="mdescRight">Creates a handle from a weak pointer, namely a resource. <a href="classentt_1_1resource.html#a6f76bc2b33dc5808f851085b3bf22901">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f76bc2b33dc5808f851085b3bf22901"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86aaf1b31fc18461c3f47a5424eb3fbf"><td class="memItemLeft" align="right" valign="top"><a id="a86aaf1b31fc18461c3f47a5424eb3fbf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a86aaf1b31fc18461c3f47a5424eb3fbf">resource</a> (const <a class="el" href="classentt_1_1resource.html">resource</a> &)=default</td></tr>
|
|
<tr class="memdesc:a86aaf1b31fc18461c3f47a5424eb3fbf"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <br /></td></tr>
|
|
<tr class="separator:a86aaf1b31fc18461c3f47a5424eb3fbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6c2c9559587898d2d46bff7614032b2"><td class="memItemLeft" align="right" valign="top"><a id="aa6c2c9559587898d2d46bff7614032b2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#aa6c2c9559587898d2d46bff7614032b2">resource</a> (<a class="el" href="classentt_1_1resource.html">resource</a> &&)=default</td></tr>
|
|
<tr class="memdesc:aa6c2c9559587898d2d46bff7614032b2"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
|
|
<tr class="separator:aa6c2c9559587898d2d46bff7614032b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74651bbd6ec5b5bbd94efde2d5aa4764"><td class="memTemplParams" colspan="2">template<typename Other > </td></tr>
|
|
<tr class="memitem:a74651bbd6ec5b5bbd94efde2d5aa4764"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a74651bbd6ec5b5bbd94efde2d5aa4764">resource</a> (const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > &other, Type &res)</td></tr>
|
|
<tr class="memdesc:a74651bbd6ec5b5bbd94efde2d5aa4764"><td class="mdescLeft"> </td><td class="mdescRight">Aliasing constructor. <a href="classentt_1_1resource.html#a74651bbd6ec5b5bbd94efde2d5aa4764">More...</a><br /></td></tr>
|
|
<tr class="separator:a74651bbd6ec5b5bbd94efde2d5aa4764"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9507660bf6e8547f8c0e1be0ca05684f"><td class="memTemplParams" colspan="2">template<typename Other , typename = std::enable_if_t<is_acceptable_v<Other>>> </td></tr>
|
|
<tr class="memitem:a9507660bf6e8547f8c0e1be0ca05684f"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a9507660bf6e8547f8c0e1be0ca05684f">resource</a> (const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > &other)</td></tr>
|
|
<tr class="memdesc:a9507660bf6e8547f8c0e1be0ca05684f"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructs a handle which shares ownership of the resource. <a href="classentt_1_1resource.html#a9507660bf6e8547f8c0e1be0ca05684f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9507660bf6e8547f8c0e1be0ca05684f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75c84414a2241405fe138b706820b171"><td class="memTemplParams" colspan="2">template<typename Other , typename = std::enable_if_t<is_acceptable_v<Other>>> </td></tr>
|
|
<tr class="memitem:a75c84414a2241405fe138b706820b171"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a75c84414a2241405fe138b706820b171">resource</a> (<a class="el" href="classentt_1_1resource.html">resource</a>< Other > &&other)</td></tr>
|
|
<tr class="memdesc:a75c84414a2241405fe138b706820b171"><td class="mdescLeft"> </td><td class="mdescRight">Move constructs a handle which takes ownership of the resource. <a href="classentt_1_1resource.html#a75c84414a2241405fe138b706820b171">More...</a><br /></td></tr>
|
|
<tr class="separator:a75c84414a2241405fe138b706820b171"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2ffb65e0b5b160305c0ad7b73797c28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1resource.html">resource</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#af2ffb65e0b5b160305c0ad7b73797c28">operator=</a> (const <a class="el" href="classentt_1_1resource.html">resource</a> &)=default</td></tr>
|
|
<tr class="memdesc:af2ffb65e0b5b160305c0ad7b73797c28"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <a href="classentt_1_1resource.html#af2ffb65e0b5b160305c0ad7b73797c28">More...</a><br /></td></tr>
|
|
<tr class="separator:af2ffb65e0b5b160305c0ad7b73797c28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85556f1c70980a5882dd3199438e0179"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1resource.html">resource</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a85556f1c70980a5882dd3199438e0179">operator=</a> (<a class="el" href="classentt_1_1resource.html">resource</a> &&)=default</td></tr>
|
|
<tr class="memdesc:a85556f1c70980a5882dd3199438e0179"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <a href="classentt_1_1resource.html#a85556f1c70980a5882dd3199438e0179">More...</a><br /></td></tr>
|
|
<tr class="separator:a85556f1c70980a5882dd3199438e0179"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f48057e3737c8dd9b6baec5e58996ba"><td class="memTemplParams" colspan="2">template<typename Other > </td></tr>
|
|
<tr class="memitem:a6f48057e3737c8dd9b6baec5e58996ba"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t< is_acceptable_v< Other >, <a class="el" href="classentt_1_1resource.html">resource</a> & > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a6f48057e3737c8dd9b6baec5e58996ba">operator=</a> (const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > &other)</td></tr>
|
|
<tr class="memdesc:a6f48057e3737c8dd9b6baec5e58996ba"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator from foreign handle. <a href="classentt_1_1resource.html#a6f48057e3737c8dd9b6baec5e58996ba">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f48057e3737c8dd9b6baec5e58996ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06d72fcef4d307cb9c601e56886fe4ff"><td class="memTemplParams" colspan="2">template<typename Other > </td></tr>
|
|
<tr class="memitem:a06d72fcef4d307cb9c601e56886fe4ff"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t< is_acceptable_v< Other >, <a class="el" href="classentt_1_1resource.html">resource</a> & > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a06d72fcef4d307cb9c601e56886fe4ff">operator=</a> (<a class="el" href="classentt_1_1resource.html">resource</a>< Other > &&other)</td></tr>
|
|
<tr class="memdesc:a06d72fcef4d307cb9c601e56886fe4ff"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator from foreign handle. <a href="classentt_1_1resource.html#a06d72fcef4d307cb9c601e56886fe4ff">More...</a><br /></td></tr>
|
|
<tr class="separator:a06d72fcef4d307cb9c601e56886fe4ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5da08fd8beef8e5af8a0aac7ebefc491"><td class="memItemLeft" align="right" valign="top">Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a5da08fd8beef8e5af8a0aac7ebefc491">operator*</a> () const</td></tr>
|
|
<tr class="memdesc:a5da08fd8beef8e5af8a0aac7ebefc491"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the managed resource. <a href="classentt_1_1resource.html#a5da08fd8beef8e5af8a0aac7ebefc491">More...</a><br /></td></tr>
|
|
<tr class="separator:a5da08fd8beef8e5af8a0aac7ebefc491"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cc7200575e1047b645932f51b79af32"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a0cc7200575e1047b645932f51b79af32">operator Type &</a> () const</td></tr>
|
|
<tr class="memdesc:a0cc7200575e1047b645932f51b79af32"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the managed resource. <a href="classentt_1_1resource.html#a0cc7200575e1047b645932f51b79af32">More...</a><br /></td></tr>
|
|
<tr class="separator:a0cc7200575e1047b645932f51b79af32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a740a657eabb34596ee84e248025dc57c"><td class="memItemLeft" align="right" valign="top">Type * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a740a657eabb34596ee84e248025dc57c">operator-></a> () const</td></tr>
|
|
<tr class="memdesc:a740a657eabb34596ee84e248025dc57c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the managed resource. <a href="classentt_1_1resource.html#a740a657eabb34596ee84e248025dc57c">More...</a><br /></td></tr>
|
|
<tr class="separator:a740a657eabb34596ee84e248025dc57c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4724946781a3d5e062d5c6c5a210ee28"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a4724946781a3d5e062d5c6c5a210ee28">operator bool</a> () const</td></tr>
|
|
<tr class="memdesc:a4724946781a3d5e062d5c6c5a210ee28"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a handle contains a resource, false otherwise. <a href="classentt_1_1resource.html#a4724946781a3d5e062d5c6c5a210ee28">More...</a><br /></td></tr>
|
|
<tr class="separator:a4724946781a3d5e062d5c6c5a210ee28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bdea2c6634e42d5d0120cd5ae0ddfeb"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a1bdea2c6634e42d5d0120cd5ae0ddfeb">use_count</a> () const</td></tr>
|
|
<tr class="memdesc:a1bdea2c6634e42d5d0120cd5ae0ddfeb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of handles pointing the same resource. <a href="classentt_1_1resource.html#a1bdea2c6634e42d5d0120cd5ae0ddfeb">More...</a><br /></td></tr>
|
|
<tr class="separator:a1bdea2c6634e42d5d0120cd5ae0ddfeb"><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:a10dac526a08b422e1767d8fa1cfd8dd3"><td class="memTemplParams" colspan="2"><a id="a10dac526a08b422e1767d8fa1cfd8dd3"></a>
|
|
template<typename > </td></tr>
|
|
<tr class="memitem:a10dac526a08b422e1767d8fa1cfd8dd3"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1resource.html#a10dac526a08b422e1767d8fa1cfd8dd3">resource</a></td></tr>
|
|
<tr class="memdesc:a10dac526a08b422e1767d8fa1cfd8dd3"><td class="mdescLeft"> </td><td class="mdescRight">Resource handles are friends with each other. <br /></td></tr>
|
|
<tr class="separator:a10dac526a08b422e1767d8fa1cfd8dd3"><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 Type><br />
|
|
class entt::resource< Type ></h3>
|
|
|
|
<p>Basic resource handle. </p>
|
|
<p>A handle wraps a resource and extends its lifetime. It also shares the same resource with all other handles constructed from the same element.<br />
|
|
As a rule of thumb, resources should never be copied nor moved. Handles are the way to go to push references around.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</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_8hpp_source.html#l00023">23</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6f76bc2b33dc5808f851085b3bf22901"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f76bc2b33dc5808f851085b3bf22901">◆ </a></span>resource() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::<a class="el" href="classentt_1_1resource.html">resource</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::shared_ptr< Type > </td>
|
|
<td class="paramname"><em>res</em></td><td>)</td>
|
|
<td></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>Creates a handle from a weak pointer, namely a resource. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">res</td><td>A weak pointer to a resource. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00040">40</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74651bbd6ec5b5bbd94efde2d5aa4764"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74651bbd6ec5b5bbd94efde2d5aa4764">◆ </a></span>resource() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<div class="memtemplate">
|
|
template<typename Other > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::<a class="el" href="classentt_1_1resource.html">resource</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > & </td>
|
|
<td class="paramname"><em>other</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Type & </td>
|
|
<td class="paramname"><em>res</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Aliasing constructor. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Other</td><td>Type of resource managed by the received handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The handle with which to share ownership information. </td></tr>
|
|
<tr><td class="paramname">res</td><td>Unrelated and unmanaged resources. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00056">56</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9507660bf6e8547f8c0e1be0ca05684f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9507660bf6e8547f8c0e1be0ca05684f">◆ </a></span>resource() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<div class="memtemplate">
|
|
template<typename Other , typename = std::enable_if_t<is_acceptable_v<Other>>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::<a class="el" href="classentt_1_1resource.html">resource</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > & </td>
|
|
<td class="paramname"><em>other</em></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>Copy constructs a handle which shares ownership of the resource. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Other</td><td>Type of resource managed by the received handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The handle to copy from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00065">65</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a75c84414a2241405fe138b706820b171"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75c84414a2241405fe138b706820b171">◆ </a></span>resource() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<div class="memtemplate">
|
|
template<typename Other , typename = std::enable_if_t<is_acceptable_v<Other>>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::<a class="el" href="classentt_1_1resource.html">resource</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1resource.html">resource</a>< Other > && </td>
|
|
<td class="paramname"><em>other</em></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>Move constructs a handle which takes ownership of the resource. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Other</td><td>Type of resource managed by the received handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The handle to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00074">74</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4724946781a3d5e062d5c6c5a210ee28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4724946781a3d5e062d5c6c5a210ee28">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::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="resource_8hpp_source.html#l00144">144</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0cc7200575e1047b645932f51b79af32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0cc7200575e1047b645932f51b79af32">◆ </a></span>operator Type &()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::operator Type & </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>Returns 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.</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="resource_8hpp_source.html#l00128">128</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5da08fd8beef8e5af8a0aac7ebefc491"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5da08fd8beef8e5af8a0aac7ebefc491">◆ </a></span>operator*()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Type& <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::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>Returns 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.</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="resource_8hpp_source.html#l00123">123</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a740a657eabb34596ee84e248025dc57c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a740a657eabb34596ee84e248025dc57c">◆ </a></span>operator->()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Type* <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::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>Returns a pointer to the managed resource. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the managed resource. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00136">136</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af2ffb65e0b5b160305c0ad7b73797c28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af2ffb65e0b5b160305c0ad7b73797c28">◆ </a></span>operator=() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">resource</a>& <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1resource.html">resource</a>< Type > & </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This resource handle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f48057e3737c8dd9b6baec5e58996ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f48057e3737c8dd9b6baec5e58996ba">◆ </a></span>operator=() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<div class="memtemplate">
|
|
template<typename Other > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::enable_if_t<is_acceptable_v<Other>, <a class="el" href="classentt_1_1resource.html">resource</a> &> <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1resource.html">resource</a>< Other > & </td>
|
|
<td class="paramname"><em>other</em></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>Copy assignment operator from foreign handle. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Other</td><td>Type of resource managed by the received handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The handle to copy from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This resource handle. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00097">97</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85556f1c70980a5882dd3199438e0179"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85556f1c70980a5882dd3199438e0179">◆ </a></span>operator=() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1resource.html">resource</a>& <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1resource.html">resource</a>< Type > && </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default move assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This resource handle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06d72fcef4d307cb9c601e56886fe4ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06d72fcef4d307cb9c601e56886fe4ff">◆ </a></span>operator=() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<div class="memtemplate">
|
|
template<typename Other > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::enable_if_t<is_acceptable_v<Other>, <a class="el" href="classentt_1_1resource.html">resource</a> &> <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1resource.html">resource</a>< Other > && </td>
|
|
<td class="paramname"><em>other</em></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>Move assignment operator from foreign handle. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Other</td><td>Type of resource managed by the received handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The handle to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This resource handle. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00110">110</a> of file <a class="el" href="resource_8hpp_source.html">resource.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1bdea2c6634e42d5d0120cd5ae0ddfeb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1bdea2c6634e42d5d0120cd5ae0ddfeb">◆ </a></span>use_count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long <a class="el" href="classentt_1_1resource.html">entt::resource</a>< Type >::use_count </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>Returns the number of handles pointing the same resource. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of handles pointing the same resource. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="resource_8hpp_source.html#l00152">152</a> of file <a class="el" href="resource_8hpp_source.html">resource.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="resource_8hpp_source.html">resource.hpp</a></li>
|
|
</ul>
|
|
</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>
|