326 lines
18 KiB
HTML
326 lines
18 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::meta_handle Struct 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.8.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="structentt_1_1meta__handle.html">meta_handle</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structentt_1_1meta__handle-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::meta_handle Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Opaque pointers to instances of any type.
|
|
<a href="structentt_1_1meta__handle.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="meta_8hpp_source.html">meta.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:a8d02bbf3a8088aa698db4491374dbf4c"><td class="memItemLeft" align="right" valign="top"><a id="a8d02bbf3a8088aa698db4491374dbf4c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#a8d02bbf3a8088aa698db4491374dbf4c">meta_handle</a> ()=default</td></tr>
|
|
<tr class="memdesc:a8d02bbf3a8088aa698db4491374dbf4c"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a8d02bbf3a8088aa698db4491374dbf4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaaa33d743703cf1af62691de0b86f50"><td class="memItemLeft" align="right" valign="top"><a id="acaaa33d743703cf1af62691de0b86f50"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#acaaa33d743703cf1af62691de0b86f50">meta_handle</a> (const <a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> &)=delete</td></tr>
|
|
<tr class="memdesc:acaaa33d743703cf1af62691de0b86f50"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:acaaa33d743703cf1af62691de0b86f50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa988b1809a9687be4d25f21722075da5"><td class="memItemLeft" align="right" valign="top"><a id="aa988b1809a9687be4d25f21722075da5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#aa988b1809a9687be4d25f21722075da5">meta_handle</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> &&)=default</td></tr>
|
|
<tr class="memdesc:aa988b1809a9687be4d25f21722075da5"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
|
|
<tr class="separator:aa988b1809a9687be4d25f21722075da5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a750eb55693845b28da117db4d342b8e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#a750eb55693845b28da117db4d342b8e6">operator=</a> (const <a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a750eb55693845b28da117db4d342b8e6"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <a href="structentt_1_1meta__handle.html#a750eb55693845b28da117db4d342b8e6">More...</a><br /></td></tr>
|
|
<tr class="separator:a750eb55693845b28da117db4d342b8e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacfd03669af75ce2684917e8e9f90132"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#aacfd03669af75ce2684917e8e9f90132">operator=</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> &&)=default</td></tr>
|
|
<tr class="memdesc:aacfd03669af75ce2684917e8e9f90132"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <a href="structentt_1_1meta__handle.html#aacfd03669af75ce2684917e8e9f90132">More...</a><br /></td></tr>
|
|
<tr class="separator:aacfd03669af75ce2684917e8e9f90132"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed6a735b7dd561d9231334e54fe6fe55"><td class="memTemplParams" colspan="2">template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>> </td></tr>
|
|
<tr class="memitem:aed6a735b7dd561d9231334e54fe6fe55"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#aed6a735b7dd561d9231334e54fe6fe55">meta_handle</a> (Type &value)</td></tr>
|
|
<tr class="memdesc:aed6a735b7dd561d9231334e54fe6fe55"><td class="mdescLeft"> </td><td class="mdescRight">Creates a handle that points to an unmanaged object. <a href="structentt_1_1meta__handle.html#aed6a735b7dd561d9231334e54fe6fe55">More...</a><br /></td></tr>
|
|
<tr class="separator:aed6a735b7dd561d9231334e54fe6fe55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6936d403200fd97fd34d366d9c980c6c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#a6936d403200fd97fd34d366d9c980c6c">operator bool</a> () const</td></tr>
|
|
<tr class="memdesc:a6936d403200fd97fd34d366d9c980c6c"><td class="mdescLeft"> </td><td class="mdescRight">Returns false if a handle is invalid, true otherwise. <a href="structentt_1_1meta__handle.html#a6936d403200fd97fd34d366d9c980c6c">More...</a><br /></td></tr>
|
|
<tr class="separator:a6936d403200fd97fd34d366d9c980c6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1309701800c7727eb519ee14b655e30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__any.html">meta_any</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#ad1309701800c7727eb519ee14b655e30">operator-></a> ()</td></tr>
|
|
<tr class="memdesc:ad1309701800c7727eb519ee14b655e30"><td class="mdescLeft"> </td><td class="mdescRight">Access operator for accessing the contained opaque object. <a href="structentt_1_1meta__handle.html#ad1309701800c7727eb519ee14b655e30">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1309701800c7727eb519ee14b655e30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaeac6808357732eeb2ce615c7ccb0eb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1meta__any.html">meta_any</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__handle.html#aeaeac6808357732eeb2ce615c7ccb0eb">operator-></a> () const</td></tr>
|
|
<tr class="memdesc:aeaeac6808357732eeb2ce615c7ccb0eb"><td class="mdescLeft"> </td><td class="mdescRight">Access operator for accessing the contained opaque object. <a href="structentt_1_1meta__handle.html#aeaeac6808357732eeb2ce615c7ccb0eb">More...</a><br /></td></tr>
|
|
<tr class="separator:aeaeac6808357732eeb2ce615c7ccb0eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Opaque pointers to instances of any type. </p>
|
|
<p>A handle doesn't perform copies and isn't responsible for the contained object. It doesn't prolong the lifetime of the pointed instance.<br />
|
|
Handles are used to generate references to actual objects when needed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00625">625</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aed6a735b7dd561d9231334e54fe6fe55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed6a735b7dd561d9231334e54fe6fe55">◆ </a></span>meta_handle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , typename = std::enable_if_t<!std::is_same_v<std::decay_t<Type>, meta_handle>>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">entt::meta_handle::meta_handle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type & </td>
|
|
<td class="paramname"><em>value</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>Creates a handle that points to an unmanaged object. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of object to use to initialize the handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>An instance of an object to use to initialize the handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00654">654</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6936d403200fd97fd34d366d9c980c6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6936d403200fd97fd34d366d9c980c6c">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">entt::meta_handle::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 false if a handle is invalid, true otherwise. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>False if the handle is invalid, true otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00668">668</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1309701800c7727eb519ee14b655e30"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1309701800c7727eb519ee14b655e30">◆ </a></span>operator->() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>* entt::meta_handle::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>Access operator for accessing the contained opaque object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A wrapper that shares a reference to an unmanaged object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00676">676</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeaeac6808357732eeb2ce615c7ccb0eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeaeac6808357732eeb2ce615c7ccb0eb">◆ </a></span>operator->() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classentt_1_1meta__any.html">meta_any</a>* entt::meta_handle::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>Access operator for accessing the contained opaque object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A wrapper that shares a reference to an unmanaged object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00681">681</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a750eb55693845b28da117db4d342b8e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a750eb55693845b28da117db4d342b8e6">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>& entt::meta_handle::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator, deleted on purpose. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This meta handle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacfd03669af75ce2684917e8e9f90132"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacfd03669af75ce2684917e8e9f90132">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>& entt::meta_handle::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> && </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 meta handle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/entt/meta/<a class="el" href="meta_8hpp_source.html">meta.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>
|