ShibaGit/khaotic-engine-Reborn
ShibaGit/khaotic-engine-Reborn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity
khaotic-engine-Reborn/doxygen_docs/html/classwater__shader__class.html

369 lines
21 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Khaotic Engine Reborn: water_shader_class 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<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">Khaotic Engine Reborn
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classwater__shader__class.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwater__shader__class-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">water_shader_class Class Reference</div></div>
</div><!--header-->
<div class="contents">
<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:aadceaa26ea88e858bdc72fd4a51e8de7" id="r_aadceaa26ea88e858bdc72fd4a51e8de7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aadceaa26ea88e858bdc72fd4a51e8de7">water_shader_class</a> (const <a class="el" href="classwater__shader__class.html">water_shader_class</a> &amp;)</td></tr>
<tr class="separator:aadceaa26ea88e858bdc72fd4a51e8de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7491edf1640f32ac31c117d0efe30b82" id="r_a7491edf1640f32ac31c117d0efe30b82"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7491edf1640f32ac31c117d0efe30b82">initialize</a> (ID3D11Device *, HWND)</td></tr>
<tr class="separator:a7491edf1640f32ac31c117d0efe30b82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3b362e0053df8c65e71699e55becdb0" id="r_ac3b362e0053df8c65e71699e55becdb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac3b362e0053df8c65e71699e55becdb0">shutdown</a> ()</td></tr>
<tr class="separator:ac3b362e0053df8c65e71699e55becdb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c822889f0f0e915dbb70c6c3396486b" id="r_a0c822889f0f0e915dbb70c6c3396486b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c822889f0f0e915dbb70c6c3396486b">render</a> (ID3D11DeviceContext *, int, XMMATRIX, XMMATRIX, XMMATRIX, XMMATRIX, ID3D11ShaderResourceView *, ID3D11ShaderResourceView *, ID3D11ShaderResourceView *, float, float)</td></tr>
<tr class="separator:a0c822889f0f0e915dbb70c6c3396486b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8h_source.html#l00019">19</a> of file <a class="el" href="water__shader__class_8h_source.html">water_shader_class.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa9c59dfeded2d65d1070d0b8384e15c2" name="aa9c59dfeded2d65d1070d0b8384e15c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9c59dfeded2d65d1070d0b8384e15c2">&#9670;&#160;</a></span>water_shader_class() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">water_shader_class::water_shader_class </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00004">4</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 5</span>{</div>
<div class="line"><span class="lineno"> 6</span> vertex_shader_ = 0;</div>
<div class="line"><span class="lineno"> 7</span> pixel_shader_ = 0;</div>
<div class="line"><span class="lineno"> 8</span> layout_ = 0;</div>
<div class="line"><span class="lineno"> 9</span> sample_state_ = 0;</div>
<div class="line"><span class="lineno"> 10</span> matrix_buffer_ = 0;</div>
<div class="line"><span class="lineno"> 11</span> reflection_buffer_ = 0;</div>
<div class="line"><span class="lineno"> 12</span> water_buffer_ = 0;</div>
<div class="line"><span class="lineno"> 13</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="aadceaa26ea88e858bdc72fd4a51e8de7" name="aadceaa26ea88e858bdc72fd4a51e8de7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadceaa26ea88e858bdc72fd4a51e8de7">&#9670;&#160;</a></span>water_shader_class() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">water_shader_class::water_shader_class </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwater__shader__class.html">water_shader_class</a> &amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00016">16</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 17</span>{</div>
<div class="line"><span class="lineno"> 18</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a559784768a414295225e1113ce05b1a2" name="a559784768a414295225e1113ce05b1a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a559784768a414295225e1113ce05b1a2">&#9670;&#160;</a></span>~water_shader_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">water_shader_class::~water_shader_class </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00021">21</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 22</span>{</div>
<div class="line"><span class="lineno"> 23</span>}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7491edf1640f32ac31c117d0efe30b82" name="a7491edf1640f32ac31c117d0efe30b82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7491edf1640f32ac31c117d0efe30b82">&#9670;&#160;</a></span>initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool water_shader_class::initialize </td>
<td>(</td>
<td class="paramtype">ID3D11Device *</td> <td class="paramname"><span class="paramname"><em>device</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HWND</td> <td class="paramname"><span class="paramname"><em>hwnd</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00026">26</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 27</span>{</div>
<div class="line"><span class="lineno"> 28</span> <span class="keywordtype">bool</span> result;</div>
<div class="line"><span class="lineno"> 29</span> <span class="keywordtype">wchar_t</span> vsFilename[128];</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordtype">wchar_t</span> psFilename[128];</div>
<div class="line"><span class="lineno"> 31</span> <span class="keywordtype">int</span> error;</div>
<div class="line"><span class="lineno"> 32</span> </div>
<div class="line"><span class="lineno"> 33</span> <span class="comment">// Set the filename of the vertex shader.</span></div>
<div class="line"><span class="lineno"> 34</span> error = wcscpy_s(vsFilename, 128, L<span class="stringliteral">&quot;src/hlsl/water.vs&quot;</span>);</div>
<div class="line"><span class="lineno"> 35</span> <span class="keywordflow">if</span> (error != 0)</div>
<div class="line"><span class="lineno"> 36</span> {</div>
<div class="line"><span class="lineno"> 37</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 38</span> }</div>
<div class="line"><span class="lineno"> 39</span> </div>
<div class="line"><span class="lineno"> 40</span> <span class="comment">// Set the filename of the pixel shader.</span></div>
<div class="line"><span class="lineno"> 41</span> error = wcscpy_s(psFilename, 128, L<span class="stringliteral">&quot;src/hlsl/water.ps&quot;</span>);</div>
<div class="line"><span class="lineno"> 42</span> <span class="keywordflow">if</span> (error != 0)</div>
<div class="line"><span class="lineno"> 43</span> {</div>
<div class="line"><span class="lineno"> 44</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 45</span> }</div>
<div class="line"><span class="lineno"> 46</span> </div>
<div class="line"><span class="lineno"> 47</span> <span class="comment">// initialize the vertex and pixel shaders.</span></div>
<div class="line"><span class="lineno"> 48</span> result = initialize_shader(device, hwnd, vsFilename, psFilename);</div>
<div class="line"><span class="lineno"> 49</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 50</span> {</div>
<div class="line"><span class="lineno"> 51</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 52</span> }</div>
<div class="line"><span class="lineno"> 53</span> </div>
<div class="line"><span class="lineno"> 54</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 55</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a0c822889f0f0e915dbb70c6c3396486b" name="a0c822889f0f0e915dbb70c6c3396486b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c822889f0f0e915dbb70c6c3396486b">&#9670;&#160;</a></span>render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool water_shader_class::render </td>
<td>(</td>
<td class="paramtype">ID3D11DeviceContext *</td> <td class="paramname"><span class="paramname"><em>deviceContext</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>indexCount</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>worldMatrix</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>viewMatrix</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>projectionMatrix</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>reflectionMatrix</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ID3D11ShaderResourceView *</td> <td class="paramname"><span class="paramname"><em>reflectionTexture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ID3D11ShaderResourceView *</td> <td class="paramname"><span class="paramname"><em>refractionTexture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ID3D11ShaderResourceView *</td> <td class="paramname"><span class="paramname"><em>normalTexture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>waterTranslation</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>reflectRefractScale</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00066">66</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 69</span>{</div>
<div class="line"><span class="lineno"> 70</span> <span class="keywordtype">bool</span> result;</div>
<div class="line"><span class="lineno"> 71</span> </div>
<div class="line"><span class="lineno"> 72</span> </div>
<div class="line"><span class="lineno"> 73</span> <span class="comment">// Set the shader parameters that it will use for rendering.</span></div>
<div class="line"><span class="lineno"> 74</span> result = set_shader_parameters(deviceContext, worldMatrix, viewMatrix, projectionMatrix, reflectionMatrix, reflectionTexture,</div>
<div class="line"><span class="lineno"> 75</span> refractionTexture, normalTexture, waterTranslation, reflectRefractScale);</div>
<div class="line"><span class="lineno"> 76</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 77</span> {</div>
<div class="line"><span class="lineno"> 78</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 79</span> }</div>
<div class="line"><span class="lineno"> 80</span> </div>
<div class="line"><span class="lineno"> 81</span> <span class="comment">// Now render the prepared buffers with the shader.</span></div>
<div class="line"><span class="lineno"> 82</span> render_shader(deviceContext, indexCount);</div>
<div class="line"><span class="lineno"> 83</span> </div>
<div class="line"><span class="lineno"> 84</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 85</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ac3b362e0053df8c65e71699e55becdb0" name="ac3b362e0053df8c65e71699e55becdb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3b362e0053df8c65e71699e55becdb0">&#9670;&#160;</a></span>shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void water_shader_class::shutdown </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="water__shader__class_8cpp_source.html#l00058">58</a> of file <a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 59</span>{</div>
<div class="line"><span class="lineno"> 60</span> <span class="comment">// shutdown the vertex and pixel shaders as well as the related objects.</span></div>
<div class="line"><span class="lineno"> 61</span> shutdown_shader();</div>
<div class="line"><span class="lineno"> 62</span> </div>
<div class="line"><span class="lineno"> 63</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 64</span>}</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>enginecustom/src/inc/shader/<a class="el" href="water__shader__class_8h_source.html">water_shader_class.h</a></li>
<li>enginecustom/src/src/shader/<a class="el" href="water__shader__class_8cpp_source.html">water_shader_class.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classwater__shader__class.html">water_shader_class</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink