khaotic-engine-Reborn/doxygen_docs/html/classshadow__map.html

338 lines
20 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Khaotic Engine Reborn: shadow_map 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('classshadow__map.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="classshadow__map-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">shadow_map 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:a70598e55170dc47ed6211b6489e5f7b3" id="r_a70598e55170dc47ed6211b6489e5f7b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a70598e55170dc47ed6211b6489e5f7b3">initialize</a> (ID3D11Device *device, int width, int height)</td></tr>
<tr class="separator:a70598e55170dc47ed6211b6489e5f7b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64fc63bc674b3607e981f9a47e449a5f" id="r_a64fc63bc674b3607e981f9a47e449a5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a64fc63bc674b3607e981f9a47e449a5f">shutdown</a> ()</td></tr>
<tr class="separator:a64fc63bc674b3607e981f9a47e449a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac092812f75c16425a539f1fba8179068" id="r_ac092812f75c16425a539f1fba8179068"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac092812f75c16425a539f1fba8179068">set_render_target</a> (ID3D11DeviceContext *context)</td></tr>
<tr class="separator:ac092812f75c16425a539f1fba8179068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae74e5a1d80329c224d676be66759b548" id="r_ae74e5a1d80329c224d676be66759b548"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae74e5a1d80329c224d676be66759b548">clear_render_target</a> (ID3D11DeviceContext *context, float depth=1.0f)</td></tr>
<tr class="separator:ae74e5a1d80329c224d676be66759b548"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeec73d92281b68e7fe574d879a2865b" id="r_abeec73d92281b68e7fe574d879a2865b"><td class="memItemLeft" align="right" valign="top">ID3D11ShaderResourceView *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abeec73d92281b68e7fe574d879a2865b">get_shader_resource_view</a> ()</td></tr>
<tr class="separator:abeec73d92281b68e7fe574d879a2865b"><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="shadow__map_8h_source.html#l00005">5</a> of file <a class="el" href="shadow__map_8h_source.html">shadow_map.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a93b19346b89b5350a0b39fe847bce685" name="a93b19346b89b5350a0b39fe847bce685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93b19346b89b5350a0b39fe847bce685">&#9670;&#160;</a></span>shadow_map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shadow_map::shadow_map </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="shadow__map_8cpp_source.html#l00003">3</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 4</span> : depth_texture_(<span class="keyword">nullptr</span>), depth_stencil_view_(<span class="keyword">nullptr</span>), shader_resource_view_(<span class="keyword">nullptr</span>), width_(0), height_(0) {}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a9c8d36c02b804c8867ec9ed35ba090ff" name="a9c8d36c02b804c8867ec9ed35ba090ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c8d36c02b804c8867ec9ed35ba090ff">&#9670;&#160;</a></span>~shadow_map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shadow_map::~shadow_map </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="shadow__map_8cpp_source.html#l00006">6</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 6</span> {</div>
<div class="line"><span class="lineno"> 7</span> shutdown();</div>
<div class="line"><span class="lineno"> 8</span>}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae74e5a1d80329c224d676be66759b548" name="ae74e5a1d80329c224d676be66759b548"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae74e5a1d80329c224d676be66759b548">&#9670;&#160;</a></span>clear_render_target()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shadow_map::clear_render_target </td>
<td>(</td>
<td class="paramtype">ID3D11DeviceContext *</td> <td class="paramname"><span class="paramname"><em>context</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>depth</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1.0f</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="shadow__map_8cpp_source.html#l00056">56</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 56</span> {</div>
<div class="line"><span class="lineno"> 57</span> context-&gt;ClearDepthStencilView(depth_stencil_view_, D3D11_CLEAR_DEPTH, depth, 0);</div>
<div class="line"><span class="lineno"> 58</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="abeec73d92281b68e7fe574d879a2865b" name="abeec73d92281b68e7fe574d879a2865b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeec73d92281b68e7fe574d879a2865b">&#9670;&#160;</a></span>get_shader_resource_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ID3D11ShaderResourceView * shadow_map::get_shader_resource_view </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="shadow__map_8cpp_source.html#l00060">60</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 60</span> {</div>
<div class="line"><span class="lineno"> 61</span> <span class="keywordflow">return</span> shader_resource_view_;</div>
<div class="line"><span class="lineno"> 62</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a70598e55170dc47ed6211b6489e5f7b3" name="a70598e55170dc47ed6211b6489e5f7b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70598e55170dc47ed6211b6489e5f7b3">&#9670;&#160;</a></span>initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shadow_map::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">int</td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>height</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="shadow__map_8cpp_source.html#l00010">10</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 10</span> {</div>
<div class="line"><span class="lineno"> 11</span> width_ = width;</div>
<div class="line"><span class="lineno"> 12</span> height_ = height;</div>
<div class="line"><span class="lineno"> 13</span> </div>
<div class="line"><span class="lineno"> 14</span> D3D11_TEXTURE2D_DESC texDesc = {};</div>
<div class="line"><span class="lineno"> 15</span> texDesc.Width = width;</div>
<div class="line"><span class="lineno"> 16</span> texDesc.Height = height;</div>
<div class="line"><span class="lineno"> 17</span> texDesc.MipLevels = 1;</div>
<div class="line"><span class="lineno"> 18</span> texDesc.ArraySize = 1;</div>
<div class="line"><span class="lineno"> 19</span> texDesc.Format = DXGI_FORMAT_R24G8_TYPELESS;</div>
<div class="line"><span class="lineno"> 20</span> texDesc.SampleDesc.Count = 1;</div>
<div class="line"><span class="lineno"> 21</span> texDesc.Usage = D3D11_USAGE_DEFAULT;</div>
<div class="line"><span class="lineno"> 22</span> texDesc.BindFlags = D3D11_BIND_DEPTH_STENCIL | D3D11_BIND_SHADER_RESOURCE;</div>
<div class="line"><span class="lineno"> 23</span> </div>
<div class="line"><span class="lineno"> 24</span> <span class="keywordflow">if</span> (FAILED(device-&gt;CreateTexture2D(&amp;texDesc, <span class="keyword">nullptr</span>, &amp;depth_texture_)))</div>
<div class="line"><span class="lineno"> 25</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 26</span> </div>
<div class="line"><span class="lineno"> 27</span> D3D11_DEPTH_STENCIL_VIEW_DESC dsvDesc = {};</div>
<div class="line"><span class="lineno"> 28</span> dsvDesc.Format = DXGI_FORMAT_D24_UNORM_S8_UINT;</div>
<div class="line"><span class="lineno"> 29</span> dsvDesc.ViewDimension = D3D11_DSV_DIMENSION_TEXTURE2D;</div>
<div class="line"><span class="lineno"> 30</span> dsvDesc.Texture2D.MipSlice = 0;</div>
<div class="line"><span class="lineno"> 31</span> </div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordflow">if</span> (FAILED(device-&gt;CreateDepthStencilView(depth_texture_, &amp;dsvDesc, &amp;depth_stencil_view_)))</div>
<div class="line"><span class="lineno"> 33</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 34</span> </div>
<div class="line"><span class="lineno"> 35</span> D3D11_SHADER_RESOURCE_VIEW_DESC srvDesc = {};</div>
<div class="line"><span class="lineno"> 36</span> srvDesc.Format = DXGI_FORMAT_R24_UNORM_X8_TYPELESS;</div>
<div class="line"><span class="lineno"> 37</span> srvDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D;</div>
<div class="line"><span class="lineno"> 38</span> srvDesc.Texture2D.MipLevels = 1;</div>
<div class="line"><span class="lineno"> 39</span> </div>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">if</span> (FAILED(device-&gt;CreateShaderResourceView(depth_texture_, &amp;srvDesc, &amp;shader_resource_view_)))</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 42</span> </div>
<div class="line"><span class="lineno"> 43</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 44</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ac092812f75c16425a539f1fba8179068" name="ac092812f75c16425a539f1fba8179068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac092812f75c16425a539f1fba8179068">&#9670;&#160;</a></span>set_render_target()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shadow_map::set_render_target </td>
<td>(</td>
<td class="paramtype">ID3D11DeviceContext *</td> <td class="paramname"><span class="paramname"><em>context</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="shadow__map_8cpp_source.html#l00052">52</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 52</span> {</div>
<div class="line"><span class="lineno"> 53</span> context-&gt;OMSetRenderTargets(0, <span class="keyword">nullptr</span>, depth_stencil_view_);</div>
<div class="line"><span class="lineno"> 54</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a64fc63bc674b3607e981f9a47e449a5f" name="a64fc63bc674b3607e981f9a47e449a5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64fc63bc674b3607e981f9a47e449a5f">&#9670;&#160;</a></span>shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shadow_map::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="shadow__map_8cpp_source.html#l00046">46</a> of file <a class="el" href="shadow__map_8cpp_source.html">shadow_map.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 46</span> {</div>
<div class="line"><span class="lineno"> 47</span> <span class="keywordflow">if</span> (shader_resource_view_) { shader_resource_view_-&gt;Release(); shader_resource_view_ = <span class="keyword">nullptr</span>; }</div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordflow">if</span> (depth_stencil_view_) { depth_stencil_view_-&gt;Release(); depth_stencil_view_ = <span class="keyword">nullptr</span>; }</div>
<div class="line"><span class="lineno"> 49</span> <span class="keywordflow">if</span> (depth_texture_) { depth_texture_-&gt;Release(); depth_texture_ = <span class="keyword">nullptr</span>; }</div>
<div class="line"><span class="lineno"> 50</span>}</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>enginecustom/src/inc/system/<a class="el" href="shadow__map_8h_source.html">shadow_map.h</a></li>
<li>enginecustom/src/src/system/<a class="el" href="shadow__map_8cpp_source.html">shadow_map.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="classshadow__map.html">shadow_map</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>