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/classdisplay__plane__class.html

321 lines
18 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: display_plane_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('classdisplay__plane__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="classdisplay__plane__class-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">display_plane_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:ad7a6b3fa5bd4fc1f43c8fe2dd97705c4" id="r_ad7a6b3fa5bd4fc1f43c8fe2dd97705c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7a6b3fa5bd4fc1f43c8fe2dd97705c4">display_plane_class</a> (const <a class="el" href="classdisplay__plane__class.html">display_plane_class</a> &amp;)</td></tr>
<tr class="separator:ad7a6b3fa5bd4fc1f43c8fe2dd97705c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab01495127063d2a63b9459dc84c5127d" id="r_ab01495127063d2a63b9459dc84c5127d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab01495127063d2a63b9459dc84c5127d">Initialize</a> (ID3D11Device *, float, float)</td></tr>
<tr class="separator:ab01495127063d2a63b9459dc84c5127d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b860200e1b54dd39dac5f94efc06517" id="r_a1b860200e1b54dd39dac5f94efc06517"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b860200e1b54dd39dac5f94efc06517">Shutdown</a> ()</td></tr>
<tr class="separator:a1b860200e1b54dd39dac5f94efc06517"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1adcd3f517c41a647a497e2e21743c8" id="r_aa1adcd3f517c41a647a497e2e21743c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1adcd3f517c41a647a497e2e21743c8">Render</a> (ID3D11DeviceContext *)</td></tr>
<tr class="separator:aa1adcd3f517c41a647a497e2e21743c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae48f5166d28bf63827f25c619955bd49" id="r_ae48f5166d28bf63827f25c619955bd49"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae48f5166d28bf63827f25c619955bd49">GetIndexCount</a> ()</td></tr>
<tr class="separator:ae48f5166d28bf63827f25c619955bd49"><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="display__plane__class_8h_source.html#l00014">14</a> of file <a class="el" href="display__plane__class_8h_source.html">display_plane_class.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae98df4247851ffbd71e9c85cb2fc720e" name="ae98df4247851ffbd71e9c85cb2fc720e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae98df4247851ffbd71e9c85cb2fc720e">&#9670;&#160;</a></span>display_plane_class() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">display_plane_class::display_plane_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="display__plane__class_8cpp_source.html#l00004">4</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 5</span>{</div>
<div class="line"><span class="lineno"> 6</span> m_vertexBuffer = 0;</div>
<div class="line"><span class="lineno"> 7</span> m_indexBuffer = 0;</div>
<div class="line"><span class="lineno"> 8</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ad7a6b3fa5bd4fc1f43c8fe2dd97705c4" name="ad7a6b3fa5bd4fc1f43c8fe2dd97705c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7a6b3fa5bd4fc1f43c8fe2dd97705c4">&#9670;&#160;</a></span>display_plane_class() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">display_plane_class::display_plane_class </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdisplay__plane__class.html">display_plane_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="display__plane__class_8cpp_source.html#l00011">11</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 12</span>{</div>
<div class="line"><span class="lineno"> 13</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a1945d20d4d1455f0fc12220d54f9c615" name="a1945d20d4d1455f0fc12220d54f9c615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1945d20d4d1455f0fc12220d54f9c615">&#9670;&#160;</a></span>~display_plane_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">display_plane_class::~display_plane_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="display__plane__class_8cpp_source.html#l00016">16</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae48f5166d28bf63827f25c619955bd49" name="ae48f5166d28bf63827f25c619955bd49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae48f5166d28bf63827f25c619955bd49">&#9670;&#160;</a></span>GetIndexCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int display_plane_class::GetIndexCount </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="display__plane__class_8cpp_source.html#l00056">56</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 57</span>{</div>
<div class="line"><span class="lineno"> 58</span> <span class="keywordflow">return</span> m_indexCount;</div>
<div class="line"><span class="lineno"> 59</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ab01495127063d2a63b9459dc84c5127d" name="ab01495127063d2a63b9459dc84c5127d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab01495127063d2a63b9459dc84c5127d">&#9670;&#160;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool display_plane_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">float</td> <td class="paramname"><span class="paramname"><em>width</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</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="display__plane__class_8cpp_source.html#l00020">20</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 21</span>{</div>
<div class="line"><span class="lineno"> 22</span> <a class="code hl_function" href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a>().<a class="code hl_function" href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Log</a>(<span class="stringliteral">&quot;Initializing display_plane_class, width: &quot;</span> + std::to_string(width) + <span class="stringliteral">&quot;, height: &quot;</span> + std::to_string(height), __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 23</span> <span class="keywordtype">bool</span> result;</div>
<div class="line"><span class="lineno"> 24</span> </div>
<div class="line"><span class="lineno"> 25</span> </div>
<div class="line"><span class="lineno"> 26</span> <span class="comment">// initialize the vertex and index buffer that hold the geometry for the button.</span></div>
<div class="line"><span class="lineno"> 27</span> result = InitializeBuffers(device, width, height);</div>
<div class="line"><span class="lineno"> 28</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 29</span> {</div>
<div class="line"><span class="lineno"> 30</span> <a class="code hl_function" href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a>().<a class="code hl_function" href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Log</a>(<span class="stringliteral">&quot;Could not initialize buffers&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 31</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 32</span> }</div>
<div class="line"><span class="lineno"> 33</span> </div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 35</span>}</div>
<div class="ttc" id="aclass_logger_html_a08e3e1b899767a6d833136c9fb4f15c2"><div class="ttname"><a href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a></div><div class="ttdeci">static Logger &amp; Get()</div><div class="ttdef"><b>Definition</b> <a href="_logger_8h_source.html#l00020">Logger.h:20</a></div></div>
<div class="ttc" id="aclass_logger_html_a94f47ba0ef38ea7bcf1056f64d2645e4"><div class="ttname"><a href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Logger::Log</a></div><div class="ttdeci">void Log(const std::string &amp;message, const std::string &amp;fileName, int lineNumber, LogLevel level=LogLevel::Info)</div><div class="ttdef"><b>Definition</b> <a href="_logger_8h_source.html#l00158">Logger.h:158</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa1adcd3f517c41a647a497e2e21743c8" name="aa1adcd3f517c41a647a497e2e21743c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1adcd3f517c41a647a497e2e21743c8">&#9670;&#160;</a></span>Render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void display_plane_class::Render </td>
<td>(</td>
<td class="paramtype">ID3D11DeviceContext *</td> <td class="paramname"><span class="paramname"><em>deviceContext</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="display__plane__class_8cpp_source.html#l00047">47</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 48</span>{</div>
<div class="line"><span class="lineno"> 49</span> <span class="comment">// Put the vertex and index buffers on the graphics pipeline to prepare them for drawing.</span></div>
<div class="line"><span class="lineno"> 50</span> RenderBuffers(deviceContext);</div>
<div class="line"><span class="lineno"> 51</span> </div>
<div class="line"><span class="lineno"> 52</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 53</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a1b860200e1b54dd39dac5f94efc06517" name="a1b860200e1b54dd39dac5f94efc06517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b860200e1b54dd39dac5f94efc06517">&#9670;&#160;</a></span>Shutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void display_plane_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="display__plane__class_8cpp_source.html#l00038">38</a> of file <a class="el" href="display__plane__class_8cpp_source.html">display_plane_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 39</span>{</div>
<div class="line"><span class="lineno"> 40</span> <span class="comment">// Release the vertex and index buffers.</span></div>
<div class="line"><span class="lineno"> 41</span> ShutdownBuffers();</div>
<div class="line"><span class="lineno"> 42</span> </div>
<div class="line"><span class="lineno"> 43</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 44</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="display__plane__class_8h_source.html">display_plane_class.h</a></li>
<li>enginecustom/src/src/system/<a class="el" href="display__plane__class_8cpp_source.html">display_plane_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="classdisplay__plane__class.html">display_plane_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