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

265 lines
14 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::allocation_deleter&lt; Allocator &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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="structentt_1_1allocation__deleter.html">allocation_deleter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1allocation__deleter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::allocation_deleter&lt; Allocator &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Deleter for allocator-aware unique pointers (waiting for C++20).
<a href="structentt_1_1allocation__deleter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="memory_8hpp_source.html">memory.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for entt::allocation_deleter&lt; Allocator &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structentt_1_1allocation__deleter__inherit__graph.png" border="0" usemap="#aentt_1_1allocation__deleter_3_01Allocator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aentt_1_1allocation__deleter_3_01Allocator_01_4_inherit__map" id="aentt_1_1allocation__deleter_3_01Allocator_01_4_inherit__map">
<area shape="rect" title="Deleter for allocator&#45;aware unique pointers (waiting for C++20)." alt="" coords="5,79,159,119"/>
<area shape="rect" title=" " alt="" coords="45,5,119,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for entt::allocation_deleter&lt; Allocator &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structentt_1_1allocation__deleter__coll__graph.png" border="0" usemap="#aentt_1_1allocation__deleter_3_01Allocator_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aentt_1_1allocation__deleter_3_01Allocator_01_4_coll__map" id="aentt_1_1allocation__deleter_3_01Allocator_01_4_coll__map">
<area shape="rect" title="Deleter for allocator&#45;aware unique pointers (waiting for C++20)." alt="" coords="5,79,159,119"/>
<area shape="rect" title=" " alt="" coords="45,5,119,31"/>
</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 id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:abce9d9de78a31b79e98745f4e029c863"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1allocation__deleter.html#abce9d9de78a31b79e98745f4e029c863">allocator_type</a> = Allocator</td></tr>
<tr class="memdesc:abce9d9de78a31b79e98745f4e029c863"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocator type. <br /></td></tr>
<tr class="separator:abce9d9de78a31b79e98745f4e029c863"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37186f63eb16409b00b0261041b68c5c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1allocation__deleter.html#a37186f63eb16409b00b0261041b68c5c">pointer</a> = typename std::allocator_traits&lt; Allocator &gt;::pointer</td></tr>
<tr class="memdesc:a37186f63eb16409b00b0261041b68c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer type. <br /></td></tr>
<tr class="separator:a37186f63eb16409b00b0261041b68c5c"><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:a5adbf1ba5d47a86d0b67d2c565fed220"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1allocation__deleter.html#a5adbf1ba5d47a86d0b67d2c565fed220">allocation_deleter</a> (const <a class="el" href="structentt_1_1allocation__deleter.html#abce9d9de78a31b79e98745f4e029c863">allocator_type</a> &amp;alloc) noexcept(std::is_nothrow_copy_constructible_v&lt; <a class="el" href="structentt_1_1allocation__deleter.html#abce9d9de78a31b79e98745f4e029c863">allocator_type</a> &gt;)</td></tr>
<tr class="memdesc:a5adbf1ba5d47a86d0b67d2c565fed220"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inherited constructors. <br /></td></tr>
<tr class="separator:a5adbf1ba5d47a86d0b67d2c565fed220"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeea55e9539671ec5d6b1660f25e57d3"><td class="memItemLeft" align="right" valign="top">constexpr void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1allocation__deleter.html#aaeea55e9539671ec5d6b1660f25e57d3">operator()</a> (<a class="el" href="structentt_1_1allocation__deleter.html#a37186f63eb16409b00b0261041b68c5c">pointer</a> ptr) noexcept(std::is_nothrow_destructible_v&lt; typename allocator_type::value_type &gt;)</td></tr>
<tr class="memdesc:aaeea55e9539671ec5d6b1660f25e57d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the pointed object and deallocates its memory. <br /></td></tr>
<tr class="separator:aaeea55e9539671ec5d6b1660f25e57d3"><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 Allocator&gt;<br />
struct entt::allocation_deleter&lt; Allocator &gt;</div><p>Deleter for allocator-aware unique pointers (waiting for C++20). </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Allocator</td><td>Type of allocator used to manage memory and elements. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="memory_8hpp_source.html#l00112">112</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="abce9d9de78a31b79e98745f4e029c863" name="abce9d9de78a31b79e98745f4e029c863"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abce9d9de78a31b79e98745f4e029c863">&#9670;&#160;</a></span>allocator_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Allocator &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1allocation__deleter.html">entt::allocation_deleter</a>&lt; Allocator &gt;::allocator_type = Allocator</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocator type. </p>
<p class="definition">Definition at line <a class="el" href="memory_8hpp_source.html#l00114">114</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a id="a37186f63eb16409b00b0261041b68c5c" name="a37186f63eb16409b00b0261041b68c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37186f63eb16409b00b0261041b68c5c">&#9670;&#160;</a></span>pointer</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Allocator &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1allocation__deleter.html">entt::allocation_deleter</a>&lt; Allocator &gt;::pointer = typename std::allocator_traits&lt;Allocator&gt;::pointer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer type. </p>
<p class="definition">Definition at line <a class="el" href="memory_8hpp_source.html#l00116">116</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5adbf1ba5d47a86d0b67d2c565fed220" name="a5adbf1ba5d47a86d0b67d2c565fed220"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5adbf1ba5d47a86d0b67d2c565fed220">&#9670;&#160;</a></span>allocation_deleter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="structentt_1_1allocation__deleter.html">entt::allocation_deleter</a>&lt; Allocator &gt;::allocation_deleter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1allocation__deleter.html#abce9d9de78a31b79e98745f4e029c863">allocator_type</a> &amp;&#160;</td>
<td class="paramname"><em>alloc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inherited constructors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alloc</td><td>The allocator to use. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="memory_8hpp_source.html#l00122">122</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaeea55e9539671ec5d6b1660f25e57d3" name="aaeea55e9539671ec5d6b1660f25e57d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeea55e9539671ec5d6b1660f25e57d3">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr void <a class="el" href="structentt_1_1allocation__deleter.html">entt::allocation_deleter</a>&lt; Allocator &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1allocation__deleter.html#a37186f63eb16409b00b0261041b68c5c">pointer</a>&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the pointed object and deallocates its memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>A valid pointer to an object of the given type. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="memory_8hpp_source.html#l00129">129</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/core/<a class="el" href="memory_8hpp_source.html">memory.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