Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4b4d0ab7edc4506fda6701af90cebcaad3ed3f3f
entt/structentt_1_1input__iterator__pointer.html
Michele Caini 4b4d0ab7ed API reference v3.14.0
2024-10-23 15:07:48 +02:00

300 lines
17 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::input_iterator_pointer&lt; Type &gt; Struct 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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-awesome.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 id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.14.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_1input__iterator__pointer.html">input_iterator_pointer</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_1input__iterator__pointer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::input_iterator_pointer&lt; Type &gt; Struct Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Helper type to use as pointer with input iterators.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac0bf1d35284f47fc0eaca4936c14e6fd" id="r_ac0bf1d35284f47fc0eaca4936c14e6fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0bf1d35284f47fc0eaca4936c14e6fd">value_type</a> = Type</td></tr>
<tr class="memdesc:ac0bf1d35284f47fc0eaca4936c14e6fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value type. <br /></td></tr>
<tr class="separator:ac0bf1d35284f47fc0eaca4936c14e6fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1541f6a78eb2f792fc03d9a6bfefbab" id="r_ad1541f6a78eb2f792fc03d9a6bfefbab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad1541f6a78eb2f792fc03d9a6bfefbab">pointer</a> = Type *</td></tr>
<tr class="memdesc:ad1541f6a78eb2f792fc03d9a6bfefbab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer type. <br /></td></tr>
<tr class="separator:ad1541f6a78eb2f792fc03d9a6bfefbab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fcbdecfdb892833e1c89dee1d791f19" id="r_a6fcbdecfdb892833e1c89dee1d791f19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6fcbdecfdb892833e1c89dee1d791f19">reference</a> = Type &amp;</td></tr>
<tr class="memdesc:a6fcbdecfdb892833e1c89dee1d791f19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference type. <br /></td></tr>
<tr class="separator:a6fcbdecfdb892833e1c89dee1d791f19"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1805365ee66a86c99a5297932da42392" id="r_a1805365ee66a86c99a5297932da42392"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1805365ee66a86c99a5297932da42392">input_iterator_pointer</a> (<a class="el" href="#ac0bf1d35284f47fc0eaca4936c14e6fd">value_type</a> &amp;&amp;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">val</a>) <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a>(std::is_nothrow_move_constructible_v&lt; <a class="el" href="#ac0bf1d35284f47fc0eaca4936c14e6fd">value_type</a> &gt;)</td></tr>
<tr class="memdesc:a1805365ee66a86c99a5297932da42392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a proxy object by move. <br /></td></tr>
<tr class="separator:a1805365ee66a86c99a5297932da42392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82563e07f0b715f1c587bd2d0e270fbc" id="r_a82563e07f0b715f1c587bd2d0e270fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a> <a class="el" href="#ad1541f6a78eb2f792fc03d9a6bfefbab">pointer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a82563e07f0b715f1c587bd2d0e270fbc">operator-&gt;</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a82563e07f0b715f1c587bd2d0e270fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access operator for accessing wrapped values. <br /></td></tr>
<tr class="separator:a82563e07f0b715f1c587bd2d0e270fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd0737a761dfcece982e92e34ed531e4" id="r_acd0737a761dfcece982e92e34ed531e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a> <a class="el" href="#a6fcbdecfdb892833e1c89dee1d791f19">reference</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd0737a761dfcece982e92e34ed531e4">operator*</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:acd0737a761dfcece982e92e34ed531e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dereference operator for accessing wrapped values. <br /></td></tr>
<tr class="separator:acd0737a761dfcece982e92e34ed531e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type&gt;<br />
struct entt::input_iterator_pointer&lt; Type &gt;</div><p>Helper type to use as pointer with input iterators. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>of wrapped value. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00016">16</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ad1541f6a78eb2f792fc03d9a6bfefbab" name="ad1541f6a78eb2f792fc03d9a6bfefbab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1541f6a78eb2f792fc03d9a6bfefbab">&#9670;&#160;</a></span>pointer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;::pointer = Type *</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer type. </p>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00020">20</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a id="a6fcbdecfdb892833e1c89dee1d791f19" name="a6fcbdecfdb892833e1c89dee1d791f19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fcbdecfdb892833e1c89dee1d791f19">&#9670;&#160;</a></span>reference</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;::reference = Type &amp;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference type. </p>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00022">22</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a id="ac0bf1d35284f47fc0eaca4936c14e6fd" name="ac0bf1d35284f47fc0eaca4936c14e6fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0bf1d35284f47fc0eaca4936c14e6fd">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;::value_type = Type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Value type. </p>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00018">18</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1805365ee66a86c99a5297932da42392" name="a1805365ee66a86c99a5297932da42392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1805365ee66a86c99a5297932da42392">&#9670;&#160;</a></span>input_iterator_pointer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;::input_iterator_pointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#ac0bf1d35284f47fc0eaca4936c14e6fd">value_type</a> &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a proxy object by move. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>Value to use to initialize the proxy object. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00028">28</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acd0737a761dfcece982e92e34ed531e4" name="acd0737a761dfcece982e92e34ed531e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd0737a761dfcece982e92e34ed531e4">&#9670;&#160;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a> <a class="el" href="#a6fcbdecfdb892833e1c89dee1d791f19">reference</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">::operator</a>* </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dereference operator for accessing wrapped values. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the wrapped value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00043">43</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<a id="a82563e07f0b715f1c587bd2d0e270fbc" name="a82563e07f0b715f1c587bd2d0e270fbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82563e07f0b715f1c587bd2d0e270fbc">&#9670;&#160;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">constexpr</a> <a class="el" href="#ad1541f6a78eb2f792fc03d9a6bfefbab">pointer</a> <a class="el" href="structentt_1_1input__iterator__pointer.html">entt::input_iterator_pointer</a>&lt; Type &gt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">::operator</a>-&gt; </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access operator for accessing wrapped values. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the wrapped value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="iterator_8hpp_source.html#l00035">35</a> of file <a class="el" href="iterator_8hpp_source.html">iterator.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/core/<a class="el" href="iterator_8hpp_source.html">iterator.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink