website: updated introduction in design document, regenerated documentation

Author: San7o

docs/DESIGN.md

@@ -2,13 +2,30 @@
 
 THIS DOCUMENT IS A DRAFT AND IT IS NOT COMPLETE
 
-Game engines are complex pieces of software. They provide an platform
-to define logic, render graphics, and access system resources like
-audio and input, as well as providing a cross-platform abstraction to
-the developer.
+What is a game engine?
+
+The line between a game / application and its engine is not something
+inherently fixed, people have different needs and they may think
+differently about it. This is what fundamentally drives the design of
+their engines. AAA studios may want a "big engine" that provides many
+advanced features out of the box, I would place Unreal Engine and
+Unity in this category. Some other smaller studios or individual
+recreational programmers may want a lighter platform that is easier to
+understand and to modify, think Raylib and Love2D.
+
+Regardless, game engines are usually complex pieces of software. They
+provide an platform to define logic, render graphics, and access
+system resources like audio and input, as well as providing a
+cross-platform abstraction to the developer.
+
+Brenta-Engine is more positioned towards the "big-engine"
+category. Here is an high level overview of the major classes that are
+used in the engine:
 
 ![high-level-overview](./brenta-picture.png)
 
+## Design proces
+
 Brenta's development has been more iterative than meticulously
 designed. I rewrote huge parts of the engine many many times, to the
 point where I am not scared to do big refactoring anymore - that is
@@ -24,7 +41,7 @@ implemented, and as a programming exercise / learning experience. The
 more I learned about graphics the more I became fascinated and
 interested in the topic.
 
-When I began this project in july 2024 I was really confused with
+When I began this project in July 2024 I was really confused with
 using OpenGL and C++, it took me a while to develop a decent mental
 model. I was at my second year of university and I did not have any
 major programming experience, but I pushed through it and hacked some

docs/html/DESIGN.html

@@ -17,14 +17,27 @@
     </div>
 <h1 id="design">Design</h1>
 <p>THIS DOCUMENT IS A DRAFT AND IT IS NOT COMPLETE</p>
-<p>Game engines are complex pieces of software. They provide an platform
-to define logic, render graphics, and access system resources like audio
-and input, as well as providing a cross-platform abstraction to the
-developer.</p>
+<p>What is a game engine?</p>
+<p>The line between a game / application and its engine is not something
+inherently fixed, people have different needs and they may think
+differently about it. This is what fundamentally drives the design of
+their engines. AAA studios may want a "big engine" that provides many
+advanced features out of the box, I would place Unreal Engine and Unity
+in this category. Some other smaller studios or individual recreational
+programmers may want a lighter platform that is easier to understand and
+to modify, think Raylib and Love2D.</p>
+<p>Regardless, game engines are usually complex pieces of software. They
+provide an platform to define logic, render graphics, and access system
+resources like audio and input, as well as providing a cross-platform
+abstraction to the developer.</p>
+<p>Brenta-Engine is more positioned towards the "big-engine" category.
+Here is an high level overview of the major classes that are used in the
+engine:</p>
 <figure>
 <img src="./brenta-picture.png" alt="high-level-overview" />
 <figcaption aria-hidden="true">high-level-overview</figcaption>
 </figure>
+<h2 id="design-proces">Design proces</h2>
 <p>Brenta's development has been more iterative than meticulously
 designed. I rewrote huge parts of the engine many many times, to the
 point where I am not scared to do big refactoring anymore - that is just
@@ -38,7 +51,7 @@ <h1 id="design">Design</h1>
 implemented, and as a programming exercise / learning experience. The
 more I learned about graphics the more I became fascinated and
 interested in the topic.</p>
-<p>When I began this project in july 2024 I was really confused with
+<p>When I began this project in July 2024 I was really confused with
 using OpenGL and C++, it took me a while to develop a decent mental
 model. I was at my second year of university and I did not have any
 major programming experience, but I pushed through it and hacked some

docs/html/annotated.html

@@ -8,6 +8,7 @@ var annotated_dup =
       [ "CameraEcsComponent", "classbrenta_1_1CameraEcsComponent.html", null ],
       [ "CameraRenderSystem", "classbrenta_1_1CameraRenderSystem.html", null ],
       [ "Color", "classbrenta_1_1Color.html", null ],
+      [ "Cubemap", "classbrenta_1_1Cubemap.html", null ],
       [ "DirLight", "classbrenta_1_1DirLight.html", null ],
       [ "DirLightEcsComponent", "classbrenta_1_1DirLightEcsComponent.html", null ],
       [ "DirLightNodeComponent", "classbrenta_1_1DirLightNodeComponent.html", null ],
@@ -54,6 +55,8 @@ var annotated_dup =
       [ "Script", "classbrenta_1_1Script.html", null ],
       [ "Shader", "classbrenta_1_1Shader.html", "classbrenta_1_1Shader" ],
       [ "SignalManager", "classbrenta_1_1SignalManager.html", "classbrenta_1_1SignalManager" ],
+      [ "Skybox", "classbrenta_1_1Skybox.html", null ],
+      [ "SkyboxPass", "classbrenta_1_1SkyboxPass.html", null ],
       [ "Sound", "classbrenta_1_1Sound.html", null ],
       [ "SoundAsset", "classbrenta_1_1SoundAsset.html", "classbrenta_1_1SoundAsset" ],
       [ "SoundManager", "classbrenta_1_1SoundManager.html", "classbrenta_1_1SoundManager" ],

