Patch - Doc Update - V12.8.1

2025-07-28 17:37:15 +02:00
parent 9431552316
commit ccd0d045f9
201 changed files with 9244 additions and 3316 deletions
--- a/doxygen_docs/html/camera__class_8cpp_source.html
+++ b/doxygen_docs/html/camera__class_8cpp_source.html
@@ -103,7 +103,8 @@ $(function(){initNavTree('camera__class_8cpp_source.html',''); initResizable(tru
 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// Filename: cameraclass.cpp</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#include &quot;camera_class.h&quot;</span></div>
 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span> </div>
-<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span>camera_class::camera_class()</div>
+<div class="foldopen" id="foldopen00006" data-start="{" data-end="}">
+<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="classcamera__class.html#ac18562f9e46ca033440ba9df2d180e20">    6</a></span><a class="code hl_function" href="classcamera__class.html#ac18562f9e46ca033440ba9df2d180e20">camera_class::camera_class</a>()</div>
 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span>{</div>
 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span>    position_x_ = 0.0f;</div>
 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span>    position_y_ = 0.0f;</div>
@@ -113,9 +114,10 @@ $(function(){initNavTree('camera__class_8cpp_source.html',''); initResizable(tru
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span>    rotation_y_ = 0.0f;</div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>    rotation_z_ = 0.0f;</div>
 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>}</div>
+</div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
-<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>camera_class::camera_class(<span class="keyword">const</span> <a class="code hl_class" href="classcamera__class.html">camera_class</a>&amp; other)</div>
+<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><a class="code hl_function" href="classcamera__class.html#ac18562f9e46ca033440ba9df2d180e20">camera_class::camera_class</a>(<span class="keyword">const</span> <a class="code hl_class" href="classcamera__class.html">camera_class</a>&amp; other)</div>
 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>{</div>
 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>}</div>
 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
@@ -124,35 +126,44 @@ $(function(){initNavTree('camera__class_8cpp_source.html',''); initResizable(tru
 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>{</div>
 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>}</div>
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
-<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keywordtype">void</span> camera_class::set_position(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> z)</div>
+<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classcamera__class.html#a4b9ac7f98297d2007abd1ed3d326d381">   27</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classcamera__class.html#a4b9ac7f98297d2007abd1ed3d326d381">camera_class::set_position</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> z)</div>
 <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
 <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>    position_x_ = x;</div>
 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>    position_y_ = y;</div>
 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>    position_z_ = z;</div>
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    <span class="keywordflow">return</span>;</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>}</div>
+</div>
 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="keywordtype">void</span> camera_class::set_rotation(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> z)</div>
+<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classcamera__class.html#a410c4bbfd5ba10d0785f5ac9178f9b3f">   36</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classcamera__class.html#a410c4bbfd5ba10d0785f5ac9178f9b3f">camera_class::set_rotation</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, <span class="keywordtype">float</span> z)</div>
 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>{</div>
 <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>    rotation_x_ = x;</div>
 <div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    rotation_y_ = y;</div>
 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    rotation_z_ = z;</div>
 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>    <span class="keywordflow">return</span>;</div>
 <div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>}</div>
+</div>
 <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
-<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>XMFLOAT3 camera_class::get_position()</div>
+<div class="foldopen" id="foldopen00044" data-start="{" data-end="}">
+<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classcamera__class.html#af416c69abe70579751cd404cba8bf388">   44</a></span>XMFLOAT3 <a class="code hl_function" href="classcamera__class.html#af416c69abe70579751cd404cba8bf388">camera_class::get_position</a>()</div>
 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>{</div>
 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="keywordflow">return</span> XMFLOAT3(position_x_, position_y_, position_z_);</div>
 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>}</div>
+</div>
 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
-<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>XMFLOAT3 camera_class::get_rotation()</div>
+<div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
+<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classcamera__class.html#aa8073c109a536d48478257a3e1e889cd">   50</a></span>XMFLOAT3 <a class="code hl_function" href="classcamera__class.html#aa8073c109a536d48478257a3e1e889cd">camera_class::get_rotation</a>()</div>
 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>{</div>
 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keywordflow">return</span> XMFLOAT3(rotation_x_, rotation_y_, rotation_z_);</div>
 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>}</div>
+</div>
 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
-<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="keywordtype">void</span> camera_class::render()</div>
+<div class="foldopen" id="foldopen00055" data-start="{" data-end="}">
+<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classcamera__class.html#a0820187f209f9628e6b2a8af34d71057">   55</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classcamera__class.html#a0820187f209f9628e6b2a8af34d71057">camera_class::render</a>()</div>
 <div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>{</div>
 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    XMFLOAT3 up, position, lookAt;</div>
 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    XMVECTOR upVector, positionVector, lookAtVector;</div>
@@ -204,14 +215,18 @@ $(function(){initNavTree('camera__class_8cpp_source.html',''); initResizable(tru
 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div>
 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    <span class="keywordflow">return</span>;</div>
 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>}</div>
+</div>
 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
-<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>XMMATRIX camera_class::get_view_matrix(XMMATRIX&amp; view_matrix)<span class="keyword"> const</span></div>
+<div class="foldopen" id="foldopen00108" data-start="{" data-end="}">
+<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classcamera__class.html#ac17736821f337ce7fd52b9857095de68">  108</a></span>XMMATRIX <a class="code hl_function" href="classcamera__class.html#ac17736821f337ce7fd52b9857095de68">camera_class::get_view_matrix</a>(XMMATRIX&amp; view_matrix)<span class="keyword"> const</span></div>
 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="keyword"></span>{</div>
 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>    view_matrix = view_matrix_;</div>
 <div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    <span class="keywordflow">return</span> view_matrix;</div>
 <div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>}</div>
+</div>
 <div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span> </div>
-<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="keywordtype">void</span> camera_class::render_reflection(<span class="keywordtype">float</span> height)</div>
+<div class="foldopen" id="foldopen00114" data-start="{" data-end="}">
+<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classcamera__class.html#a58b36223405de07000d108129c998075">  114</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classcamera__class.html#a58b36223405de07000d108129c998075">camera_class::render_reflection</a>(<span class="keywordtype">float</span> height)</div>
 <div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>{</div>
 <div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>    XMFLOAT3 up, position, lookAt;</div>
 <div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>    XMVECTOR upVector, positionVector, lookAtVector;</div>
@@ -263,13 +278,25 @@ $(function(){initNavTree('camera__class_8cpp_source.html',''); initResizable(tru
 <div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span> </div>
 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <span class="keywordflow">return</span>;</div>
 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>}</div>
+</div>
 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span> </div>
-<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="keywordtype">void</span> camera_class::get_reflection_view_matrix(XMMATRIX&amp; reflectionViewMatrix)<span class="keyword"> const</span></div>
+<div class="foldopen" id="foldopen00167" data-start="{" data-end="}">
+<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"><a class="line" href="classcamera__class.html#ac4d85cc166aec75e54528dc9dee8a075">  167</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classcamera__class.html#ac4d85cc166aec75e54528dc9dee8a075">camera_class::get_reflection_view_matrix</a>(XMMATRIX&amp; reflectionViewMatrix)<span class="keyword"> const</span></div>
 <div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="keyword"></span>{</div>
 <div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>    reflectionViewMatrix = reflection_view_matrix_;</div>
 <div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>    <span class="keywordflow">return</span>;</div>
 <div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>}</div>
+</div>
 <div class="ttc" id="aclasscamera__class_html"><div class="ttname"><a href="classcamera__class.html">camera_class</a></div><div class="ttdef"><b>Definition</b> <a href="camera__class_8h_source.html#l00018">camera_class.h:19</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_a0820187f209f9628e6b2a8af34d71057"><div class="ttname"><a href="classcamera__class.html#a0820187f209f9628e6b2a8af34d71057">camera_class::render</a></div><div class="ttdeci">void render()</div><div class="ttdoc">Updates the camera's view matrix based on its position and rotation. This method recalculates the vie...</div><div class="ttdef"><b>Definition</b> <a href="#l00055">camera_class.cpp:55</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_a410c4bbfd5ba10d0785f5ac9178f9b3f"><div class="ttname"><a href="classcamera__class.html#a410c4bbfd5ba10d0785f5ac9178f9b3f">camera_class::set_rotation</a></div><div class="ttdeci">void set_rotation(float, float, float)</div><div class="ttdoc">Sets the rotation of the camera in 3D space.</div><div class="ttdef"><b>Definition</b> <a href="#l00036">camera_class.cpp:36</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_a4b9ac7f98297d2007abd1ed3d326d381"><div class="ttname"><a href="classcamera__class.html#a4b9ac7f98297d2007abd1ed3d326d381">camera_class::set_position</a></div><div class="ttdeci">void set_position(float, float, float)</div><div class="ttdoc">Sets the position of the camera in 3D space.</div><div class="ttdef"><b>Definition</b> <a href="#l00027">camera_class.cpp:27</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_a58b36223405de07000d108129c998075"><div class="ttname"><a href="classcamera__class.html#a58b36223405de07000d108129c998075">camera_class::render_reflection</a></div><div class="ttdeci">void render_reflection(float)</div><div class="ttdoc">Renders the reflection of the scene from the camera's perspective.</div><div class="ttdef"><b>Definition</b> <a href="#l00114">camera_class.cpp:114</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_aa8073c109a536d48478257a3e1e889cd"><div class="ttname"><a href="classcamera__class.html#aa8073c109a536d48478257a3e1e889cd">camera_class::get_rotation</a></div><div class="ttdeci">XMFLOAT3 get_rotation()</div><div class="ttdoc">Gets the current rotation of the camera.</div><div class="ttdef"><b>Definition</b> <a href="#l00050">camera_class.cpp:50</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_ac17736821f337ce7fd52b9857095de68"><div class="ttname"><a href="classcamera__class.html#ac17736821f337ce7fd52b9857095de68">camera_class::get_view_matrix</a></div><div class="ttdeci">XMMATRIX get_view_matrix(XMMATRIX &amp;view_matrix) const</div><div class="ttdoc">Retrieves the current view matrix of the camera.</div><div class="ttdef"><b>Definition</b> <a href="#l00108">camera_class.cpp:108</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_ac18562f9e46ca033440ba9df2d180e20"><div class="ttname"><a href="classcamera__class.html#ac18562f9e46ca033440ba9df2d180e20">camera_class::camera_class</a></div><div class="ttdeci">camera_class()</div><div class="ttdoc">Default constructor for camera_class. Initializes the camera position and rotation to zero.</div><div class="ttdef"><b>Definition</b> <a href="#l00006">camera_class.cpp:6</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_ac4d85cc166aec75e54528dc9dee8a075"><div class="ttname"><a href="classcamera__class.html#ac4d85cc166aec75e54528dc9dee8a075">camera_class::get_reflection_view_matrix</a></div><div class="ttdeci">void get_reflection_view_matrix(XMMATRIX &amp;) const</div><div class="ttdoc">Retrieves the reflection view matrix of the camera.</div><div class="ttdef"><b>Definition</b> <a href="#l00167">camera_class.cpp:167</a></div></div>
+<div class="ttc" id="aclasscamera__class_html_af416c69abe70579751cd404cba8bf388"><div class="ttname"><a href="classcamera__class.html#af416c69abe70579751cd404cba8bf388">camera_class::get_position</a></div><div class="ttdeci">XMFLOAT3 get_position()</div><div class="ttdoc">Gets the current position of the camera.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">camera_class.cpp:44</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->