Merge pull request #46 from cinnabar-engine/feature/some-documentation

Some Documentaion

.github/workflows/Doxygen.yml

@@ -1,5 +1,5 @@
 name: Documentation Generation
-on: [push, pull_request]
+on: [push]
 jobs:
   Doxygen:
     runs-on: ubuntu-latest

.github/workflows/UnitTests.yml

@@ -1,5 +1,5 @@
 name: Unit Testing
-on: [push, pull_request]
+on: [push]
 jobs:
   Debian:
     runs-on: ubuntu-latest

docs/dc/d97/_2github_2workspace_2src_2cinnabar-render-demo_2main_8cpp-example.html

@@ -270,19 +270,19 @@
 <div class="ttc" id="aclassce_1_1RenderEngine_html_abc70d7825b513f8c804a90bdf0ec150e"><div class="ttname"><a href="../../d2/df2/classce_1_1RenderEngine.html#abc70d7825b513f8c804a90bdf0ec150e">ce::RenderEngine::setSize</a></div><div class="ttdeci">void setSize(glm::vec2 size)</div></div>
 <div class="ttc" id="aclassce_1_1RenderEngine_html_ada1c5a74d8a302ddbe27b818efb29de3"><div class="ttname"><a href="../../d2/df2/classce_1_1RenderEngine.html#ada1c5a74d8a302ddbe27b818efb29de3">ce::RenderEngine::clear</a></div><div class="ttdeci">void clear()</div></div>
 <div class="ttc" id="aclassce_1_1Time_html"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html">ce::Time</a></div><div class="ttdef"><b>Definition:</b> time.hpp:4</div></div>
-<div class="ttc" id="aclassce_1_1Time_html_a0c8c3fa43b2499238b1c2c6fefc91cf1"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#a0c8c3fa43b2499238b1c2c6fefc91cf1">ce::Time::update</a></div><div class="ttdeci">void update(bool dt=true, bool fps=true)</div></div>
-<div class="ttc" id="aclassce_1_1Time_html_a68a6066144c2f37751cff9fcfaa25b4c"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#a68a6066144c2f37751cff9fcfaa25b4c">ce::Time::waitUntilDelta</a></div><div class="ttdeci">void waitUntilDelta(double dt)</div></div>
-<div class="ttc" id="aclassce_1_1Time_html_aafa2262f28683c4c7dc9abe547862379"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#aafa2262f28683c4c7dc9abe547862379">ce::Time::getDeltaTime</a></div><div class="ttdeci">double getDeltaTime()</div><div class="ttdef"><b>Definition:</b> time.hpp:13</div></div>
-<div class="ttc" id="aclassce_1_1Time_html_ae35c4009d9e9ce7c3662d193406353e4"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#ae35c4009d9e9ce7c3662d193406353e4">ce::Time::getFPS</a></div><div class="ttdeci">double getFPS()</div><div class="ttdef"><b>Definition:</b> time.hpp:14</div></div>
+<div class="ttc" id="aclassce_1_1Time_html_a0c8c3fa43b2499238b1c2c6fefc91cf1"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#a0c8c3fa43b2499238b1c2c6fefc91cf1">ce::Time::update</a></div><div class="ttdeci">void update(bool dt=true, bool fps=true)</div><div class="ttdoc">Updates the FPS and DeltaTime and makes a GameTick.</div></div>
+<div class="ttc" id="aclassce_1_1Time_html_a68a6066144c2f37751cff9fcfaa25b4c"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#a68a6066144c2f37751cff9fcfaa25b4c">ce::Time::waitUntilDelta</a></div><div class="ttdeci">void waitUntilDelta(double dt)</div><div class="ttdoc">Wait until delta reches a certain values.</div></div>
+<div class="ttc" id="aclassce_1_1Time_html_aafa2262f28683c4c7dc9abe547862379"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#aafa2262f28683c4c7dc9abe547862379">ce::Time::getDeltaTime</a></div><div class="ttdeci">double getDeltaTime()</div><div class="ttdoc">Get the Delta Time.</div><div class="ttdef"><b>Definition:</b> time.hpp:40</div></div>
+<div class="ttc" id="aclassce_1_1Time_html_ae35c4009d9e9ce7c3662d193406353e4"><div class="ttname"><a href="../../df/d10/classce_1_1Time.html#ae35c4009d9e9ce7c3662d193406353e4">ce::Time::getFPS</a></div><div class="ttdeci">double getFPS()</div><div class="ttdoc">Get the FPS.</div><div class="ttdef"><b>Definition:</b> time.hpp:47</div></div>
 <div class="ttc" id="aclassce_1_1Transform_html"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html">ce::Transform</a></div><div class="ttdef"><b>Definition:</b> transform.hpp:6</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a14a831dbe5adac246eb3d45f8617c1cc"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a14a831dbe5adac246eb3d45f8617c1cc">ce::Transform::setPosition</a></div><div class="ttdeci">void setPosition(glm::vec3 pos)</div><div class="ttdef"><b>Definition:</b> transform.hpp:16</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a1609c10bce7200c361aad9180c38c054"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a1609c10bce7200c361aad9180c38c054">ce::Transform::roll</a></div><div class="ttdeci">void roll(float delta)</div><div class="ttdef"><b>Definition:</b> transform.hpp:30</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a238b8f76a7890852e0dd97b05cda87b6"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a238b8f76a7890852e0dd97b05cda87b6">ce::Transform::getForward</a></div><div class="ttdeci">glm::vec3 getForward(bool useYaw=true, bool usePitch=true, bool useRoll=true)</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a3c95052e0a012fc4193f4b8b7d1892bd"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a3c95052e0a012fc4193f4b8b7d1892bd">ce::Transform::yaw</a></div><div class="ttdeci">void yaw(float delta)</div><div class="ttdef"><b>Definition:</b> transform.hpp:26</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a5e886c5f84dac500b3478059682a7746"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a5e886c5f84dac500b3478059682a7746">ce::Transform::setScale</a></div><div class="ttdeci">void setScale(glm::vec3 scale)</div><div class="ttdef"><b>Definition:</b> transform.hpp:40</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_a8ff17e7b51999ad9d31f76f9110d2c5f"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a8ff17e7b51999ad9d31f76f9110d2c5f">ce::Transform::translate</a></div><div class="ttdeci">void translate(glm::vec3 delta)</div><div class="ttdef"><b>Definition:</b> transform.hpp:18</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_aa286ed240bf3d27814a96486d4af6537"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#aa286ed240bf3d27814a96486d4af6537">ce::Transform::pitch</a></div><div class="ttdeci">void pitch(float delta)</div><div class="ttdef"><b>Definition:</b> transform.hpp:22</div></div>
