API reference v3.5.0

This commit is contained in:
Michele Caini
2020-09-01 00:18:55 +02:00
parent 38227d5bf9
commit 78795e2da0
1070 changed files with 33109 additions and 16951 deletions

View File

@@ -3,7 +3,7 @@
<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.17"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_hashed_string&lt; Char &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -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.4.0</span>
&#160;<span id="projectnumber">3.5.0</span>
</div>
</td>
</tr>
@@ -30,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
@@ -89,58 +89,58 @@ using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cla
<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#a4780f9d4e975066afb16b1309c644995">id_type</a></td></tr>
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>
</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:a2c75763872c028b062701523e0314f29"><td class="memItemLeft" align="right" valign="top"><a id="a2c75763872c028b062701523e0314f29"></a>
constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a2c75763872c028b062701523e0314f29">basic_hashed_string</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a2c75763872c028b062701523e0314f29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty hashed string. <br /></td></tr>
<tr class="separator:a2c75763872c028b062701523e0314f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac422f04d11c1e5573f04809c1e1c106"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:aac422f04d11c1e5573f04809c1e1c106"><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#aac422f04d11c1e5573f04809c1e1c106">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;curr)[N]) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aac422f04d11c1e5573f04809c1e1c106"><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#aac422f04d11c1e5573f04809c1e1c106">More...</a><br /></td></tr>
<tr class="separator:aac422f04d11c1e5573f04809c1e1c106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab5e09f3e552436872bcaaf9ca2c1ac"><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#a7ab5e09f3e552436872bcaaf9ca2c1ac">basic_hashed_string</a> (const_wrapper wrapper) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ab5e09f3e552436872bcaaf9ca2c1ac"><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#a7ab5e09f3e552436872bcaaf9ca2c1ac">More...</a><br /></td></tr>
<tr class="separator:a7ab5e09f3e552436872bcaaf9ca2c1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ef3ad96865551846e584780146d3d24"><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#a7ef3ad96865551846e584780146d3d24">data</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ef3ad96865551846e584780146d3d24"><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#a7ef3ad96865551846e584780146d3d24">More...</a><br /></td></tr>
<tr class="separator:a7ef3ad96865551846e584780146d3d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb3a92282e81fb50af66953f39671f3c"><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#afb3a92282e81fb50af66953f39671f3c">value</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:afb3a92282e81fb50af66953f39671f3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">More...</a><br /></td></tr>
<tr class="separator:afb3a92282e81fb50af66953f39671f3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0cc0b27f0dd52a07e25f5014ba426fc"><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#ad0cc0b27f0dd52a07e25f5014ba426fc">operator const value_type *</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad0cc0b27f0dd52a07e25f5014ba426fc"><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#ad0cc0b27f0dd52a07e25f5014ba426fc">More...</a><br /></td></tr>
<tr class="separator:ad0cc0b27f0dd52a07e25f5014ba426fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2009a1ac648d8bdaeac642a6476f2bd"><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#aa2009a1ac648d8bdaeac642a6476f2bd">operator hash_type</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aa2009a1ac648d8bdaeac642a6476f2bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#aa2009a1ac648d8bdaeac642a6476f2bd">More...</a><br /></td></tr>
<tr class="separator:aa2009a1ac648d8bdaeac642a6476f2bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51311d6903443296ce076536df2b46da"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a51311d6903443296ce076536df2b46da">operator==</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> &amp;other) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a51311d6903443296ce076536df2b46da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two hashed strings. <a href="classentt_1_1basic__hashed__string.html#a51311d6903443296ce076536df2b46da">More...</a><br /></td></tr>
<tr class="separator:a51311d6903443296ce076536df2b46da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad293de7f68f028a3e5bd8c5928cd2595"><td class="memItemLeft" align="right" valign="top"><a id="ad293de7f68f028a3e5bd8c5928cd2595"></a>
constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#ad293de7f68f028a3e5bd8c5928cd2595">basic_hashed_string</a> () noexcept</td></tr>
<tr class="memdesc:ad293de7f68f028a3e5bd8c5928cd2595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty hashed string. <br /></td></tr>
<tr class="separator:ad293de7f68f028a3e5bd8c5928cd2595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec8a507ee512e130842834ac57a20b1"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:a8ec8a507ee512e130842834ac57a20b1"><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#a8ec8a507ee512e130842834ac57a20b1">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;curr)[N]) noexcept</td></tr>
<tr class="memdesc:a8ec8a507ee512e130842834ac57a20b1"><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#a8ec8a507ee512e130842834ac57a20b1">More...</a><br /></td></tr>
<tr class="separator:a8ec8a507ee512e130842834ac57a20b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af73ccc8ea097392a5ca14d1d8dfc13f0"><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#af73ccc8ea097392a5ca14d1d8dfc13f0">basic_hashed_string</a> (const_wrapper wrapper) noexcept</td></tr>
<tr class="memdesc:af73ccc8ea097392a5ca14d1d8dfc13f0"><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#af73ccc8ea097392a5ca14d1d8dfc13f0">More...</a><br /></td></tr>
<tr class="separator:af73ccc8ea097392a5ca14d1d8dfc13f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51ae08b41d0cab42005dfda4ab6ede4a"><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#a51ae08b41d0cab42005dfda4ab6ede4a">data</a> () const noexcept</td></tr>
<tr class="memdesc:a51ae08b41d0cab42005dfda4ab6ede4a"><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#a51ae08b41d0cab42005dfda4ab6ede4a">More...</a><br /></td></tr>
<tr class="separator:a51ae08b41d0cab42005dfda4ab6ede4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dfc8c9301c62d82add17de1cb4ffc7c"><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#a3dfc8c9301c62d82add17de1cb4ffc7c">value</a> () const noexcept</td></tr>
<tr class="memdesc:a3dfc8c9301c62d82add17de1cb4ffc7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#a3dfc8c9301c62d82add17de1cb4ffc7c">More...</a><br /></td></tr>
<tr class="separator:a3dfc8c9301c62d82add17de1cb4ffc7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea866875a9b05e5c01c9642766a5857f"><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#aea866875a9b05e5c01c9642766a5857f">operator const value_type *</a> () const noexcept</td></tr>
<tr class="memdesc:aea866875a9b05e5c01c9642766a5857f"><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#aea866875a9b05e5c01c9642766a5857f">More...</a><br /></td></tr>
<tr class="separator:aea866875a9b05e5c01c9642766a5857f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0018b378b254991675acc20ba2c600d"><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#af0018b378b254991675acc20ba2c600d">operator hash_type</a> () const noexcept</td></tr>
<tr class="memdesc:af0018b378b254991675acc20ba2c600d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#af0018b378b254991675acc20ba2c600d">More...</a><br /></td></tr>
<tr class="separator:af0018b378b254991675acc20ba2c600d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a168ddcf724ba17c60b38093ea520aa20"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a168ddcf724ba17c60b38093ea520aa20">operator==</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> &amp;other) const noexcept</td></tr>
<tr class="memdesc:a168ddcf724ba17c60b38093ea520aa20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two hashed strings. <a href="classentt_1_1basic__hashed__string.html#a168ddcf724ba17c60b38093ea520aa20">More...</a><br /></td></tr>
<tr class="separator:a168ddcf724ba17c60b38093ea520aa20"><td class="memSeparator" colspan="2">&#160;</td></tr>
</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:abbd837edf6b152c7b46bfd619241264c"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:abbd837edf6b152c7b46bfd619241264c"><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#abbd837edf6b152c7b46bfd619241264c">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;str)[N]) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:abbd837edf6b152c7b46bfd619241264c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#abbd837edf6b152c7b46bfd619241264c">More...</a><br /></td></tr>
<tr class="separator:abbd837edf6b152c7b46bfd619241264c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c29491d20b14d8815229604d3580d3e"><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#a9c29491d20b14d8815229604d3580d3e">value</a> (const_wrapper wrapper) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a9c29491d20b14d8815229604d3580d3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a9c29491d20b14d8815229604d3580d3e">More...</a><br /></td></tr>
<tr class="separator:a9c29491d20b14d8815229604d3580d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ccb9802c4f1077537df9b56e33e1f46"><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#a7ccb9802c4f1077537df9b56e33e1f46">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *str, std::size_t size) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ccb9802c4f1077537df9b56e33e1f46"><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#a7ccb9802c4f1077537df9b56e33e1f46">More...</a><br /></td></tr>
<tr class="separator:a7ccb9802c4f1077537df9b56e33e1f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e3866531b504f05e804273188f1c0c0"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:a4e3866531b504f05e804273188f1c0c0"><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#a4e3866531b504f05e804273188f1c0c0">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;str)[N]) noexcept</td></tr>
<tr class="memdesc:a4e3866531b504f05e804273188f1c0c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a4e3866531b504f05e804273188f1c0c0">More...</a><br /></td></tr>
<tr class="separator:a4e3866531b504f05e804273188f1c0c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67cd9ffab58a312064e59dbaa09f7efa"><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#a67cd9ffab58a312064e59dbaa09f7efa">value</a> (const_wrapper wrapper) noexcept</td></tr>
<tr class="memdesc:a67cd9ffab58a312064e59dbaa09f7efa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a67cd9ffab58a312064e59dbaa09f7efa">More...</a><br /></td></tr>
<tr class="separator:a67cd9ffab58a312064e59dbaa09f7efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a032acd7551658f6e5d46d555452bd3df"><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#a032acd7551658f6e5d46d555452bd3df">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *str, std::size_t size) noexcept</td></tr>
<tr class="memdesc:a032acd7551658f6e5d46d555452bd3df"><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#a032acd7551658f6e5d46d555452bd3df">More...</a><br /></td></tr>
<tr class="separator:a032acd7551658f6e5d46d555452bd3df"><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>TURN_OFF_DOXYGEN 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 identifers 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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
@@ -151,8 +151,8 @@ class entt::basic_hashed_string&lt; Char &gt;</h3>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00064">64</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="aac422f04d11c1e5573f04809c1e1c106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac422f04d11c1e5573f04809c1e1c106">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[1/2]</span></h2>
<a id="a8ec8a507ee512e130842834ac57a20b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ec8a507ee512e130842834ac57a20b1">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -174,7 +174,7 @@ template&lt;std::size_t N&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -199,8 +199,8 @@ template&lt;std::size_t N&gt; </div>
</div>
</div>
<a id="a7ab5e09f3e552436872bcaaf9ca2c1ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ab5e09f3e552436872bcaaf9ca2c1ac">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[2/2]</span></h2>
<a id="af73ccc8ea097392a5ca14d1d8dfc13f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af73ccc8ea097392a5ca14d1d8dfc13f0">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -220,7 +220,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">constexpr</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -238,8 +238,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7ef3ad96865551846e584780146d3d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef3ad96865551846e584780146d3d24">&#9670;&nbsp;</a></span>data()</h2>
<a id="a51ae08b41d0cab42005dfda4ab6ede4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51ae08b41d0cab42005dfda4ab6ede4a">&#9670;&nbsp;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
@@ -258,7 +258,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -270,8 +270,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="ad0cc0b27f0dd52a07e25f5014ba426fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0cc0b27f0dd52a07e25f5014ba426fc">&#9670;&nbsp;</a></span>operator const value_type *()</h2>
<a id="aea866875a9b05e5c01c9642766a5857f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea866875a9b05e5c01c9642766a5857f">&#9670;&nbsp;</a></span>operator const value_type *()</h2>
<div class="memitem">
<div class="memproto">
@@ -290,7 +290,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -302,8 +302,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="aa2009a1ac648d8bdaeac642a6476f2bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2009a1ac648d8bdaeac642a6476f2bd">&#9670;&nbsp;</a></span>operator hash_type()</h2>
<a id="af0018b378b254991675acc20ba2c600d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0018b378b254991675acc20ba2c600d">&#9670;&nbsp;</a></span>operator hash_type()</h2>
<div class="memitem">
<div class="memproto">
@@ -322,7 +322,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -334,8 +334,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="a51311d6903443296ce076536df2b46da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51311d6903443296ce076536df2b46da">&#9670;&nbsp;</a></span>operator==()</h2>
<a id="a168ddcf724ba17c60b38093ea520aa20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a168ddcf724ba17c60b38093ea520aa20">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
@@ -355,7 +355,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -373,8 +373,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="afb3a92282e81fb50af66953f39671f3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3a92282e81fb50af66953f39671f3c">&#9670;&nbsp;</a></span>value() <span class="overload">[1/4]</span></h2>
<a id="a3dfc8c9301c62d82add17de1cb4ffc7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dfc8c9301c62d82add17de1cb4ffc7c">&#9670;&nbsp;</a></span>value() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -393,7 +393,7 @@ template&lt;typename Char &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
<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">
@@ -405,8 +405,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="a7ccb9802c4f1077537df9b56e33e1f46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ccb9802c4f1077537df9b56e33e1f46">&#9670;&nbsp;</a></span>value() <span class="overload">[2/4]</span></h2>
<a id="a032acd7551658f6e5d46d555452bd3df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a032acd7551658f6e5d46d555452bd3df">&#9670;&nbsp;</a></span>value() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -436,7 +436,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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -455,8 +455,8 @@ template&lt;typename Char &gt; </div>
</div>
</div>
<a id="abbd837edf6b152c7b46bfd619241264c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbd837edf6b152c7b46bfd619241264c">&#9670;&nbsp;</a></span>value() <span class="overload">[3/4]</span></h2>
<a id="a4e3866531b504f05e804273188f1c0c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e3866531b504f05e804273188f1c0c0">&#9670;&nbsp;</a></span>value() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -478,14 +478,14 @@ template&lt;std::size_t N&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</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#afb3a92282e81fb50af66953f39671f3c">value</a> = basic_hashed_string&lt;char&gt;::to_value(<span class="stringliteral">&quot;my.png&quot;</span>);</div>
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#a3dfc8c9301c62d82add17de1cb4ffc7c">value</a> = basic_hashed_string&lt;char&gt;::to_value(<span class="stringliteral">&quot;my.png&quot;</span>);</div>
</div><!-- fragment --><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>
@@ -504,8 +504,8 @@ template&lt;std::size_t N&gt; </div>
</div>
</div>
<a id="a9c29491d20b14d8815229604d3580d3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c29491d20b14d8815229604d3580d3e">&#9670;&nbsp;</a></span>value() <span class="overload">[4/4]</span></h2>
<a id="a67cd9ffab58a312064e59dbaa09f7efa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67cd9ffab58a312064e59dbaa09f7efa">&#9670;&nbsp;</a></span>value() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -525,7 +525,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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -547,12 +547,12 @@ template&lt;typename Char &gt; </div>
<li>src/entt/core/<a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassentt_1_1basic__hashed__string_html_afb3a92282e81fb50af66953f39671f3c"><div class="ttname"><a href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">entt::basic_hashed_string::value</a></div><div class="ttdeci">constexpr hash_type value() const ENTT_NOEXCEPT</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#l00176">hashed_string.hpp:176</a></div></div>
<div class="ttc" id="aclassentt_1_1basic__hashed__string_html_a3dfc8c9301c62d82add17de1cb4ffc7c"><div class="ttname"><a href="classentt_1_1basic__hashed__string.html#a3dfc8c9301c62d82add17de1cb4ffc7c">entt::basic_hashed_string::value</a></div><div class="ttdeci">constexpr hash_type value() const noexcept</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#l00176">hashed_string.hpp:176</a></div></div>
<!-- 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.17
</a> 1.8.18
</small></address>
</body>
</html>