ShibaGit/khaotic-engine-Reborn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 13 Wiki Activity

Patch - Doc Update - V12.8.1

Browse Source
This commit is contained in:
CatChow0
2025-07-28 17:37:15 +02:00
parent 9431552316
commit ccd0d045f9
201 changed files with 9244 additions and 3316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
doxygen_docs/html/class_skybox.html
View File

@@ -106,6 +106,9 @@ $(function(){initNavTree('class_skybox.html',''); initResizable(true); });
<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:a77a92db4492ed94ed4bd101b05ffb1f4" id="r_a77a92db4492ed94ed4bd101b05ffb1f4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a77a92db4492ed94ed4bd101b05ffb1f4">Skybox</a> ()</td></tr>
<tr class="memdesc:a77a92db4492ed94ed4bd101b05ffb1f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="class_skybox.html">Skybox</a> class. Initializes the skybox with a reference to the <a class="el" href="classd__3d__class.html">d_3d_class</a> instance. <br /></td></tr>
<tr class="separator:a77a92db4492ed94ed4bd101b05ffb1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af048306ba3fc893e485393452e8af429" id="r_af048306ba3fc893e485393452e8af429"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af048306ba3fc893e485393452e8af429">Initialize</a> (<a class="el" href="classd__3d__class.html">d_3d_class</a> *d3dClassRef)</td></tr>
<tr class="separator:af048306ba3fc893e485393452e8af429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a583a0753edede891759ecb62cf82a86f" id="r_a583a0753edede891759ecb62cf82a86f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classobject.html">object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a583a0753edede891759ecb62cf82a86f">ConstructSkybox</a> (<a class="el" href="classapplication__class.html">application_class</a> *app)</td></tr>
@@ -137,6 +140,8 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_skybox.html">Skybox</a> class. Initializes the skybox with a reference to the <a class="el" href="classd__3d__class.html">d_3d_class</a> instance. </p>
<p class="definition">Definition at line <a class="el" href="_skybox_8cpp_source.html#l00003">3</a> of file <a class="el" href="_skybox_8cpp_source.html">Skybox.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 4</span>{</div>
<div class="line"><span class="lineno"> 5</span>}</div>
@@ -189,10 +194,17 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Create the skybox object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">app</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the created skybox object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_skybox_8cpp_source.html#l00026">26</a> of file <a class="el" href="_skybox_8cpp_source.html">Skybox.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 27</span>{</div>
<div class="line"><span class="lineno"> 28</span> Logger::Get().Log(<span class="stringliteral">&quot;Construct skybox&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 28</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;Construct skybox&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 29</span> </div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordtype">char</span> modelFilename[128];</div>
<div class="line"><span class="lineno"> 31</span> strcpy_s(modelFilename, <span class="stringliteral">&quot;assets/Model/OBJ/skysphere.obj&quot;</span>);</div>
@@ -207,10 +219,10 @@ Public Attributes</h2></td></tr>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; textureFilename : skyboxTextures)</div>
<div class="line"><span class="lineno"> 41</span> {</div>
<div class="line"><span class="lineno"> 42</span> ID3D11ShaderResourceView* texture = <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 43</span> HRESULT result = DirectX::CreateWICTextureFromFile(m_d3dClassRef-&gt;get_device(), m_d3dClassRef-&gt;get_device_context(), textureFilename.c_str(), <span class="keyword">nullptr</span>, &amp;texture);</div>
<div class="line"><span class="lineno"> 43</span> HRESULT result = DirectX::CreateWICTextureFromFile(m_d3dClassRef-&gt;<a class="code hl_function" href="classd__3d__class.html#a0979aea3c4bb6815908fbe188fc1c67e">get_device</a>(), m_d3dClassRef-&gt;<a class="code hl_function" href="classd__3d__class.html#a4ad87066c014351689f12981234beadb">get_device_context</a>(), textureFilename.c_str(), <span class="keyword">nullptr</span>, &amp;texture);</div>
<div class="line"><span class="lineno"> 44</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 45</span> {</div>
<div class="line"><span class="lineno"> 46</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to load texture: &quot;</span> + std::string(textureFilename.begin(), textureFilename.end()), __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 46</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;Failed to load texture: &quot;</span> + std::string(textureFilename.begin(), textureFilename.end()), __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 47</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 48</span> }</div>
<div class="line"><span class="lineno"> 49</span> SkyboxTextures.diffuse.push_back(texture);</div>
@@ -219,10 +231,10 @@ Public Attributes</h2></td></tr>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</span> <span class="comment">// Create the model object</span></div>
<div class="line"><span class="lineno"> 54</span> m_Skybox = <span class="keyword">new</span> <a class="code hl_class" href="classobject.html">object</a>(*app);</div>
<div class="line"><span class="lineno"> 55</span> HRESULT result = m_Skybox-&gt;Initialize(m_d3dClassRef-&gt;get_device(), m_d3dClassRef-&gt;get_device_context(), modelFilename, SkyboxTextures);</div>
<div class="line"><span class="lineno"> 55</span> HRESULT result = m_Skybox-&gt;Initialize(m_d3dClassRef-&gt;<a class="code hl_function" href="classd__3d__class.html#a0979aea3c4bb6815908fbe188fc1c67e">get_device</a>(), m_d3dClassRef-&gt;<a class="code hl_function" href="classd__3d__class.html#a4ad87066c014351689f12981234beadb">get_device_context</a>(), modelFilename, SkyboxTextures);</div>
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 57</span> {</div>
<div class="line"><span class="lineno"> 58</span> Logger::Get().Log(<span class="stringliteral">&quot;Could not initialize the skybox model object&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 58</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 the skybox model object&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 59</span> <span class="keyword">delete</span> m_Skybox;</div>
<div class="line"><span class="lineno"> 60</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><span class="lineno"> 61</span> }</div>
@@ -231,6 +243,10 @@ Public Attributes</h2></td></tr>
<div class="line"><span class="lineno"> 64</span> </div>
<div class="line"><span class="lineno"> 65</span> <span class="keywordflow">return</span> m_Skybox; <span class="comment">// Return the constructed skybox object</span></div>
<div class="line"><span class="lineno"> 66</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 class="ttc" id="aclassd__3d__class_html_a0979aea3c4bb6815908fbe188fc1c67e"><div class="ttname"><a href="classd__3d__class.html#a0979aea3c4bb6815908fbe188fc1c67e">d_3d_class::get_device</a></div><div class="ttdeci">ID3D11Device * get_device()</div><div class="ttdoc">Gets the Direct3D device.</div><div class="ttdef"><b>Definition</b> <a href="d__3d__class_8cpp_source.html#l00557">d_3d_class.cpp:557</a></div></div>
<div class="ttc" id="aclassd__3d__class_html_a4ad87066c014351689f12981234beadb"><div class="ttname"><a href="classd__3d__class.html#a4ad87066c014351689f12981234beadb">d_3d_class::get_device_context</a></div><div class="ttdeci">ID3D11DeviceContext * get_device_context()</div><div class="ttdoc">Gets the Direct3D device context.</div><div class="ttdef"><b>Definition</b> <a href="d__3d__class_8cpp_source.html#l00563">d_3d_class.cpp:563</a></div></div>
<div class="ttc" id="aclassobject_html"><div class="ttname"><a href="classobject.html">object</a></div><div class="ttdef"><b>Definition</b> <a href="object_8h_source.html#l00029">object.h:30</a></div></div>
<div class="ttc" id="astruct_texture_container_html"><div class="ttname"><a href="struct_texture_container.html">TextureContainer</a></div><div class="ttdef"><b>Definition</b> <a href="model__class_8h_source.html#l00033">model_class.h:34</a></div></div>
</div><!-- fragment -->
@@ -250,6 +266,12 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the <a class="el" href="class_skybox.html">Skybox</a> with the given <a class="el" href="classd__3d__class.html">d_3d_class</a> reference. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">d3dClassRef</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_skybox_8cpp_source.html#l00021">21</a> of file <a class="el" href="_skybox_8cpp_source.html">Skybox.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 22</span>{</div>
@@ -271,7 +293,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_skybox_8h_source.html#l00021">21</a> of file <a class="el" href="_skybox_8h_source.html">Skybox.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_skybox_8h_source.html#l00034">34</a> of file <a class="el" href="_skybox_8h_source.html">Skybox.h</a>.</p>
</div>
</div>
@@ -287,7 +309,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_skybox_8h_source.html#l00022">22</a> of file <a class="el" href="_skybox_8h_source.html">Skybox.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_skybox_8h_source.html#l00035">35</a> of file <a class="el" href="_skybox_8h_source.html">Skybox.h</a>.</p>
</div>
</div>