API reference v3.10.0

This commit is contained in:
Michele Caini
2022-04-18 19:54:29 +02:00
parent 6fdc43199c
commit 378182736c
1056 changed files with 21834 additions and 21924 deletions

View File

@@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.9.0</span>
&#160;<span id="projectnumber">3.10.0</span>
</div>
</td>
</tr>
@@ -81,17 +81,39 @@ $(function() {
<a href="classentt_1_1basic__hashed__string.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for entt::basic_hashed_string&lt; Char &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classentt_1_1basic__hashed__string__inherit__graph.png" border="0" usemap="#aentt_1_1basic__hashed__string_3_01Char_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aentt_1_1basic__hashed__string_3_01Char_01_4_inherit__map" id="aentt_1_1basic__hashed__string_3_01Char_01_4_inherit__map">
<area shape="rect" title="Zero overhead unique identifier." alt="" coords="15,95,147,136"/>
<area shape="rect" title=" " alt="" coords="5,5,157,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for entt::basic_hashed_string&lt; Char &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classentt_1_1basic__hashed__string__coll__graph.png" border="0" usemap="#aentt_1_1basic__hashed__string_3_01Char_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aentt_1_1basic__hashed__string_3_01Char_01_4_coll__map" id="aentt_1_1basic__hashed__string_3_01Char_01_4_coll__map">
<area shape="rect" title="Zero overhead unique identifier." alt="" coords="15,95,147,136"/>
<area shape="rect" title=" " alt="" coords="5,5,157,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="memItemLeft" align="right" valign="top"><a id="ad4e8f181e92b9218747ac43fe24c4cbc"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> = Char</td></tr>
<tr class="memdesc:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character type. <br /></td></tr>
<tr class="separator:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1631b1f6ecd56a451366eeb228a6ffb9"><td class="memItemLeft" align="right" valign="top"><a id="a1631b1f6ecd56a451366eeb228a6ffb9"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> = <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a></td></tr>
<tr class="memdesc:a1631b1f6ecd56a451366eeb228a6ffb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a1631b1f6ecd56a451366eeb228a6ffb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fa6c444b2d97cc14506cc509daef9b0"><td class="memItemLeft" align="right" valign="top"><a id="a0fa6c444b2d97cc14506cc509daef9b0"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> = typename base_type::value_type</td></tr>
<tr class="memdesc:a0fa6c444b2d97cc14506cc509daef9b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character type. <br /></td></tr>
<tr class="separator:a0fa6c444b2d97cc14506cc509daef9b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4550e2c6eb3ec63c72d6d831182bd015"><td class="memItemLeft" align="right" valign="top"><a id="a4550e2c6eb3ec63c72d6d831182bd015"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a> = typename base_type::size_type</td></tr>
<tr class="memdesc:a4550e2c6eb3ec63c72d6d831182bd015"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a4550e2c6eb3ec63c72d6d831182bd015"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b625799426407d8083f7d418e2c6a9e"><td class="memItemLeft" align="right" valign="top"><a id="a7b625799426407d8083f7d418e2c6a9e"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> = typename base_type::hash_type</td></tr>
<tr class="memdesc:a7b625799426407d8083f7d418e2c6a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a7b625799426407d8083f7d418e2c6a9e"><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>
@@ -99,17 +121,23 @@ Public Member Functions</h2></td></tr>
constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#aa8b2ea90ba4d1bbb98d485f6a93e574e">basic_hashed_string</a> ()</td></tr>
<tr class="memdesc:aa8b2ea90ba4d1bbb98d485f6a93e574e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty hashed string. <br /></td></tr>
<tr class="separator:aa8b2ea90ba4d1bbb98d485f6a93e574e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b0454a742c7556c805e79fc19b556dd"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:a0b0454a742c7556c805e79fc19b556dd"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a0b0454a742c7556c805e79fc19b556dd">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;curr)[N])</td></tr>
<tr class="memdesc:a0b0454a742c7556c805e79fc19b556dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a hashed string from an array of const characters. <a href="classentt_1_1basic__hashed__string.html#a0b0454a742c7556c805e79fc19b556dd">More...</a><br /></td></tr>
<tr class="separator:a0b0454a742c7556c805e79fc19b556dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a980863db27ae60a5f6b1a883784ee935"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a980863db27ae60a5f6b1a883784ee935">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> *str, const <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a> len)</td></tr>
<tr class="memdesc:a980863db27ae60a5f6b1a883784ee935"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a hashed string from a string view. <a href="classentt_1_1basic__hashed__string.html#a980863db27ae60a5f6b1a883784ee935">More...</a><br /></td></tr>
<tr class="separator:a980863db27ae60a5f6b1a883784ee935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec8acecd9af1c36f4a2edc44f3eeeb0b"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:aec8acecd9af1c36f4a2edc44f3eeeb0b"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#aec8acecd9af1c36f4a2edc44f3eeeb0b">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a>(&amp;str)[N])</td></tr>
<tr class="memdesc:aec8acecd9af1c36f4a2edc44f3eeeb0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a hashed string from an array of const characters. <a href="classentt_1_1basic__hashed__string.html#aec8acecd9af1c36f4a2edc44f3eeeb0b">More...</a><br /></td></tr>
<tr class="separator:aec8acecd9af1c36f4a2edc44f3eeeb0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564f57a39d02f5b94fa76a5ecf143299"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a564f57a39d02f5b94fa76a5ecf143299">basic_hashed_string</a> (const_wrapper wrapper)</td></tr>
<tr class="memdesc:a564f57a39d02f5b94fa76a5ecf143299"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicit constructor on purpose to avoid constructing a hashed string directly from a <code>const value_type *</code>. <a href="classentt_1_1basic__hashed__string.html#a564f57a39d02f5b94fa76a5ecf143299">More...</a><br /></td></tr>
<tr class="separator:a564f57a39d02f5b94fa76a5ecf143299"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2019106a9113950a488f43feaaa57ccc"><td class="memItemLeft" align="right" valign="top">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a2019106a9113950a488f43feaaa57ccc">data</a> () const</td></tr>
<tr class="memitem:a78d52d39edf529df2225bd0b695e42d5"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a78d52d39edf529df2225bd0b695e42d5">size</a> () const</td></tr>
<tr class="memdesc:a78d52d39edf529df2225bd0b695e42d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size a hashed string. <a href="classentt_1_1basic__hashed__string.html#a78d52d39edf529df2225bd0b695e42d5">More...</a><br /></td></tr>
<tr class="separator:a78d52d39edf529df2225bd0b695e42d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2019106a9113950a488f43feaaa57ccc"><td class="memItemLeft" align="right" valign="top">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a2019106a9113950a488f43feaaa57ccc">data</a> () const</td></tr>
<tr class="memdesc:a2019106a9113950a488f43feaaa57ccc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the human-readable representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#a2019106a9113950a488f43feaaa57ccc">More...</a><br /></td></tr>
<tr class="separator:a2019106a9113950a488f43feaaa57ccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40f85633eba5321389c5ceea4d19cebc"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">value</a> () const</td></tr>
<tr class="memitem:a40f85633eba5321389c5ceea4d19cebc"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">value</a> () const</td></tr>
<tr class="memdesc:a40f85633eba5321389c5ceea4d19cebc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">More...</a><br /></td></tr>
<tr class="separator:a40f85633eba5321389c5ceea4d19cebc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9ade09d3f55abe5bbae3438331aa7a2"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#aa9ade09d3f55abe5bbae3438331aa7a2">operator const value_type *</a> () const</td></tr>
@@ -121,23 +149,23 @@ constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href=
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac592a42bf7488cbecc5a1dd74efc0815"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#ac592a42bf7488cbecc5a1dd74efc0815">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *str, std::size_t size)</td></tr>
<tr class="memdesc:ac592a42bf7488cbecc5a1dd74efc0815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string view. <a href="classentt_1_1basic__hashed__string.html#ac592a42bf7488cbecc5a1dd74efc0815">More...</a><br /></td></tr>
<tr class="separator:ac592a42bf7488cbecc5a1dd74efc0815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a508fdeb2af222f74dfffedffb8a18db0"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a508fdeb2af222f74dfffedffb8a18db0">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> *str, const <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a> len)</td></tr>
<tr class="memdesc:a508fdeb2af222f74dfffedffb8a18db0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string view. <a href="classentt_1_1basic__hashed__string.html#a508fdeb2af222f74dfffedffb8a18db0">More...</a><br /></td></tr>
<tr class="separator:a508fdeb2af222f74dfffedffb8a18db0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63725144b0b9af67e9965ab0a60c5862"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:a63725144b0b9af67e9965ab0a60c5862"><td class="memTemplItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a63725144b0b9af67e9965ab0a60c5862">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;str)[N])</td></tr>
<tr class="memitem:a63725144b0b9af67e9965ab0a60c5862"><td class="memTemplItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a63725144b0b9af67e9965ab0a60c5862">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a>(&amp;str)[N])</td></tr>
<tr class="memdesc:a63725144b0b9af67e9965ab0a60c5862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a63725144b0b9af67e9965ab0a60c5862">More...</a><br /></td></tr>
<tr class="separator:a63725144b0b9af67e9965ab0a60c5862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a224b0f2486381e536b627bbde4de7c87"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a224b0f2486381e536b627bbde4de7c87">value</a> (const_wrapper wrapper)</td></tr>
<tr class="memdesc:a224b0f2486381e536b627bbde4de7c87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a224b0f2486381e536b627bbde4de7c87">More...</a><br /></td></tr>
<tr class="separator:a224b0f2486381e536b627bbde4de7c87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2524b59bd7e665f19751bfa3f415fb7f"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a2524b59bd7e665f19751bfa3f415fb7f">value</a> (const_wrapper wrapper)</td></tr>
<tr class="memdesc:a2524b59bd7e665f19751bfa3f415fb7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a2524b59bd7e665f19751bfa3f415fb7f">More...</a><br /></td></tr>
<tr class="separator:a2524b59bd7e665f19751bfa3f415fb7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Char&gt;<br />
class entt::basic_hashed_string&lt; Char &gt;</h3>
<p>Zero overhead unique identifier. </p>
<p>A hashed string is a compile-time tool that allows users to use human-readable identifers in the codebase while using their numeric counterparts at runtime.<br />
<p>A hashed string is a compile-time tool that allows users to use human-readable identifiers in the codebase while using their numeric counterparts at runtime.<br />
Because of that, a hashed string can also be used in constant expressions if required.</p>
<dl class="section warning"><dt>Warning</dt><dd>This class doesn't take ownership of user-supplied strings nor does it make a copy of them.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
@@ -147,10 +175,59 @@ class entt::basic_hashed_string&lt; Char &gt;</h3>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00058">58</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00069">69</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0b0454a742c7556c805e79fc19b556dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b0454a742c7556c805e79fc19b556dd">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[1/2]</span></h2>
<a id="a980863db27ae60a5f6b1a883784ee935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a980863db27ae60a5f6b1a883784ee935">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::<a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a hashed string from a string view. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Human-readable identifier. </td></tr>
<tr><td class="paramname">len</td><td>Length of the string to hash. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00148">148</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="aec8acecd9af1c36f4a2edc44f3eeeb0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec8acecd9af1c36f4a2edc44f3eeeb0b">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -165,8 +242,8 @@ template&lt;std::size_t N&gt; </div>
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::<a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;)&#160;</td>
<td class="paramname"><em>curr</em>[N]</td><td>)</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a>(&amp;)&#160;</td>
<td class="paramname"><em>str</em>[N]</td><td>)</td>
<td></td>
</tr>
</table>
@@ -178,9 +255,7 @@ template&lt;std::size_t N&gt; </div>
</div><div class="memdoc">
<p>Constructs a hashed string from an array of const characters. </p>
<p>Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.<br />
Example of use: </p><div class="fragment"><div class="line">basic_hashed_string&lt;char&gt; hs{<span class="stringliteral">&quot;my.png&quot;</span>};</div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">N</td><td>Number of characters of the identifier. </td></tr>
</table>
@@ -188,17 +263,17 @@ template&lt;std::size_t N&gt; </div>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">curr</td><td>Human-readable identifer. </td></tr>
<tr><td class="paramname">str</td><td>Human-readable identifier. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00145">145</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00157">157</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a564f57a39d02f5b94fa76a5ecf143299"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a564f57a39d02f5b94fa76a5ecf143299">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[2/2]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a564f57a39d02f5b94fa76a5ecf143299">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -232,7 +307,7 @@ template&lt;typename Char &gt; </div>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00158">158</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00169">169</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
@@ -249,7 +324,7 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>* <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::data </td>
<td class="memname">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a>* <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
@@ -263,9 +338,9 @@ template&lt;typename Char &gt; </div>
</div><div class="memdoc">
<p>Returns the human-readable representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the instance. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the hashed string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00166">166</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00184">184</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
@@ -281,7 +356,7 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> * </td>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
@@ -295,9 +370,9 @@ template&lt;typename Char &gt; </div>
</div><div class="memdoc">
<p>Returns the human-readable representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the instance. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the hashed string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00179">179</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00197">197</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
@@ -313,7 +388,7 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> </td>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
@@ -327,9 +402,41 @@ template&lt;typename Char &gt; </div>
</div><div class="memdoc">
<p>Returns the numeric representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the instance. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the hashed string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00187">187</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00205">205</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a78d52d39edf529df2225bd0b695e42d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78d52d39edf529df2225bd0b695e42d5">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The size of the hashed string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00176">176</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
@@ -345,7 +452,7 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
@@ -359,14 +466,14 @@ template&lt;typename Char &gt; </div>
</div><div class="memdoc">
<p>Returns the numeric representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the instance. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the hashed string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00174">174</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00192">192</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="ac592a42bf7488cbecc5a1dd74efc0815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac592a42bf7488cbecc5a1dd74efc0815">&#9670;&nbsp;</a></span>value() <span class="overload">[2/4]</span></h2>
<a id="a508fdeb2af222f74dfffedffb8a18db0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a508fdeb2af222f74dfffedffb8a18db0">&#9670;&nbsp;</a></span>value() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -377,16 +484,16 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *&#160;</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a> *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a4550e2c6eb3ec63c72d6d831182bd015">size_type</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -404,14 +511,14 @@ template&lt;typename Char &gt; </div>
<p>Returns directly the numeric representation of a string view. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Human-readable identifer. </td></tr>
<tr><td class="paramname">size</td><td>Length of the string to hash. </td></tr>
<tr><td class="paramname">str</td><td>Human-readable identifier. </td></tr>
<tr><td class="paramname">len</td><td>Length of the string to hash. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00090">90</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00115">115</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
@@ -429,9 +536,9 @@ template&lt;std::size_t N&gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;)&#160;</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#a0fa6c444b2d97cc14506cc509daef9b0">value_type</a>(&amp;)&#160;</td>
<td class="paramname"><em>str</em>[N]</td><td>)</td>
<td></td>
</tr>
@@ -444,10 +551,7 @@ template&lt;std::size_t N&gt; </div>
</div><div class="memdoc">
<p>Returns directly the numeric representation of a string. </p>
<p>Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.<br />
Example of use: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keyword">auto</span> <a class="code" href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">value</a> = <a class="code" href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">basic_hashed_string&lt;char&gt;::value</a>(<span class="stringliteral">&quot;my.png&quot;</span>);</div>
<div class="ttc" id="aclassentt_1_1basic__hashed__string_html_a40f85633eba5321389c5ceea4d19cebc"><div class="ttname"><a href="classentt_1_1basic__hashed__string.html#a40f85633eba5321389c5ceea4d19cebc">entt::basic_hashed_string::value</a></div><div class="ttdeci">constexpr hash_type value() const</div><div class="ttdoc">Returns the numeric representation of a hashed string.</div><div class="ttdef"><b>Definition:</b> <a href="hashed__string_8hpp_source.html#l00174">hashed_string.hpp:174</a></div></div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">N</td><td>Number of characters of the identifier. </td></tr>
</table>
@@ -455,18 +559,18 @@ template&lt;std::size_t N&gt; </div>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Human-readable identifer. </td></tr>
<tr><td class="paramname">str</td><td>Human-readable identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00112">112</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00126">126</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a224b0f2486381e536b627bbde4de7c87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a224b0f2486381e536b627bbde4de7c87">&#9670;&nbsp;</a></span>value() <span class="overload">[4/4]</span></h2>
<a id="a2524b59bd7e665f19751bfa3f415fb7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2524b59bd7e665f19751bfa3f415fb7f">&#9670;&nbsp;</a></span>value() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -477,7 +581,7 @@ template&lt;typename Char &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classentt_1_1basic__hashed__string.html#a1631b1f6ecd56a451366eeb228a6ffb9">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7b625799426407d8083f7d418e2c6a9e">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const_wrapper&#160;</td>
<td class="paramname"><em>wrapper</em></td><td>)</td>
@@ -486,7 +590,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -500,7 +604,7 @@ template&lt;typename Char &gt; </div>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00121">121</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00135">135</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>