-<div class="ttc" id="aclassce_1_1Transform_html_ad0afd1a8035650c74053bb9665983160"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#ad0afd1a8035650c74053bb9665983160">ce::Transform::getRight</a></div><div class="ttdeci">glm::vec3 getRight(bool useYaw=true, bool usePitch=true, bool useRoll=true)</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a14a831dbe5adac246eb3d45f8617c1cc"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a14a831dbe5adac246eb3d45f8617c1cc">ce::Transform::setPosition</a></div><div class="ttdeci">void setPosition(glm::vec3 pos)</div><div class="ttdoc">Set the Position of the transform.</div><div class="ttdef"><b>Definition:</b> transform.hpp:50</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a1609c10bce7200c361aad9180c38c054"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a1609c10bce7200c361aad9180c38c054">ce::Transform::roll</a></div><div class="ttdeci">void roll(float delta)</div><div class="ttdoc">Rotate the transform's Roll.</div><div class="ttdef"><b>Definition:</b> transform.hpp:123</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a238b8f76a7890852e0dd97b05cda87b6"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a238b8f76a7890852e0dd97b05cda87b6">ce::Transform::getForward</a></div><div class="ttdeci">glm::vec3 getForward(bool useYaw=true, bool usePitch=true, bool useRoll=true)</div><div class="ttdoc">Get transform's Forward vector.</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a3c95052e0a012fc4193f4b8b7d1892bd"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a3c95052e0a012fc4193f4b8b7d1892bd">ce::Transform::yaw</a></div><div class="ttdeci">void yaw(float delta)</div><div class="ttdoc">Rotate the transform's Yaw.</div><div class="ttdef"><b>Definition:</b> transform.hpp:104</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a5e886c5f84dac500b3478059682a7746"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a5e886c5f84dac500b3478059682a7746">ce::Transform::setScale</a></div><div class="ttdeci">void setScale(glm::vec3 scale)</div><div class="ttdoc">Set the Scale of the transform.</div><div class="ttdef"><b>Definition:</b> transform.hpp:177</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_a8ff17e7b51999ad9d31f76f9110d2c5f"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#a8ff17e7b51999ad9d31f76f9110d2c5f">ce::Transform::translate</a></div><div class="ttdeci">void translate(glm::vec3 delta)</div><div class="ttdoc">Translate (or move) the transform.</div><div class="ttdef"><b>Definition:</b> transform.hpp:64</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_aa286ed240bf3d27814a96486d4af6537"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#aa286ed240bf3d27814a96486d4af6537">ce::Transform::pitch</a></div><div class="ttdeci">void pitch(float delta)</div><div class="ttdoc">Rotate the transform's pitch.</div><div class="ttdef"><b>Definition:</b> transform.hpp:85</div></div>
+<div class="ttc" id="aclassce_1_1Transform_html_ad0afd1a8035650c74053bb9665983160"><div class="ttname"><a href="../../d3/dfa/classce_1_1Transform.html#ad0afd1a8035650c74053bb9665983160">ce::Transform::getRight</a></div><div class="ttdeci">glm::vec3 getRight(bool useYaw=true, bool usePitch=true, bool useRoll=true)</div><div class="ttdoc">Get transform's Right vector.</div></div>
 <div class="ttc" id="aclassce_1_1Window_html"><div class="ttname"><a href="../../dc/dee/classce_1_1Window.html">ce::Window</a></div><div class="ttdef"><b>Definition:</b> window.hpp:7</div></div>
 <div class="ttc" id="aclassce_1_1Window_html_a0ee8fb8c95e6341f03af2c17bcb4338c"><div class="ttname"><a href="../../dc/dee/classce_1_1Window.html#a0ee8fb8c95e6341f03af2c17bcb4338c">ce::Window::setMouseVisibility</a></div><div class="ttdeci">static void setMouseVisibility(bool enabled)</div></div>
 <div class="ttc" id="aclassce_1_1Window_html_a4c227112a311b7f1419ca3fe916aa841"><div class="ttname"><a href="../../dc/dee/classce_1_1Window.html#a4c227112a311b7f1419ca3fe916aa841">ce::Window::getWindowSize</a></div><div class="ttdeci">glm::vec2 getWindowSize()</div></div>