docs/html/annotated_dup.js

@@ -550,11 +550,11 @@
 <div class="ttc" id="aclassbrenta_1_1FilesystemWatcher_html"><div class="ttname"><a href="classbrenta_1_1FilesystemWatcher.html">brenta::FilesystemWatcher</a></div><div class="ttdef"><b>Definition</b> <a href="fswatcher_8hpp_source.html#l00029">fswatcher.hpp:30</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Font_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Font_1_1Builder.html">brenta::Font::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="font_8hpp_source.html#l00051">font.hpp:52</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Material_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Material_1_1Builder.html">brenta::Material::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="material_8hpp_source.html#l00033">material.hpp:34</a></div></div>
-<div class="ttc" id="aclassbrenta_1_1Model_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Model_1_1Builder.html">brenta::Model::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="model_8hpp_source.html#l00078">model.hpp:79</a></div></div>
-<div class="ttc" id="aclassbrenta_1_1Scene_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Scene_1_1Builder.html">brenta::Scene::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="scene_8hpp_source.html#l00060">scene.hpp:61</a></div></div>
+<div class="ttc" id="aclassbrenta_1_1Model_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Model_1_1Builder.html">brenta::Model::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="model_8hpp_source.html#l00076">model.hpp:77</a></div></div>
+<div class="ttc" id="aclassbrenta_1_1Scene_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Scene_1_1Builder.html">brenta::Scene::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="scene_8hpp_source.html#l00065">scene.hpp:66</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Shader_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Shader_1_1Builder.html">brenta::Shader::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="shader_8hpp_source.html#l00170">shader.hpp:171</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1SoundAsset_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1SoundAsset_1_1Builder.html">brenta::SoundAsset::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="sound_8hpp_source.html#l00061">sound.hpp:62</a></div></div>
-<div class="ttc" id="aclassbrenta_1_1Texture_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Texture_1_1Builder.html">brenta::Texture::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="texture_8hpp_source.html#l00208">texture.hpp:209</a></div></div>
+<div class="ttc" id="aclassbrenta_1_1Texture_1_1Builder_html"><div class="ttname"><a href="classbrenta_1_1Texture_1_1Builder.html">brenta::Texture::Builder</a></div><div class="ttdef"><b>Definition</b> <a href="texture_8hpp_source.html#l00195">texture.hpp:196</a></div></div>
 <div class="ttc" id="astructbrenta_1_1AssetManager_1_1AssetOwned_html"><div class="ttname"><a href="structbrenta_1_1AssetManager_1_1AssetOwned.html">brenta::AssetManager::AssetOwned</a></div><div class="ttdef"><b>Definition</b> <a href="asset_8hpp_source.html#l00136">asset.hpp:137</a></div></div>
 <div class="ttc" id="astructbrenta_1_1AssetManager_1_1Asset_html"><div class="ttname"><a href="structbrenta_1_1AssetManager_1_1Asset.html">brenta::AssetManager::Asset</a></div><div class="ttdef"><b>Definition</b> <a href="asset_8hpp_source.html#l00129">asset.hpp:130</a></div></div>
 </div><!-- fragment --></div><!-- contents -->

docs/html/asset_8cpp_source.html

@@ -260,7 +260,7 @@
 <div class="ttc" id="aclassbrenta_1_1Font_html"><div class="ttname"><a href="classbrenta_1_1Font.html">brenta::Font</a></div><div class="ttdef"><b>Definition</b> <a href="font_8hpp_source.html#l00024">font.hpp:25</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Material_html"><div class="ttname"><a href="classbrenta_1_1Material.html">brenta::Material</a></div><div class="ttdef"><b>Definition</b> <a href="material_8hpp_source.html#l00029">material.hpp:30</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Model_html"><div class="ttname"><a href="classbrenta_1_1Model.html">brenta::Model</a></div><div class="ttdef"><b>Definition</b> <a href="model_8hpp_source.html#l00024">model.hpp:25</a></div></div>
-<div class="ttc" id="aclassbrenta_1_1Scene_html"><div class="ttname"><a href="classbrenta_1_1Scene.html">brenta::Scene</a></div><div class="ttdef"><b>Definition</b> <a href="scene_8hpp_source.html#l00029">scene.hpp:30</a></div></div>
+<div class="ttc" id="aclassbrenta_1_1Scene_html"><div class="ttname"><a href="classbrenta_1_1Scene.html">brenta::Scene</a></div><div class="ttdef"><b>Definition</b> <a href="scene_8hpp_source.html#l00030">scene.hpp:31</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Shader_html"><div class="ttname"><a href="classbrenta_1_1Shader.html">brenta::Shader</a></div><div class="ttdef"><b>Definition</b> <a href="shader_8hpp_source.html#l00040">shader.hpp:41</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Sound_html"><div class="ttname"><a href="classbrenta_1_1Sound.html">brenta::Sound</a></div><div class="ttdef"><b>Definition</b> <a href="sound_8hpp_source.html#l00091">sound.hpp:92</a></div></div>
 <div class="ttc" id="aclassbrenta_1_1Texture_html"><div class="ttname"><a href="classbrenta_1_1Texture.html">brenta::Texture</a></div><div class="ttdef"><b>Definition</b> <a href="texture_8hpp_source.html#l00030">texture.hpp:31</a></div></div>