mslockbo/OpenShaderDesigner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
OpenShaderDesigner/Documentation/html/class_open_shader_designer_1_1_console.html

361 lines
20 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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenShaderDesigner: OpenShaderDesigner::Console Class 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>
<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>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.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">OpenShaderDesigner<span id="projectnumber">&#160;0.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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"><b>OpenShaderDesigner</b></li><li class="navelem"><a class="el" href="class_open_shader_designer_1_1_console.html">Console</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_open_shader_designer_1_1_console-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">OpenShaderDesigner::Console Class Reference</div></div>
</div><!--header-->
<div class="contents">
<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:a4da63ca14b9e8f7a582df081623b6406" id="r_a4da63ca14b9e8f7a582df081623b6406"><td class="memItemLeft" align="right" valign="top"><a id="a4da63ca14b9e8f7a582df081623b6406" name="a4da63ca14b9e8f7a582df081623b6406"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4da63ca14b9e8f7a582df081623b6406">Setting</a> : uint8_t { <br />
&#160;&#160;<b>SHOW_TIMESTAMP</b> = 0b00000001
, <b>SHOW_THREAD</b> = 0b00000010
, <b>SHOW_SEVERITY</b> = 0b00000100
, <b>SHOW_FILE_INFO</b> = 0b00001000
, <br />
&#160;&#160;<b>WRAP_TEXT</b> = 0b00010000
, <b>ALL_SETTINGS</b> = 0xFF
, <b>DEFAULT_SETTINGS</b> = ALL_SETTINGS ^ WRAP_TEXT
<br />
}</td></tr>
<tr class="memdesc:a4da63ca14b9e8f7a582df081623b6406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting for displaying log entries. <br /></td></tr>
<tr class="separator:a4da63ca14b9e8f7a582df081623b6406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a880eae5d076afe686248bbb0f6a83771" id="r_a880eae5d076afe686248bbb0f6a83771"><td class="memItemLeft" align="right" valign="top"><a id="a880eae5d076afe686248bbb0f6a83771" name="a880eae5d076afe686248bbb0f6a83771"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a880eae5d076afe686248bbb0f6a83771">Severity</a> : int { <br />
&#160;&#160;<b>MESSAGE</b> = 0
, <b>WARNING</b>
, <b>ERROR</b>
, <b>FATAL</b>
, <br />
&#160;&#160;<b>ALERT</b>
, <b>COMMAND</b>
, <b>COUNT</b>
, <b>DEFAULT</b> = WARNING
<br />
}</td></tr>
<tr class="memdesc:a880eae5d076afe686248bbb0f6a83771"><td class="mdescLeft">&#160;</td><td class="mdescRight">Severity levels for log entries. <br /></td></tr>
<tr class="separator:a880eae5d076afe686248bbb0f6a83771"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abc25e7d9ad33fdcc95fe11df9a9c3fc4" id="r_abc25e7d9ad33fdcc95fe11df9a9c3fc4"><td class="memItemLeft" align="right" valign="top">static constexpr ImVec4&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a> (unsigned int RGB)</td></tr>
<tr class="memdesc:abc25e7d9ad33fdcc95fe11df9a9c3fc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Integer to floating point color. (ImGui APIVersion) <br /></td></tr>
<tr class="separator:abc25e7d9ad33fdcc95fe11df9a9c3fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41b89c645164fc524c58b5ee5cc1e8fa" id="r_a41b89c645164fc524c58b5ee5cc1e8fa"><td class="memItemLeft" align="right" valign="top"><a id="a41b89c645164fc524c58b5ee5cc1e8fa" name="a41b89c645164fc524c58b5ee5cc1e8fa"></a>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>ThreadID</b> ()</td></tr>
<tr class="separator:a41b89c645164fc524c58b5ee5cc1e8fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b0e458b796c898279bcb8fedf960920" id="r_a4b0e458b796c898279bcb8fedf960920"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a4b0e458b796c898279bcb8fedf960920"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4b0e458b796c898279bcb8fedf960920">Log</a> (const std::string &amp;file, const int line, <a class="el" href="#a880eae5d076afe686248bbb0f6a83771">Severity</a> severity=Severity::DEFAULT, const std::format_string&lt; Args... &gt; &amp;message=&quot;&quot;, Args &amp;&amp;... vargs)</td></tr>
<tr class="memdesc:a4b0e458b796c898279bcb8fedf960920"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread-Safe Log function for debugging. <br /></td></tr>
<tr class="separator:a4b0e458b796c898279bcb8fedf960920"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e13a7bd1fb502c9864f3c0454203b2" id="r_ac4e13a7bd1fb502c9864f3c0454203b2"><td class="memItemLeft" align="right" valign="top"><a id="ac4e13a7bd1fb502c9864f3c0454203b2" name="ac4e13a7bd1fb502c9864f3c0454203b2"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>DrawMenu</b> ()</td></tr>
<tr class="separator:ac4e13a7bd1fb502c9864f3c0454203b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acff1d4f443320977d132b2f32bc225eb" id="r_acff1d4f443320977d132b2f32bc225eb"><td class="memItemLeft" align="right" valign="top"><a id="acff1d4f443320977d132b2f32bc225eb" name="acff1d4f443320977d132b2f32bc225eb"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>DrawWindow</b> ()</td></tr>
<tr class="separator:acff1d4f443320977d132b2f32bc225eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a858d18576b3e7e542d4723316ae71e21" id="r_a858d18576b3e7e542d4723316ae71e21"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a858d18576b3e7e542d4723316ae71e21">SettingNames</a> []</td></tr>
<tr class="memdesc:a858d18576b3e7e542d4723316ae71e21"><td class="mdescLeft">&#160;</td><td class="mdescRight">String representations of the settings. <br /></td></tr>
<tr class="separator:a858d18576b3e7e542d4723316ae71e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abac05fdca9513434894c10df2473d8b9" id="r_abac05fdca9513434894c10df2473d8b9"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abac05fdca9513434894c10df2473d8b9">Severities</a> []</td></tr>
<tr class="memdesc:abac05fdca9513434894c10df2473d8b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">String representations of the Severity levels. <br /></td></tr>
<tr class="separator:abac05fdca9513434894c10df2473d8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a476dcb9b07e3ad0d54e08775118b35" id="r_a1a476dcb9b07e3ad0d54e08775118b35"><td class="memItemLeft" align="right" valign="top">static const ImVec4&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a476dcb9b07e3ad0d54e08775118b35">SeverityColors</a> []</td></tr>
<tr class="memdesc:a1a476dcb9b07e3ad0d54e08775118b35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color for rendering each Severity level text in editor. <br /></td></tr>
<tr class="separator:a1a476dcb9b07e3ad0d54e08775118b35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58a540e350481dfc6c79b2b7f85242de" id="r_a58a540e350481dfc6c79b2b7f85242de"><td class="memItemLeft" align="right" valign="top"><a id="a58a540e350481dfc6c79b2b7f85242de" name="a58a540e350481dfc6c79b2b7f85242de"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>Open</b> = true</td></tr>
<tr class="separator:a58a540e350481dfc6c79b2b7f85242de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abc25e7d9ad33fdcc95fe11df9a9c3fc4" name="abc25e7d9ad33fdcc95fe11df9a9c3fc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">&#9670;&#160;</a></span>ImGuiColor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr ImVec4 OpenShaderDesigner::Console::ImGuiColor </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>RGB</em></span></td><td>)</td>
<td></td>
</tr>
</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>
</tr>
</table>
</div><div class="memdoc">
<p>Integer to floating point color. (ImGui APIVersion) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RGB</td><td>The Integer color to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The rgba floating point color. </dd></dl>
</div>
</div>
<a id="a4b0e458b796c898279bcb8fedf960920" name="a4b0e458b796c898279bcb8fedf960920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b0e458b796c898279bcb8fedf960920">&#9670;&#160;</a></span>Log()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenShaderDesigner::Console::Log </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>file</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>line</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a880eae5d076afe686248bbb0f6a83771">Severity</a></td> <td class="paramname"><span class="paramname"><em>severity</em></span><span class="paramdefsep"> = </span><span class="paramdefval">Severity::DEFAULT</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::format_string&lt; Args... &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>message</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&quot;&quot;</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args &amp;&amp;...</td> <td class="paramname"><span class="paramname"><em>vargs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Thread-Safe Log function for debugging. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>Variadic Arguments template for PixelLayout Parameters </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The name of the file this was called from. </td></tr>
<tr><td class="paramname">line</td><td>The line number this was called from. </td></tr>
<tr><td class="paramname">severity</td><td>The severity level of the log entry. </td></tr>
<tr><td class="paramname">message</td><td>A format string for the entry message. </td></tr>
<tr><td class="paramname">vargs</td><td>Arguments for the format string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a858d18576b3e7e542d4723316ae71e21" name="a858d18576b3e7e542d4723316ae71e21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a858d18576b3e7e542d4723316ae71e21">&#9670;&#160;</a></span>SettingNames</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string OpenShaderDesigner::Console::SettingNames[]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> {</div>
<div class="line"> <span class="stringliteral">&quot;Timestamps&quot;</span>, <span class="stringliteral">&quot;Thread IDs&quot;</span>, <span class="stringliteral">&quot;Severity&quot;</span>, <span class="stringliteral">&quot;File Info&quot;</span>, <span class="stringliteral">&quot;Wrapping&quot;</span></div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>String representations of the settings. </p>
</div>
</div>
<a id="abac05fdca9513434894c10df2473d8b9" name="abac05fdca9513434894c10df2473d8b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abac05fdca9513434894c10df2473d8b9">&#9670;&#160;</a></span>Severities</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string OpenShaderDesigner::Console::Severities[]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> {</div>
<div class="line"> <span class="stringliteral">&quot;Message&quot;</span>, <span class="stringliteral">&quot;Warning&quot;</span>, <span class="stringliteral">&quot;Error&quot;</span>, <span class="stringliteral">&quot;Fatal&quot;</span>, <span class="stringliteral">&quot;Alert&quot;</span>, <span class="stringliteral">&quot;Command&quot;</span></div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>String representations of the Severity levels. </p>
</div>
</div>
<a id="a1a476dcb9b07e3ad0d54e08775118b35" name="a1a476dcb9b07e3ad0d54e08775118b35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a476dcb9b07e3ad0d54e08775118b35">&#9670;&#160;</a></span>SeverityColors</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ImVec4 OpenShaderDesigner::Console::SeverityColors[]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> <a class="code hl_function" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a>(0xA4B9C4FF), <a class="code hl_function" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a>(0xF2C554FF), <a class="code hl_function" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a>(0xE57327FF), <a class="code hl_function" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a>(0xCC211EFF),</div>
<div class="line"> <a class="code hl_function" href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">ImGuiColor</a>(0x9CDCFEFF),</div>
<div class="line"> }</div>
<div class="ttc" id="aclass_open_shader_designer_1_1_console_html_abc25e7d9ad33fdcc95fe11df9a9c3fc4"><div class="ttname"><a href="#abc25e7d9ad33fdcc95fe11df9a9c3fc4">OpenShaderDesigner::Console::ImGuiColor</a></div><div class="ttdeci">static constexpr ImVec4 ImGuiColor(unsigned int RGB)</div><div class="ttdoc">Integer to floating point color. (ImGui APIVersion)</div><div class="ttdef"><b>Definition</b> Console.h:86</div></div>
</div><!-- fragment -->
<p>Color for rendering each Severity level text in editor. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Include/Core/<a class="el" href="_console_8h_source.html">Console.h</a></li>
<li>Source/Core/<b>Console.cpp</b></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.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink