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

60
doxygen_docs/html/classcamera__class.html
View File

@@ -105,23 +105,34 @@ $(function(){initNavTree('classcamera__class.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:ac18562f9e46ca033440ba9df2d180e20" id="r_ac18562f9e46ca033440ba9df2d180e20"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac18562f9e46ca033440ba9df2d180e20">camera_class</a> ()</td></tr>
<tr class="memdesc:ac18562f9e46ca033440ba9df2d180e20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for <a class="el" href="classcamera__class.html">camera_class</a>. Initializes the camera position and rotation to zero. <br /></td></tr>
<tr class="separator:ac18562f9e46ca033440ba9df2d180e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2cfbf1c511ff8dbfdf413be52076621" id="r_ad2cfbf1c511ff8dbfdf413be52076621"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2cfbf1c511ff8dbfdf413be52076621">camera_class</a> (const <a class="el" href="classcamera__class.html">camera_class</a> &amp;)</td></tr>
<tr class="separator:ad2cfbf1c511ff8dbfdf413be52076621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b9ac7f98297d2007abd1ed3d326d381" id="r_a4b9ac7f98297d2007abd1ed3d326d381"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b9ac7f98297d2007abd1ed3d326d381">set_position</a> (float, float, float)</td></tr>
<tr class="memdesc:a4b9ac7f98297d2007abd1ed3d326d381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the position of the camera in 3D space. <br /></td></tr>
<tr class="separator:a4b9ac7f98297d2007abd1ed3d326d381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a410c4bbfd5ba10d0785f5ac9178f9b3f" id="r_a410c4bbfd5ba10d0785f5ac9178f9b3f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a410c4bbfd5ba10d0785f5ac9178f9b3f">set_rotation</a> (float, float, float)</td></tr>
<tr class="memdesc:a410c4bbfd5ba10d0785f5ac9178f9b3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the rotation of the camera in 3D space. <br /></td></tr>
<tr class="separator:a410c4bbfd5ba10d0785f5ac9178f9b3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af416c69abe70579751cd404cba8bf388" id="r_af416c69abe70579751cd404cba8bf388"><td class="memItemLeft" align="right" valign="top">XMFLOAT3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af416c69abe70579751cd404cba8bf388">get_position</a> ()</td></tr>
<tr class="memdesc:af416c69abe70579751cd404cba8bf388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current position of the camera. <br /></td></tr>
<tr class="separator:af416c69abe70579751cd404cba8bf388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8073c109a536d48478257a3e1e889cd" id="r_aa8073c109a536d48478257a3e1e889cd"><td class="memItemLeft" align="right" valign="top">XMFLOAT3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8073c109a536d48478257a3e1e889cd">get_rotation</a> ()</td></tr>
<tr class="memdesc:aa8073c109a536d48478257a3e1e889cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current rotation of the camera. <br /></td></tr>
<tr class="separator:aa8073c109a536d48478257a3e1e889cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0820187f209f9628e6b2a8af34d71057" id="r_a0820187f209f9628e6b2a8af34d71057"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0820187f209f9628e6b2a8af34d71057">render</a> ()</td></tr>
<tr class="memdesc:a0820187f209f9628e6b2a8af34d71057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the camera's view matrix based on its position and rotation. This method recalculates the view matrix to reflect the current camera state. <br /></td></tr>
<tr class="separator:a0820187f209f9628e6b2a8af34d71057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac17736821f337ce7fd52b9857095de68" id="r_ac17736821f337ce7fd52b9857095de68"><td class="memItemLeft" align="right" valign="top">XMMATRIX&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac17736821f337ce7fd52b9857095de68">get_view_matrix</a> (XMMATRIX &amp;view_matrix) const</td></tr>
<tr class="memdesc:ac17736821f337ce7fd52b9857095de68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the current view matrix of the camera. <br /></td></tr>
<tr class="separator:ac17736821f337ce7fd52b9857095de68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58b36223405de07000d108129c998075" id="r_a58b36223405de07000d108129c998075"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a58b36223405de07000d108129c998075">render_reflection</a> (float)</td></tr>
<tr class="memdesc:a58b36223405de07000d108129c998075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Renders the reflection of the scene from the camera's perspective. <br /></td></tr>
<tr class="separator:a58b36223405de07000d108129c998075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d85cc166aec75e54528dc9dee8a075" id="r_ac4d85cc166aec75e54528dc9dee8a075"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac4d85cc166aec75e54528dc9dee8a075">get_reflection_view_matrix</a> (XMMATRIX &amp;) const</td></tr>
<tr class="memdesc:ac4d85cc166aec75e54528dc9dee8a075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the reflection view matrix of the camera. <br /></td></tr>
<tr class="separator:ac4d85cc166aec75e54528dc9dee8a075"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -143,6 +154,8 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Default constructor for <a class="el" href="classcamera__class.html">camera_class</a>. Initializes the camera position and rotation to zero. </p>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00006">6</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 7</span>{</div>
<div class="line"><span class="lineno"> 8</span> position_x_ = 0.0f;</div>
@@ -214,6 +227,9 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Gets the current position of the camera. </p>
<dl class="section return"><dt>Returns</dt><dd>A 3D vector representing the camera's position. </dd></dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00044">44</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 45</span>{</div>
<div class="line"><span class="lineno"> 46</span> <span class="keywordflow">return</span> XMFLOAT3(position_x_, position_y_, position_z_);</div>
@@ -236,6 +252,14 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reflection view matrix of the camera. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reflection_view_matrix</td><td>The matrix to store the reflection view matrix. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00167">167</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 168</span>{</div>
<div class="line"><span class="lineno"> 169</span> reflectionViewMatrix = reflection_view_matrix_;</div>
@@ -259,6 +283,9 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Gets the current rotation of the camera. </p>
<dl class="section return"><dt>Returns</dt><dd>A 3D vector representing the camera's rotation in degrees. </dd></dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00050">50</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 51</span>{</div>
<div class="line"><span class="lineno"> 52</span> <span class="keywordflow">return</span> XMFLOAT3(rotation_x_, rotation_y_, rotation_z_);</div>
@@ -281,6 +308,9 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current view matrix of the camera. </p>
<dl class="section return"><dt>Returns</dt><dd>The view matrix representing the camera's orientation and position. </dd></dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00108">108</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 109</span>{</div>
<div class="line"><span class="lineno"> 110</span> view_matrix = view_matrix_;</div>
@@ -304,6 +334,8 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Updates the camera's view matrix based on its position and rotation. This method recalculates the view matrix to reflect the current camera state. </p>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00055">55</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 56</span>{</div>
<div class="line"><span class="lineno"> 57</span> XMFLOAT3 up, position, lookAt;</div>
@@ -374,6 +406,14 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Renders the reflection of the scene from the camera's perspective. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reflection_plane_y</td><td>The y-coordinate of the reflection plane. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00114">114</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 115</span>{</div>
<div class="line"><span class="lineno"> 116</span> XMFLOAT3 up, position, lookAt;</div>
@@ -453,6 +493,16 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Sets the position of the camera in 3D space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position_x</td><td>The x-coordinate of the camera's position. </td></tr>
<tr><td class="paramname">position_y</td><td>The y-coordinate of the camera's position. </td></tr>
<tr><td class="paramname">position_z</td><td>The z-coordinate of the camera's position. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00027">27</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 28</span>{</div>
<div class="line"><span class="lineno"> 29</span> position_x_ = x;</div>
@@ -487,6 +537,16 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Sets the rotation of the camera in 3D space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rotation_x</td><td>The rotation around the x-axis in degrees. </td></tr>
<tr><td class="paramname">rotation_y</td><td>The rotation around the y-axis in degrees. </td></tr>
<tr><td class="paramname">rotation_z</td><td>The rotation around the z-axis in degrees. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="camera__class_8cpp_source.html#l00036">36</a> of file <a class="el" href="camera__class_8cpp_source.html">camera_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 37</span>{</div>
<div class="line"><span class="lineno"> 38</span> rotation_x_ = x;</div>