Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
401b1db1a0aaadc645ec01cb8e0df2257d6cdbc9
entt/structentt_1_1meta__func.html
Michele Caini 401b1db1a0 API reference v3.2.0
2019-10-30 00:07:19 +01:00

609 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::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.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="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 container 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:a422ec572c7c56d3cb46d09704be64f65"><td class="memItemLeft" align="right" valign="top"><a id="a422ec572c7c56d3cb46d09704be64f65"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a422ec572c7c56d3cb46d09704be64f65">size_type</a> = typename internal::meta_func_node::size_type</td></tr>
<tr class="memdesc:a422ec572c7c56d3cb46d09704be64f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a422ec572c7c56d3cb46d09704be64f65"><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:a08cf20d2ec99cca580d1121aeed7064c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a08cf20d2ec99cca580d1121aeed7064c">meta_func</a> (const internal::meta_func_node *curr=nullptr) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a08cf20d2ec99cca580d1121aeed7064c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="#a08cf20d2ec99cca580d1121aeed7064c">More...</a><br /></td></tr>
<tr class="separator:a08cf20d2ec99cca580d1121aeed7064c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aaf8cb2a1ad0be02d0b7f4824f92f69"><td class="memItemLeft" align="right" valign="top">ENTT_ID_TYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a5aaf8cb2a1ad0be02d0b7f4824f92f69">identifier</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a5aaf8cb2a1ad0be02d0b7f4824f92f69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the identifier assigned to a given meta object. <a href="#a5aaf8cb2a1ad0be02d0b7f4824f92f69">More...</a><br /></td></tr>
<tr class="separator:a5aaf8cb2a1ad0be02d0b7f4824f92f69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63056a4d3f0a16c988d90162240fe74d"><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#a63056a4d3f0a16c988d90162240fe74d">parent</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a63056a4d3f0a16c988d90162240fe74d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type to which a meta object belongs. <a href="#a63056a4d3f0a16c988d90162240fe74d">More...</a><br /></td></tr>
<tr class="separator:a63056a4d3f0a16c988d90162240fe74d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4bc5f5e90003362872d8cd056b2f689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__func.html#a422ec572c7c56d3cb46d09704be64f65">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#ae4bc5f5e90003362872d8cd056b2f689">size</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ae4bc5f5e90003362872d8cd056b2f689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments accepted by a meta function. <a href="#ae4bc5f5e90003362872d8cd056b2f689">More...</a><br /></td></tr>
<tr class="separator:ae4bc5f5e90003362872d8cd056b2f689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93c1f9ba3252788f9ac470f6ad6e3fb9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a93c1f9ba3252788f9ac470f6ad6e3fb9">is_const</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a93c1f9ba3252788f9ac470f6ad6e3fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a given meta function is constant or not. <a href="#a93c1f9ba3252788f9ac470f6ad6e3fb9">More...</a><br /></td></tr>
<tr class="separator:a93c1f9ba3252788f9ac470f6ad6e3fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8faf171039dc72ea51d94acc2c2ea249"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a8faf171039dc72ea51d94acc2c2ea249">is_static</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a8faf171039dc72ea51d94acc2c2ea249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a given meta function is static or not. <a href="#a8faf171039dc72ea51d94acc2c2ea249">More...</a><br /></td></tr>
<tr class="separator:a8faf171039dc72ea51d94acc2c2ea249"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a1bfe7f9b2e8c833dbfb5dff75bf1e9"><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#a6a1bfe7f9b2e8c833dbfb5dff75bf1e9">ret</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a6a1bfe7f9b2e8c833dbfb5dff75bf1e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the return type of a meta function. <a href="#a6a1bfe7f9b2e8c833dbfb5dff75bf1e9">More...</a><br /></td></tr>
<tr class="separator:a6a1bfe7f9b2e8c833dbfb5dff75bf1e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34709d9f0a7498382ced3a4e2daa64ba"><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#a34709d9f0a7498382ced3a4e2daa64ba">arg</a> (<a class="el" href="structentt_1_1meta__func.html#a422ec572c7c56d3cb46d09704be64f65">size_type</a> index) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a34709d9f0a7498382ced3a4e2daa64ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the i-th argument of a meta function. <a href="#a34709d9f0a7498382ced3a4e2daa64ba">More...</a><br /></td></tr>
<tr class="separator:a34709d9f0a7498382ced3a4e2daa64ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6145a3e14b99154a5caec4ad66a85c88"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a6145a3e14b99154a5caec4ad66a85c88"><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#a6145a3e14b99154a5caec4ad66a85c88">invoke</a> (<a class="el" href="classentt_1_1meta__handle.html">meta_handle</a> <a class="el" href="classentt_1_1handle.html">handle</a>, Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:a6145a3e14b99154a5caec4ad66a85c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the underlying function, if possible. <a href="#a6145a3e14b99154a5caec4ad66a85c88">More...</a><br /></td></tr>
<tr class="separator:a6145a3e14b99154a5caec4ad66a85c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28d919188b186ad646b56e0fd1485fc6"><td class="memTemplParams" colspan="2">template&lt;typename Op &gt; </td></tr>
<tr class="memitem:a28d919188b186ad646b56e0fd1485fc6"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t&lt; std::is_invocable_v&lt; Op, <a class="el" href="structentt_1_1meta__prop.html">meta_prop</a> &gt;, void &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a28d919188b186ad646b56e0fd1485fc6">prop</a> (Op op) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a28d919188b186ad646b56e0fd1485fc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates all the properties assigned to a meta function. <a href="#a28d919188b186ad646b56e0fd1485fc6">More...</a><br /></td></tr>
<tr class="separator:a28d919188b186ad646b56e0fd1485fc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58b6facbf66b9f4d9c23598e298de2b1"><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#a58b6facbf66b9f4d9c23598e298de2b1">prop</a> (<a class="el" href="classentt_1_1meta__any.html">meta_any</a> key) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a58b6facbf66b9f4d9c23598e298de2b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the property associated with a given key. <a href="#a58b6facbf66b9f4d9c23598e298de2b1">More...</a><br /></td></tr>
<tr class="separator:a58b6facbf66b9f4d9c23598e298de2b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a436c57daae914c9222de41c7b7678584"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a436c57daae914c9222de41c7b7678584">operator bool</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a436c57daae914c9222de41c7b7678584"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="#a436c57daae914c9222de41c7b7678584">More...</a><br /></td></tr>
<tr class="separator:a436c57daae914c9222de41c7b7678584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d29a2982e937d0dff5dac93434099a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__func.html#a4d29a2982e937d0dff5dac93434099a1">operator==</a> (const <a class="el" href="structentt_1_1meta__func.html">meta_func</a> &amp;other) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a4d29a2982e937d0dff5dac93434099a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if two meta objects refer to the same node. <a href="#a4d29a2982e937d0dff5dac93434099a1">More...</a><br /></td></tr>
<tr class="separator:a4d29a2982e937d0dff5dac93434099a1"><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 container for meta functions. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01223">1223</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="a08cf20d2ec99cca580d1121aeed7064c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08cf20d2ec99cca580d1121aeed7064c">&#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 internal::meta_func_node *&#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> </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#l01228">1228</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="a34709d9f0a7498382ced3a4e2daa64ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34709d9f0a7498382ced3a4e2daa64ba">&#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#a422ec572c7c56d3cb46d09704be64f65">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> </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#l01846">1846</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a5aaf8cb2a1ad0be02d0b7f4824f92f69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5aaf8cb2a1ad0be02d0b7f4824f92f69">&#9670;&nbsp;</a></span>identifier()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ENTT_ID_TYPE entt::meta_func::identifier </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 identifier assigned to a given 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#l01233">1233</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a6145a3e14b99154a5caec4ad66a85c88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6145a3e14b99154a5caec4ad66a85c88">&#9670;&nbsp;</a></span>invoke()</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="classentt_1_1meta__handle.html">meta_handle</a>&#160;</td>
<td class="paramname"><em>handle</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>
<p>To invoke a meta function, the types of the parameters must coincide exactly with those required by the underlying function. Otherwise, an empty and then invalid container 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="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">handle</td><td>An opaque pointer to an 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 returned value, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01297">1297</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a93c1f9ba3252788f9ac470f6ad6e3fb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93c1f9ba3252788f9ac470f6ad6e3fb9">&#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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether a given 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#l01252">1252</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a8faf171039dc72ea51d94acc2c2ea249"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8faf171039dc72ea51d94acc2c2ea249">&#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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether a given meta function is static or not. </p>
<p>A static meta function is such that it can be invoked using a null pointer as an instance.</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#l01264">1264</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a436c57daae914c9222de41c7b7678584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a436c57daae914c9222de41c7b7678584">&#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> </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#l01335">1335</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a4d29a2982e937d0dff5dac93434099a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d29a2982e937d0dff5dac93434099a1">&#9670;&nbsp;</a></span>operator==()</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::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__func.html">meta_func</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>Checks if two meta objects refer to the same node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The meta object with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two meta objects refer to the same node, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01340">1340</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a63056a4d3f0a16c988d90162240fe74d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63056a4d3f0a16c988d90162240fe74d">&#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> </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#l01836">1836</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a28d919188b186ad646b56e0fd1485fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28d919188b186ad646b56e0fd1485fc6">&#9670;&nbsp;</a></span>prop() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Op &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::enable_if_t&lt;std::is_invocable_v&lt;Op, <a class="el" href="structentt_1_1meta__prop.html">meta_prop</a>&gt;, void&gt; entt::meta_func::prop </td>
<td>(</td>
<td class="paramtype">Op&#160;</td>
<td class="paramname"><em>op</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>Iterates all the properties assigned to a meta function. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Op</td><td>Type of the function object to invoke. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>A valid function object. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01316">1316</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a58b6facbf66b9f4d9c23598e298de2b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58b6facbf66b9f4d9c23598e298de2b1">&#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#l01325">1325</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a6a1bfe7f9b2e8c833dbfb5dff75bf1e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a1bfe7f9b2e8c833dbfb5dff75bf1e9">&#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> </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#l01841">1841</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ae4bc5f5e90003362872d8cd056b2f689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4bc5f5e90003362872d8cd056b2f689">&#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#a422ec572c7c56d3cb46d09704be64f65">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> </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#l01244">1244</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.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink