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

34
doxygen_docs/html/classinput__class.html
View File

@@ -258,7 +258,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 182</span> result = ReadKeyboard();</div>
<div class="line"><span class="lineno"> 183</span> <span class="keywordflow">if</span> (!result)</div>
<div class="line"><span class="lineno"> 184</span> {</div>
<div class="line"><span class="lineno"> 185</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to read keyboard state&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 185</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 read keyboard state&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 186</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 187</span> }</div>
<div class="line"><span class="lineno"> 188</span> </div>
@@ -266,7 +266,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 190</span> result = ReadMouse();</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 read mouse state&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 read mouse state&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>
@@ -275,6 +275,8 @@ Public 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>
@@ -345,7 +347,7 @@ Public Member Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="input__class_8cpp_source.html#l00022">22</a> of file <a class="el" href="input__class_8cpp_source.html">input_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 23</span>{</div>
<div class="line"><span class="lineno"> 24</span> Logger::Get().Log(<span class="stringliteral">&quot;Initializing input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 24</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 input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 25</span> </div>
<div class="line"><span class="lineno"> 26</span> HRESULT result;</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordtype">int</span> i;</div>
@@ -368,7 +370,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 44</span> result = DirectInput8Create(hinstance, DIRECTINPUT_VERSION, IID_IDirectInput8, (<span class="keywordtype">void</span>**)&amp;m_directInput, NULL);</div>
<div class="line"><span class="lineno"> 45</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 46</span> {</div>
<div class="line"><span class="lineno"> 47</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to create direct input interface&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 47</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 create direct input interface&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 49</span> }</div>
<div class="line"><span class="lineno"> 50</span> </div>
@@ -376,7 +378,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 52</span> result = m_directInput-&gt;CreateDevice(GUID_SysKeyboard, &amp;m_keyboard, NULL);</div>
<div class="line"><span class="lineno"> 53</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 54</span> {</div>
<div class="line"><span class="lineno"> 55</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to create direct input interface for the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 55</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 create direct input interface for the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 57</span> }</div>
<div class="line"><span class="lineno"> 58</span> </div>
@@ -384,7 +386,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 60</span> result = m_keyboard-&gt;SetDataFormat(&amp;c_dfDIKeyboard);</div>
<div class="line"><span class="lineno"> 61</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 62</span> {</div>
<div class="line"><span class="lineno"> 63</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to set data format for the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 63</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 set data format for the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 65</span> }</div>
<div class="line"><span class="lineno"> 66</span> </div>
@@ -392,7 +394,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 68</span> result = m_keyboard-&gt;SetCooperativeLevel(hwnd, DISCL_FOREGROUND | DISCL_NONEXCLUSIVE);</div>
<div class="line"><span class="lineno"> 69</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 70</span> {</div>
<div class="line"><span class="lineno"> 71</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to set cooperative level of the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 71</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 set cooperative level of the keyboard&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 73</span> }</div>
<div class="line"><span class="lineno"> 74</span> </div>
@@ -400,7 +402,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 76</span> result = m_keyboard-&gt;Acquire();</div>
<div class="line"><span class="lineno"> 77</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 78</span> {</div>
<div class="line"><span class="lineno"> 79</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to acquire the keyboard&quot;</span>, __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>(<span class="stringliteral">&quot;Failed to acquire the keyboard&quot;</span>, __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>
@@ -408,7 +410,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 84</span> result = m_directInput-&gt;CreateDevice(GUID_SysMouse, &amp;m_mouse, NULL);</div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 86</span> {</div>
<div class="line"><span class="lineno"> 87</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to create direct input interface for the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 87</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 create direct input interface for the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 88</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 89</span> }</div>
<div class="line"><span class="lineno"> 90</span> </div>
@@ -416,7 +418,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 92</span> result = m_mouse-&gt;SetDataFormat(&amp;c_dfDIMouse);</div>
<div class="line"><span class="lineno"> 93</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 94</span> {</div>
<div class="line"><span class="lineno"> 95</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to set data format for the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 95</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 set data format for the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 96</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 97</span> }</div>
<div class="line"><span class="lineno"> 98</span> </div>
@@ -424,7 +426,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 100</span> result = m_mouse-&gt;SetCooperativeLevel(hwnd, DISCL_FOREGROUND | DISCL_NONEXCLUSIVE);</div>
<div class="line"><span class="lineno"> 101</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 102</span> {</div>
<div class="line"><span class="lineno"> 103</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to set cooperative level of the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 103</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 set cooperative level of the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 104</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 105</span> }</div>
<div class="line"><span class="lineno"> 106</span> </div>
@@ -432,11 +434,11 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 108</span> result = m_mouse-&gt;Acquire();</div>
<div class="line"><span class="lineno"> 109</span> <span class="keywordflow">if</span> (FAILED(result))</div>
<div class="line"><span class="lineno"> 110</span> {</div>
<div class="line"><span class="lineno"> 111</span> Logger::Get().Log(<span class="stringliteral">&quot;Failed to acquire the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 111</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 acquire the mouse&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 112</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 113</span> }</div>
<div class="line"><span class="lineno"> 114</span> </div>
<div class="line"><span class="lineno"> 115</span> Logger::Get().Log(<span class="stringliteral">&quot;Input class initialized&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 115</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;Input class initialized&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 116</span> </div>
<div class="line"><span class="lineno"> 117</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 118</span>}</div>
@@ -922,7 +924,7 @@ Public Member Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="input__class_8cpp_source.html#l00121">121</a> of file <a class="el" href="input__class_8cpp_source.html">input_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 122</span>{</div>
<div class="line"><span class="lineno"> 123</span> <span class="comment">// If a key is pressed then save that state in the key array.</span></div>
<div class="line"><span class="lineno"> 124</span> Logger::Get().Log(<span class="stringliteral">&quot;Key down: &quot;</span> + std::to_string(<a class="code hl_struct" href="structinput.html">input</a>), __FILE__, __LINE__, Logger::LogLevel::Input);</div>
<div class="line"><span class="lineno"> 124</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;Key down: &quot;</span> + std::to_string(<a class="code hl_struct" href="structinput.html">input</a>), __FILE__, __LINE__, Logger::LogLevel::Input);</div>
<div class="line"><span class="lineno"> 125</span> m_keys[<a class="code hl_struct" href="structinput.html">input</a>] = <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 126</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 127</span>}</div>
@@ -979,7 +981,7 @@ Public Member Functions</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="input__class_8cpp_source.html#l00144">144</a> of file <a class="el" href="input__class_8cpp_source.html">input_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 145</span>{</div>
<div class="line"><span class="lineno"> 146</span> Logger::Get().Log(<span class="stringliteral">&quot;Shutting down input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 146</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 input class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 147</span> </div>
<div class="line"><span class="lineno"> 148</span> <span class="comment">// Release the mouse.</span></div>
<div class="line"><span class="lineno"> 149</span> <span class="keywordflow">if</span> (m_mouse)</div>
@@ -1004,7 +1006,7 @@ Public Member Functions</h2></td></tr>
<div class="line"><span class="lineno"> 168</span> m_directInput = 0;</div>
<div class="line"><span class="lineno"> 169</span> }</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;Input class shut down&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</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;Input class shut down&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Shutdown);</div>
<div class="line"><span class="lineno"> 172</span> </div>
<div class="line"><span class="lineno"> 173</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 174</span>}</div>