OpenShaderDesigner/Documentation/html/struct_open_shader_designer_1_1_pin.html
Maddie Slockbower 366774622b Implemented Shader Function
- Updated License to GPL v3.0
- Added New Math Nodes
- Prototype Rendering Code for Debugging Functions
2024-11-03 12:57:12 -05:00

273 lines
15 KiB
HTML

<!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::Pin Struct 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="struct_open_shader_designer_1_1_pin.html">Pin</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-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="struct_open_shader_designer_1_1_pin-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">OpenShaderDesigner::Pin Struct 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:a28a00315bb89ff12a3d58850554b8cbe" id="r_a28a00315bb89ff12a3d58850554b8cbe"><td class="memItemLeft" align="right" valign="top"><a id="a28a00315bb89ff12a3d58850554b8cbe" name="a28a00315bb89ff12a3d58850554b8cbe"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Ambiguous</b> = ocu::any&lt;glm::int32, glm::uint32, glm::float32, glm::vec3&gt;</td></tr>
<tr class="separator:a28a00315bb89ff12a3d58850554b8cbe"><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:a62cef8615821611c0c329887a1ba1540" id="r_a62cef8615821611c0c329887a1ba1540"><td class="memItemLeft" align="right" valign="top"><a id="a62cef8615821611c0c329887a1ba1540" name="a62cef8615821611c0c329887a1ba1540"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Pin</b> (const std::string &amp;name, PinType type, FlagT flags=PinFlags_None)</td></tr>
<tr class="separator:a62cef8615821611c0c329887a1ba1540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a005a73845429eb5251a0d5df6710d415" id="r_a005a73845429eb5251a0d5df6710d415"><td class="memItemLeft" align="right" valign="top"><a id="a005a73845429eb5251a0d5df6710d415" name="a005a73845429eb5251a0d5df6710d415"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetVarName</b> () const</td></tr>
<tr class="separator:a005a73845429eb5251a0d5df6710d415"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8e42a1b60833cb40d71e5ae833cd4673" id="r_a8e42a1b60833cb40d71e5ae833cd4673"><td class="memItemLeft" align="right" valign="top"><a id="a8e42a1b60833cb40d71e5ae833cd4673" name="a8e42a1b60833cb40d71e5ae833cd4673"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>Name</b></td></tr>
<tr class="separator:a8e42a1b60833cb40d71e5ae833cd4673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0d09ac1168526f8f3a77c4ed180ef46" id="r_af0d09ac1168526f8f3a77c4ed180ef46"><td class="memItemLeft" align="right" valign="top"><a id="af0d09ac1168526f8f3a77c4ed180ef46" name="af0d09ac1168526f8f3a77c4ed180ef46"></a>
PinType&#160;</td><td class="memItemRight" valign="bottom"><b>Type</b></td></tr>
<tr class="separator:af0d09ac1168526f8f3a77c4ed180ef46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44ada8d63ee802839f61178ddefd8846" id="r_a44ada8d63ee802839f61178ddefd8846"><td class="memItemLeft" align="right" valign="top"><a id="a44ada8d63ee802839f61178ddefd8846" name="a44ada8d63ee802839f61178ddefd8846"></a>
FlagT&#160;</td><td class="memItemRight" valign="bottom"><b>Flags</b></td></tr>
<tr class="separator:a44ada8d63ee802839f61178ddefd8846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ee8f91d4602bdc1a2c0a66def8a6cd3" id="r_a1ee8f91d4602bdc1a2c0a66def8a6cd3"><td class="memItemLeft" align="right" valign="top"><a id="a1ee8f91d4602bdc1a2c0a66def8a6cd3" name="a1ee8f91d4602bdc1a2c0a66def8a6cd3"></a>
Ambiguous&#160;</td><td class="memItemRight" valign="bottom"><b>Value</b></td></tr>
<tr class="separator:a1ee8f91d4602bdc1a2c0a66def8a6cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7420afe120f244c26a15c04f46ce6b" id="r_a6c7420afe120f244c26a15c04f46ce6b"><td class="memItemLeft" align="right" valign="top"><a id="a6c7420afe120f244c26a15c04f46ce6b" name="a6c7420afe120f244c26a15c04f46ce6b"></a>
ImPinPtr&#160;</td><td class="memItemRight" valign="bottom"><b>Ptr</b></td></tr>
<tr class="separator:a6c7420afe120f244c26a15c04f46ce6b"><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:a25812619637a35ac0b1f388eda45ea07" id="r_a25812619637a35ac0b1f388eda45ea07"><td class="memItemLeft" align="right" valign="top">static const ImColor&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25812619637a35ac0b1f388eda45ea07">Colors</a> [PinType_COUNT]</td></tr>
<tr class="separator:a25812619637a35ac0b1f388eda45ea07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c95358bb98465ab9d5a0afefe5d06be" id="r_a5c95358bb98465ab9d5a0afefe5d06be"><td class="memItemLeft" align="right" valign="top">static constexpr const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c95358bb98465ab9d5a0afefe5d06be">TypeNames</a> [PinType_COUNT]</td></tr>
<tr class="separator:a5c95358bb98465ab9d5a0afefe5d06be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a2728ad0f1a62d01a9322701c63ec95" id="r_a2a2728ad0f1a62d01a9322701c63ec95"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a2728ad0f1a62d01a9322701c63ec95">TypeKeywords</a> [PinType_COUNT]</td></tr>
<tr class="separator:a2a2728ad0f1a62d01a9322701c63ec95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c43cd506f74e269cedec662f97bc430" id="r_a0c43cd506f74e269cedec662f97bc430"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c43cd506f74e269cedec662f97bc430">TypeWidths</a> [PinType_COUNT]</td></tr>
<tr class="separator:a0c43cd506f74e269cedec662f97bc430"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a25812619637a35ac0b1f388eda45ea07" name="a25812619637a35ac0b1f388eda45ea07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25812619637a35ac0b1f388eda45ea07">&#9670;&#160;</a></span>Colors</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const ImColor OpenShaderDesigner::Pin::Colors[PinType_COUNT]</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"> ImColor(0x7A, 0x9F, 0x82) </div>
<div class="line"> , ImColor(0x64, 0x94, 0xAA) </div>
<div class="line"> , ImColor(0xA6, 0x3D, 0x40) </div>
<div class="line"> , ImColor(0xE9, 0xB8, 0x72) </div>
<div class="line"> , ImColor(0xFF, 0xFF, 0xFF) </div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a2a2728ad0f1a62d01a9322701c63ec95" name="a2a2728ad0f1a62d01a9322701c63ec95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a2728ad0f1a62d01a9322701c63ec95">&#9670;&#160;</a></span>TypeKeywords</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::Pin::TypeKeywords[PinType_COUNT]</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"> <span class="stringliteral">&quot;uint&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;int&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;float&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;vec3&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;vec3&quot;</span></div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a5c95358bb98465ab9d5a0afefe5d06be" name="a5c95358bb98465ab9d5a0afefe5d06be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c95358bb98465ab9d5a0afefe5d06be">&#9670;&#160;</a></span>TypeNames</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* OpenShaderDesigner::Pin::TypeNames[PinType_COUNT]</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">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> <span class="stringliteral">&quot;Unsigned Int&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;Int&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;Float&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;Vector&quot;</span></div>
<div class="line"> , <span class="stringliteral">&quot;Any&quot;</span></div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a0c43cd506f74e269cedec662f97bc430" name="a0c43cd506f74e269cedec662f97bc430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c43cd506f74e269cedec662f97bc430">&#9670;&#160;</a></span>TypeWidths</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int OpenShaderDesigner::Pin::TypeWidths[PinType_COUNT]</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"> 1 </div>
<div class="line"> , 1 </div>
<div class="line"> , 1 </div>
<div class="line"> , 3 </div>
<div class="line"> , -1 </div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>Include/Graph/<a class="el" href="_shader_graph_8h_source.html">ShaderGraph.h</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.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>