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

32
doxygen_docs/html/classsystem__class.html
View File

@@ -232,7 +232,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 160</span> result = input_-&gt;Frame();</div>
<div class="line"><span class="lineno"> 161</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 162</span> {</div>
<div class="line"><span class="lineno"> 163</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to process input frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 163</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 process input frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 164</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 165</span> }</div>
<div class="line"><span class="lineno"> 166</span> </div>
@@ -240,7 +240,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 168</span> result = application_-&gt;frame(input_.get());</div>
<div class="line"><span class="lineno"> 169</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 170</span> {</div>
<div class="line"><span class="lineno"> 171</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to process application frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 171</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 process application frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 172</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 173</span> }</div>
<div class="line"><span class="lineno"> 174</span> </div>
@@ -262,7 +262,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 190</span> result = imgui_manager_-&gt;ImGuiWidgetRenderer();</div>
<div class="line"><span class="lineno"> 191</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 192</span> {</div>
<div class="line"><span class="lineno"> 193</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to render ImGui widgets&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 193</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 render ImGui widgets&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 194</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 195</span> }</div>
<div class="line"><span class="lineno"> 196</span> }</div>
@@ -271,6 +271,8 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 199</span> </div>
<div class="line"><span class="lineno"> 200</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 201</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>
@@ -378,7 +380,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 27</span> <span class="keywordtype">int</span> screenHeight, screenWidth = 0;</div>
<div class="line"><span class="lineno"> 28</span> <span class="keywordtype">bool</span> result;</div>
<div class="line"><span class="lineno"> 29</span> </div>
<div class="line"><span class="lineno"> 30</span> Logger::Get().Log(<span class="stringliteral">&quot;Initializing system class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</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;Initializing system class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 31</span> </div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordflow">try</span></div>
<div class="line"><span class="lineno"> 33</span> {</div>
@@ -391,7 +393,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 40</span> result = input_-&gt;Initialize(hinstance_, hwnd_, screenWidth, screenHeight);</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 42</span> {</div>
<div class="line"><span class="lineno"> 43</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to initialize input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 43</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 initialize input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</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>
@@ -427,11 +429,11 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 76</span> }</div>
<div class="line"><span class="lineno"> 77</span> <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::exception&amp; e)</div>
<div class="line"><span class="lineno"> 78</span> {</div>
<div class="line"><span class="lineno"> 79</span> Logger::Get().Log(std::string(<span class="stringliteral">&quot;Exception caught during initialization: &quot;</span>) + e.what(), __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 79</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>(std::string(<span class="stringliteral">&quot;Exception caught during initialization: &quot;</span>) + e.what(), __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 80</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 81</span> }</div>
<div class="line"><span class="lineno"> 82</span> </div>
<div class="line"><span class="lineno"> 83</span> Logger::Get().Log(<span class="stringliteral">&quot;System class initialized&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 83</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;System class initialized&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 84</span> </div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 86</span>}</div>
@@ -471,7 +473,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 307</span> DEVMODE dmScreenSettings;</div>
<div class="line"><span class="lineno"> 308</span> <span class="keywordtype">int</span> posX, posY;</div>
<div class="line"><span class="lineno"> 309</span> </div>
<div class="line"><span class="lineno"> 310</span> Logger::Get().Log(<span class="stringliteral">&quot;Initializing windows&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 310</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 windows&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 311</span> <span class="comment">// Get an external pointer to this object. </span></div>
<div class="line"><span class="lineno"> 312</span> application_handle = <span class="keyword">this</span>;</div>
<div class="line"><span class="lineno"> 313</span> </div>
@@ -666,7 +668,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 286</span> }</div>
<div class="line"><span class="lineno"> 287</span> <span class="keywordflow">case</span> WM_CLOSE:</div>
<div class="line"><span class="lineno"> 288</span> {</div>
<div class="line"><span class="lineno"> 289</span> Logger::Get().Log(<span class="stringliteral">&quot;WM_CLOSE message received&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 289</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;WM_CLOSE message received&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 290</span> application_-&gt;set_should_quit(<span class="keyword">true</span>);</div>
<div class="line"><span class="lineno"> 291</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 292</span> }</div>
@@ -703,7 +705,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 103</span> MSG msg;</div>
<div class="line"><span class="lineno"> 104</span> <span class="keywordtype">bool</span> done, result;</div>
<div class="line"><span class="lineno"> 105</span> </div>
<div class="line"><span class="lineno"> 106</span> Logger::Get().Log(<span class="stringliteral">&quot;Running the system&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 106</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;Running the system&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 107</span> </div>
<div class="line"><span class="lineno"> 108</span> <span class="comment">// initialize the message structure.</span></div>
<div class="line"><span class="lineno"> 109</span> ZeroMemory(&amp;msg, <span class="keyword">sizeof</span>(MSG));</div>
@@ -730,7 +732,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 130</span> <span class="comment">// If windows signals to end the application then exit out.</span></div>
<div class="line"><span class="lineno"> 131</span> <span class="keywordflow">if</span> (application_ != <span class="keyword">nullptr</span> &amp;&amp; application_-&gt;get_should_quit())</div>
<div class="line"><span class="lineno"> 132</span> {</div>
<div class="line"><span class="lineno"> 133</span> Logger::Get().Log(<span class="stringliteral">&quot;Received quit signal from application&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 133</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;Received quit signal from application&quot;</span>, __FILE__, __LINE__);</div>
<div class="line"><span class="lineno"> 134</span> done = <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 135</span> }</div>
<div class="line"><span class="lineno"> 136</span> <span class="keywordflow">else</span></div>
@@ -739,7 +741,7 @@ Protected Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 139</span> result = frame();</div>
<div class="line"><span class="lineno"> 140</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 141</span> {</div>
<div class="line"><span class="lineno"> 142</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to process frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 142</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 process frame&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 143</span> done = <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 144</span> }</div>
<div class="line"><span class="lineno"> 145</span> }</div>
@@ -880,14 +882,14 @@ Protected Member Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="system__class_8cpp_source.html#l00088">88</a> of file <a class="el" href="system__class_8cpp_source.html">system_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 89</span>{</div>
<div class="line"><span class="lineno"> 90</span> Logger::Get().Log(<span class="stringliteral">&quot;Shutting down system class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 90</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;Shutting down system class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 91</span> </div>
<div class="line"><span class="lineno"> 92</span> std::lock_guard&lt;std::mutex&gt; guard(render_mutex_);</div>
<div class="line"><span class="lineno"> 93</span> </div>
<div class="line"><span class="lineno"> 94</span> <span class="comment">// shutdown the window.</span></div>
<div class="line"><span class="lineno"> 95</span> shutdown_windows();</div>
<div class="line"><span class="lineno"> 96</span> </div>
<div class="line"><span class="lineno"> 97</span> Logger::Get().Log(<span class="stringliteral">&quot;System class shut down&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 97</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;System class shut down&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 98</span> </div>
<div class="line"><span class="lineno"> 99</span>}</div>
</div><!-- fragment -->
@@ -918,7 +920,7 @@ Protected Member Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="system__class_8cpp_source.html#l00388">388</a> of file <a class="el" href="system__class_8cpp_source.html">system_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 389</span>{</div>
<div class="line"><span class="lineno"> 390</span> Logger::Get().Log(<span class="stringliteral">&quot;Shutting down the windows&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 390</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;Shutting down the windows&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 391</span> <span class="comment">// Show the mouse cursor.</span></div>
<div class="line"><span class="lineno"> 392</span> ShowCursor(<span class="keyword">true</span>);</div>
<div class="line"><span class="lineno"> 393</span> </div>