Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API reference v3.15.0

Browse Source
This commit is contained in:
Michele Caini
2025-03-19 15:49:42 +01:00
parent 4b4d0ab7ed
commit 1e23a11311
1334 changed files with 46058 additions and 36285 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dot_8hpp_source.html
+23 -15
View File
@@ -3,13 +3,15 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: src/entt/graph/dot.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
@@ -23,7 +25,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.14.0</span>
<div id="projectname">EnTT<span id="projectnumber">&#160;3.15.0</span>
</div>
</td>
</tr>
@@ -31,18 +33,23 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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');
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
@@ -50,7 +57,7 @@ $(function() {
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
@@ -79,6 +86,7 @@ $(function() { codefold.init(0); });
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_cb9807796ea702d95f280c116c66a3f6.html">graph</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">dot.hpp</div></div>
</div><!--header-->
@@ -91,10 +99,10 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;fwd.hpp&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceentt.html">entt</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Graph, <span class="keyword">typename</span> Writer&gt;</div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="}">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4"> 19</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">dot</a>(std::ostream &amp;out, <span class="keyword">const</span> <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Graph</a> &amp;graph, <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Writer</a> <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">writer</a>) {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4"> 19</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">dot</a>(std::ostream &amp;out, <span class="keyword">const</span> Graph &amp;graph, Writer writer) {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">static_assert</span>(std::is_base_of_v&lt;directed_tag, typename Graph::graph_category&gt;, <span class="stringliteral">&quot;Invalid graph category&quot;</span>);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(std::is_same_v&lt;typename Graph::graph_category, undirected_tag&gt;) {</div>
@@ -105,25 +113,25 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> &amp;&amp;vertex: graph.vertices()) {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> out &lt;&lt; vertex &lt;&lt; <span class="stringliteral">&quot;[&quot;</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">writer</a>(out, vertex);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> writer(out, vertex);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> out &lt;&lt; <span class="stringliteral">&quot;];&quot;</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> [<a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">lhs</a>, <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">rhs</a>]: graph.edges()) {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> [lhs, rhs]: graph.edges()) {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(std::is_same_v&lt;typename Graph::graph_category, undirected_tag&gt;) {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> out &lt;&lt; <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">lhs</a> &lt;&lt; <span class="stringliteral">&quot;--&quot;</span> &lt;&lt; <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">rhs</a> &lt;&lt; <span class="stringliteral">&quot;;&quot;</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> out &lt;&lt; lhs &lt;&lt; <span class="stringliteral">&quot;--&quot;</span> &lt;&lt; rhs &lt;&lt; <span class="stringliteral">&quot;;&quot;</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> out &lt;&lt; <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">lhs</a> &lt;&lt; <span class="stringliteral">&quot;-&gt;&quot;</span> &lt;&lt; <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">rhs</a> &lt;&lt; <span class="stringliteral">&quot;;&quot;</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> out &lt;&lt; lhs &lt;&lt; <span class="stringliteral">&quot;-&gt;&quot;</span> &lt;&lt; rhs &lt;&lt; <span class="stringliteral">&quot;;&quot;</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> out &lt;&lt; <span class="stringliteral">&quot;}&quot;</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>}</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Graph&gt;</div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="}">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespaceentt.html#a725644b580d804e01ac6f65a927469fd"> 52</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">dot</a>(std::ostream &amp;out, <span class="keyword">const</span> <a class="code hl_function" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Graph</a> &amp;graph) {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespaceentt.html#a725644b580d804e01ac6f65a927469fd"> 52</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">dot</a>(std::ostream &amp;out, <span class="keyword">const</span> Graph &amp;graph) {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">dot</a>(out, graph, [](<span class="keyword">auto</span> &amp;&amp;...) {});</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>}</div>
</div>
@@ -132,12 +140,12 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition</b> <a href="dense__map_8hpp_source.html#l00022">dense_map.hpp:22</a></div></div>
<div class="ttc" id="anamespaceentt_html_a12e4d0c58f9c4cc6f5513c39c530b9b7"><div class="ttname"><a href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">entt::make_obj_using_allocator</a></div><div class="ttdeci">constexpr Type make_obj_using_allocator(const Allocator &amp;allocator, Args &amp;&amp;...args)</div><div class="ttdoc">Uses-allocator construction utility (waiting for C++20).</div><div class="ttdef"><b>Definition</b> <a href="memory_8hpp_source.html#l00219">memory.hpp:219</a></div></div>
<div class="ttc" id="anamespaceentt_html_a8eb14d05375b98c803a4f335b9db15e4"><div class="ttname"><a href="namespaceentt.html#a8eb14d05375b98c803a4f335b9db15e4">entt::dot</a></div><div class="ttdeci">void dot(std::ostream &amp;out, const Graph &amp;graph, Writer writer)</div><div class="ttdoc">Outputs a graph in dot format.</div><div class="ttdef"><b>Definition</b> <a href="#l00019">dot.hpp:19</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>