Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7cf7699bab13f2e0414dd4dda6a29591dd8b5686
entt/classentt_1_1basic__snapshot.html
Michele Caini 7cf7699bab API reference v3.12.0
2023-06-15 11:47:04 +02:00

560 lines
29 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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_snapshot&lt; Registry &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen-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.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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');
$(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">
<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="classentt_1_1basic__snapshot.html">basic_snapshot</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="classentt_1_1basic__snapshot-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_snapshot&lt; Registry &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Utility class to create snapshots from a registry.
<a href="classentt_1_1basic__snapshot.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="snapshot_8hpp_source.html">snapshot.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:a0c9d161ffb8b94259166b432852efbac"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a0c9d161ffb8b94259166b432852efbac">registry_type</a> = Registry</td></tr>
<tr class="separator:a0c9d161ffb8b94259166b432852efbac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a052964a4a99d37ab39219bda2372c17b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a052964a4a99d37ab39219bda2372c17b">entity_type</a> = typename registry_type::entity_type</td></tr>
<tr class="memdesc:a052964a4a99d37ab39219bda2372c17b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:a052964a4a99d37ab39219bda2372c17b"><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:a04da73375c3f546f52852aa174a2ab06"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a04da73375c3f546f52852aa174a2ab06">basic_snapshot</a> (const <a class="el" href="classentt_1_1basic__snapshot.html#a0c9d161ffb8b94259166b432852efbac">registry_type</a> &amp;source) noexcept</td></tr>
<tr class="memdesc:a04da73375c3f546f52852aa174a2ab06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance that is bound to a given registry. <br /></td></tr>
<tr class="separator:a04da73375c3f546f52852aa174a2ab06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8d0d610dad9fc00c73c167dc46cba8f"><td class="memItemLeft" align="right" valign="top"><a id="ae8d0d610dad9fc00c73c167dc46cba8f" name="ae8d0d610dad9fc00c73c167dc46cba8f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_snapshot</b> (<a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:ae8d0d610dad9fc00c73c167dc46cba8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:ae8d0d610dad9fc00c73c167dc46cba8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a149c419863771ff599abd2103647ec6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a149c419863771ff599abd2103647ec6b">operator=</a> (<a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:a149c419863771ff599abd2103647ec6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
<tr class="separator:a149c419863771ff599abd2103647ec6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d49e430bdc8a0558c5eca20be7ad382"><td class="memTemplParams" colspan="2">template&lt;typename Type , typename Archive &gt; </td></tr>
<tr class="memitem:a6d49e430bdc8a0558c5eca20be7ad382"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a6d49e430bdc8a0558c5eca20be7ad382">get</a> (Archive &amp;archive, const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt; Type &gt;::value()) const</td></tr>
<tr class="memdesc:a6d49e430bdc8a0558c5eca20be7ad382"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all elements of a type with associated identifiers. <br /></td></tr>
<tr class="separator:a6d49e430bdc8a0558c5eca20be7ad382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4c96723bedd73f8db3789389f933b94"><td class="memTemplParams" colspan="2">template&lt;typename Type , typename Archive , typename It &gt; </td></tr>
<tr class="memitem:ae4c96723bedd73f8db3789389f933b94"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#ae4c96723bedd73f8db3789389f933b94">get</a> (Archive &amp;archive, It first, It last, const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt; Type &gt;::value()) const</td></tr>
<tr class="memdesc:ae4c96723bedd73f8db3789389f933b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all elements of a type with associated identifiers for the entities in a range. <br /></td></tr>
<tr class="separator:ae4c96723bedd73f8db3789389f933b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a795441de3661e876b5e10864d6643541"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:a795441de3661e876b5e10864d6643541"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a795441de3661e876b5e10864d6643541">entities</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:a795441de3661e876b5e10864d6643541"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all identifiers, including those to be recycled. <br /></td></tr>
<tr class="separator:a795441de3661e876b5e10864d6643541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac06f493e137deca90036bff9e6876c13"><td class="memTemplParams" colspan="2">template&lt;typename... Component, typename Archive &gt; </td></tr>
<tr class="memitem:ac06f493e137deca90036bff9e6876c13"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#ac06f493e137deca90036bff9e6876c13">component</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:ac06f493e137deca90036bff9e6876c13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all elements of a type with associated identifiers. <br /></td></tr>
<tr class="separator:ac06f493e137deca90036bff9e6876c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f6c7a53bbc8d1321f2fa4f488ba0cb8"><td class="memTemplParams" colspan="2">template&lt;typename... Component, typename Archive , typename It &gt; </td></tr>
<tr class="memitem:a2f6c7a53bbc8d1321f2fa4f488ba0cb8"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__snapshot.html#a2f6c7a53bbc8d1321f2fa4f488ba0cb8">component</a> (Archive &amp;archive, It first, It last) const</td></tr>
<tr class="memdesc:a2f6c7a53bbc8d1321f2fa4f488ba0cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all elements of a type with associated identifiers for the entities in a range. <br /></td></tr>
<tr class="separator:a2f6c7a53bbc8d1321f2fa4f488ba0cb8"><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;typename Registry&gt;<br />
class entt::basic_snapshot&lt; Registry &gt;</div><p>Utility class to create snapshots from a registry. </p>
<p>A <em>snapshot</em> can be either a dump of the entire registry or a narrower selection of components of interest.<br />
This type can be used in both cases if provided with a correctly configured output archive.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Registry</td><td>Basic registry type. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00055">55</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a052964a4a99d37ab39219bda2372c17b" name="a052964a4a99d37ab39219bda2372c17b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a052964a4a99d37ab39219bda2372c17b">&#9670;&#160;</a></span>entity_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::entity_type = typename registry_type::entity_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying entity identifier. </p>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00063">63</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a0c9d161ffb8b94259166b432852efbac" name="a0c9d161ffb8b94259166b432852efbac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c9d161ffb8b94259166b432852efbac">&#9670;&#160;</a></span>registry_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::registry_type = Registry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic registry type. </p>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00061">61</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a04da73375c3f546f52852aa174a2ab06" name="a04da73375c3f546f52852aa174a2ab06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04da73375c3f546f52852aa174a2ab06">&#9670;&#160;</a></span>basic_snapshot()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::basic_snapshot </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__snapshot.html#a0c9d161ffb8b94259166b432852efbac">registry_type</a> &amp;&#160;</td>
<td class="paramname"><em>source</em></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 that is bound to a given registry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>A valid reference to a registry. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00069">69</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac06f493e137deca90036bff9e6876c13" name="ac06f493e137deca90036bff9e6876c13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06f493e137deca90036bff9e6876c13">&#9670;&#160;</a></span>component() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename... Component, typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::component </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Serializes all elements of a type with associated identifiers. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00162">162</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a2f6c7a53bbc8d1321f2fa4f488ba0cb8" name="a2f6c7a53bbc8d1321f2fa4f488ba0cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f6c7a53bbc8d1321f2fa4f488ba0cb8">&#9670;&#160;</a></span>component() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename... Component, typename Archive , typename It &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::component </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">It&#160;</td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">It&#160;</td>
<td class="paramname"><em>last</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>Serializes all elements of a type with associated identifiers for the entities in a range. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
<tr><td class="paramname">first</td><td>An iterator to the first element of the range to serialize. </td></tr>
<tr><td class="paramname">last</td><td>An iterator past the last element of the range to serialize. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00178">178</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a795441de3661e876b5e10864d6643541" name="a795441de3661e876b5e10864d6643541"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a795441de3661e876b5e10864d6643541">&#9670;&#160;</a></span>entities()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::entities </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Serializes all identifiers, including those to be recycled. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00150">150</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a6d49e430bdc8a0558c5eca20be7ad382" name="a6d49e430bdc8a0558c5eca20be7ad382"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d49e430bdc8a0558c5eca20be7ad382">&#9670;&#160;</a></span>get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Type , typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::get </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>&#160;</td>
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt;Type&gt;::value()</code>&#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>Serializes all elements of a type with associated identifiers. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of elements to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00087">87</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ae4c96723bedd73f8db3789389f933b94" name="ae4c96723bedd73f8db3789389f933b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4c96723bedd73f8db3789389f933b94">&#9670;&#160;</a></span>get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Type , typename Archive , typename It &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::get </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">It&#160;</td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">It&#160;</td>
<td class="paramname"><em>last</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>&#160;</td>
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt;Type&gt;::value()</code>&#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>Serializes all elements of a type with associated identifiers for the entities in a range. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of elements to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
<tr><td class="paramname">first</td><td>An iterator to the first element of the range to serialize. </td></tr>
<tr><td class="paramname">last</td><td>An iterator past the last element of the range to serialize. </td></tr>
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00122">122</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a149c419863771ff599abd2103647ec6b" name="a149c419863771ff599abd2103647ec6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a149c419863771ff599abd2103647ec6b">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a> &amp; <a class="el" href="classentt_1_1basic__snapshot.html">entt::basic_snapshot</a>&lt; Registry &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__snapshot.html">basic_snapshot</a>&lt; Registry &gt; &amp;&amp;&#160;</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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This snapshot. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
<li>src/entt/entity/<a class="el" href="snapshot_8hpp_source.html">snapshot.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.9.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink