Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c49227d82878de2cd4ae3decf93cfe4d097e994e
entt/structentt_1_1meta__func.html
Michele Caini c49227d828 API reference v3.5.2
2020-09-22 08:42:41 +02:00

617 lines
33 KiB
HTML
Raw Blame History

<!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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::meta_func 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
&#160;<span id="projectnumber">3.5.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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__func.html">meta_func</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1meta__func-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::meta_func Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Opaque wrapper for meta functions.
<a href="structentt_1_1meta__func.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="meta_8hpp_source.html">meta.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac3c77ffeae29f5d511a5961cc25617c0"><td class="memItemLeft" align="right" valign="top"><a id="ac3c77ffeae29f5d511a5961cc25617c0"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#ac3c77ffeae29f5d511a5961cc25617c0">node_type</a> = internal::meta_func_node</td></tr>
<tr class="memdesc:ac3c77ffeae29f5d511a5961cc25617c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node type. <br /></td></tr>
<tr class="separator:ac3c77ffeae29f5d511a5961cc25617c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa35b75b107a0e02f7f03f0737980a428"><td class="memItemLeft" align="right" valign="top"><a id="aa35b75b107a0e02f7f03f0737980a428"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#aa35b75b107a0e02f7f03f0737980a428">size_type</a> = typename node_type::size_type</td></tr>
<tr class="memdesc:aa35b75b107a0e02f7f03f0737980a428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:aa35b75b107a0e02f7f03f0737980a428"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a88ae465ddfb4affc6d22d9d1ec0257b2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a88ae465ddfb4affc6d22d9d1ec0257b2">meta_func</a> (const <a class="el" href="structentt_1_1meta__func.html#ac3c77ffeae29f5d511a5961cc25617c0">node_type</a> *curr=nullptr) noexcept</td></tr>
<tr class="memdesc:a88ae465ddfb4affc6d22d9d1ec0257b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="structentt_1_1meta__func.html#a88ae465ddfb4affc6d22d9d1ec0257b2">More...</a><br /></td></tr>
<tr class="separator:a88ae465ddfb4affc6d22d9d1ec0257b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c8d787fae46bf795d69f9b07afa0dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#af6c8d787fae46bf795d69f9b07afa0dd">id</a> () const noexcept</td></tr>
<tr class="memdesc:af6c8d787fae46bf795d69f9b07afa0dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the identifier assigned to a meta object. <a href="structentt_1_1meta__func.html#af6c8d787fae46bf795d69f9b07afa0dd">More...</a><br /></td></tr>
<tr class="separator:af6c8d787fae46bf795d69f9b07afa0dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9405d73978b0a1fc7cc0f3f016b0d6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#ae9405d73978b0a1fc7cc0f3f016b0d6a">parent</a> () const noexcept</td></tr>
<tr class="memdesc:ae9405d73978b0a1fc7cc0f3f016b0d6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type to which a meta object belongs. <a href="structentt_1_1meta__func.html#ae9405d73978b0a1fc7cc0f3f016b0d6a">More...</a><br /></td></tr>
<tr class="separator:ae9405d73978b0a1fc7cc0f3f016b0d6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42dc01e2d2fbb666e60b9d80eddb9cad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__func.html#aa35b75b107a0e02f7f03f0737980a428">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a42dc01e2d2fbb666e60b9d80eddb9cad">size</a> () const noexcept</td></tr>
<tr class="memdesc:a42dc01e2d2fbb666e60b9d80eddb9cad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments accepted by a meta function. <a href="structentt_1_1meta__func.html#a42dc01e2d2fbb666e60b9d80eddb9cad">More...</a><br /></td></tr>
<tr class="separator:a42dc01e2d2fbb666e60b9d80eddb9cad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a935c3b78d74afbc953bdcfabe12d4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a8a935c3b78d74afbc953bdcfabe12d4b">is_const</a> () const noexcept</td></tr>
<tr class="memdesc:a8a935c3b78d74afbc953bdcfabe12d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a meta function is constant or not. <a href="structentt_1_1meta__func.html#a8a935c3b78d74afbc953bdcfabe12d4b">More...</a><br /></td></tr>
<tr class="separator:a8a935c3b78d74afbc953bdcfabe12d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a143a54f1f653717762ac43622eab5a99"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a143a54f1f653717762ac43622eab5a99">is_static</a> () const noexcept</td></tr>
<tr class="memdesc:a143a54f1f653717762ac43622eab5a99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a meta function is static or not. <a href="structentt_1_1meta__func.html#a143a54f1f653717762ac43622eab5a99">More...</a><br /></td></tr>
<tr class="separator:a143a54f1f653717762ac43622eab5a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63fd4cf3b926de060c847f7b60c2c28a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a63fd4cf3b926de060c847f7b60c2c28a">ret</a> () const noexcept</td></tr>
<tr class="memdesc:a63fd4cf3b926de060c847f7b60c2c28a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the return type of a meta function. <a href="structentt_1_1meta__func.html#a63fd4cf3b926de060c847f7b60c2c28a">More...</a><br /></td></tr>
<tr class="separator:a63fd4cf3b926de060c847f7b60c2c28a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1194298057174d7eaa0c5501b053453"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#ad1194298057174d7eaa0c5501b053453">arg</a> (<a class="el" href="structentt_1_1meta__func.html#aa35b75b107a0e02f7f03f0737980a428">size_type</a> index) const noexcept</td></tr>
<tr class="memdesc:ad1194298057174d7eaa0c5501b053453"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the i-th argument of a meta function. <a href="structentt_1_1meta__func.html#ad1194298057174d7eaa0c5501b053453">More...</a><br /></td></tr>
<tr class="separator:ad1194298057174d7eaa0c5501b053453"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc18f36134fb6131288f8546adb89f2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#afc18f36134fb6131288f8546adb89f2f">invoke</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> instance, <a class="el" href="classentt_1_1meta__any.html">meta_any</a> *const args, const std::size_t sz) const</td></tr>
<tr class="memdesc:afc18f36134fb6131288f8546adb89f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the underlying function, if possible. <a href="structentt_1_1meta__func.html#afc18f36134fb6131288f8546adb89f2f">More...</a><br /></td></tr>
<tr class="separator:afc18f36134fb6131288f8546adb89f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7848863edc986a2196d376111ec4293"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:ae7848863edc986a2196d376111ec4293"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#ae7848863edc986a2196d376111ec4293">invoke</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> instance, Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:ae7848863edc986a2196d376111ec4293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the underlying function, if possible. <a href="structentt_1_1meta__func.html#ae7848863edc986a2196d376111ec4293">More...</a><br /></td></tr>
<tr class="separator:ae7848863edc986a2196d376111ec4293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fb501bb6449b544edff31ca2e33ff49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__range.html">meta_range</a>&lt; <a class="el" href="structentt_1_1meta__prop.html">meta_prop</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a0fb501bb6449b544edff31ca2e33ff49">prop</a> () const noexcept</td></tr>
<tr class="memdesc:a0fb501bb6449b544edff31ca2e33ff49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a range to use to visit all meta properties. <a href="structentt_1_1meta__func.html#a0fb501bb6449b544edff31ca2e33ff49">More...</a><br /></td></tr>
<tr class="separator:a0fb501bb6449b544edff31ca2e33ff49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78c007b0f307c817ae519004b14d3ea0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__prop.html">meta_prop</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a78c007b0f307c817ae519004b14d3ea0">prop</a> (<a class="el" href="classentt_1_1meta__any.html">meta_any</a> key) const</td></tr>
<tr class="memdesc:a78c007b0f307c817ae519004b14d3ea0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the property associated with a given key. <a href="structentt_1_1meta__func.html#a78c007b0f307c817ae519004b14d3ea0">More...</a><br /></td></tr>
<tr class="separator:a78c007b0f307c817ae519004b14d3ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9727c67eadcaea8a0dc66b7d4b7637e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a9727c67eadcaea8a0dc66b7d4b7637e0">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a9727c67eadcaea8a0dc66b7d4b7637e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="structentt_1_1meta__func.html#a9727c67eadcaea8a0dc66b7d4b7637e0">More...</a><br /></td></tr>
<tr class="separator:a9727c67eadcaea8a0dc66b7d4b7637e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Opaque wrapper for meta functions. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00886">886</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a88ae465ddfb4affc6d22d9d1ec0257b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ae465ddfb4affc6d22d9d1ec0257b2">&#9670;&nbsp;</a></span>meta_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::meta_func::meta_func </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__func.html#ac3c77ffeae29f5d511a5961cc25617c0">node_type</a> *&#160;</td>
<td class="paramname"><em>curr</em> = <code>nullptr</code></td><td>)</td>
<td></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>Constructs an instance from a given node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">curr</td><td>The underlying node with which to construct the instance. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00893">893</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="ad1194298057174d7eaa0c5501b053453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1194298057174d7eaa0c5501b053453">&#9670;&nbsp;</a></span>arg()</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__type.html">meta_type</a> entt::meta_func::arg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__func.html#aa35b75b107a0e02f7f03f0737980a428">size_type</a>&#160;</td>
<td class="paramname"><em>index</em></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>Returns the meta type of the i-th argument of a meta function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index of the argument of which to return the meta type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The meta type of the i-th argument of a meta function, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01591">1591</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="af6c8d787fae46bf795d69f9b07afa0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6c8d787fae46bf795d69f9b07afa0dd">&#9670;&nbsp;</a></span>id()</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="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> entt::meta_func::id </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>Returns the identifier assigned to a meta object. </p>
<dl class="section return"><dt>Returns</dt><dd>The identifier assigned to the meta object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00898">898</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ae7848863edc986a2196d376111ec4293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7848863edc986a2196d376111ec4293">&#9670;&nbsp;</a></span>invoke() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<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_func::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Invokes the underlying function, if possible. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structentt_1_1meta__func.html#afc18f36134fb6131288f8546adb89f2f" title="Invokes the underlying function, if possible.">invoke</a></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>Types of arguments to use to invoke the function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>An opaque instance of the underlying type. </td></tr>
<tr><td class="paramname">args</td><td>Parameters to use to invoke the function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A meta any containing the new instance, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00972">972</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="afc18f36134fb6131288f8546adb89f2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc18f36134fb6131288f8546adb89f2f">&#9670;&nbsp;</a></span>invoke() <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="classentt_1_1meta__any.html">meta_any</a> entt::meta_func::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classentt_1_1meta__any.html">meta_any</a> *const&#160;</td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::size_t&#160;</td>
<td class="paramname"><em>sz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Invokes the underlying function, if possible. </p>
<p>To invoke a meta function, the parameters must be such that a cast or conversion to the required types is possible. Otherwise, an empty and thus invalid wrapper is returned.<br />
It must be possible to cast the instance to the parent type of the meta function. Otherwise, invoking the underlying function results in an undefined behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>An opaque instance of the underlying type. </td></tr>
<tr><td class="paramname">args</td><td>Parameters to use to invoke the function. </td></tr>
<tr><td class="paramname">sz</td><td>Number of parameters to use to invoke the function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A meta any containing the returned value, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00957">957</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a8a935c3b78d74afbc953bdcfabe12d4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a935c3b78d74afbc953bdcfabe12d4b">&#9670;&nbsp;</a></span>is_const()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::meta_func::is_const </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>Indicates whether a meta function is constant or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta function is constant, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00917">917</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a143a54f1f653717762ac43622eab5a99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a143a54f1f653717762ac43622eab5a99">&#9670;&nbsp;</a></span>is_static()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::meta_func::is_static </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>Indicates whether a meta function is static or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta function is static, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00925">925</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a9727c67eadcaea8a0dc66b7d4b7637e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9727c67eadcaea8a0dc66b7d4b7637e0">&#9670;&nbsp;</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_func::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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a meta object is valid, false otherwise. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta object is valid, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00996">996</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ae9405d73978b0a1fc7cc0f3f016b0d6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9405d73978b0a1fc7cc0f3f016b0d6a">&#9670;&nbsp;</a></span>parent()</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__type.html">meta_type</a> entt::meta_func::parent </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>Returns the meta type to which a meta object belongs. </p>
<dl class="section return"><dt>Returns</dt><dd>The meta type to which the meta object belongs. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01581">1581</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a0fb501bb6449b544edff31ca2e33ff49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fb501bb6449b544edff31ca2e33ff49">&#9670;&nbsp;</a></span>prop() <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__range.html">meta_range</a>&lt;<a class="el" href="structentt_1_1meta__prop.html">meta_prop</a>&gt; entt::meta_func::prop </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>Returns a range to use to visit all meta properties. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterable range to use to visit all meta properties. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00978">978</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a78c007b0f307c817ae519004b14d3ea0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78c007b0f307c817ae519004b14d3ea0">&#9670;&nbsp;</a></span>prop() <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__prop.html">meta_prop</a> entt::meta_func::prop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>&#160;</td>
<td class="paramname"><em>key</em></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 property associated with a given key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to use to search for a property. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The property associated with the given key, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00987">987</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a63fd4cf3b926de060c847f7b60c2c28a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63fd4cf3b926de060c847f7b60c2c28a">&#9670;&nbsp;</a></span>ret()</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__type.html">meta_type</a> entt::meta_func::ret </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>Returns the meta type of the return type of a meta function. </p>
<dl class="section return"><dt>Returns</dt><dd>The meta type of the return type of the meta function. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01586">1586</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a42dc01e2d2fbb666e60b9d80eddb9cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42dc01e2d2fbb666e60b9d80eddb9cad">&#9670;&nbsp;</a></span>size()</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__func.html#aa35b75b107a0e02f7f03f0737980a428">size_type</a> entt::meta_func::size </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>Returns the number of arguments accepted by a meta function. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of arguments accepted by the meta function. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00909">909</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</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&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink