Skip to content

Commit 0eebab3

Browse files
committed
docs: rebuilt html website and documentation
1 parent 6684cf4 commit 0eebab3

File tree

113 files changed

+4417
-2028
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+4417
-2028
lines changed

docs/html/BUILD.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
<h1 id="building-the-engine">Building the engine</h1>
1919
<p>Brenta-Engine is written C++23 and uses <code>cmake</code> as it's
2020
build system. You can compile the engine as a static or shared library
21-
for both Windows and Linux.</p>
21+
for both Windows and Linux. On windows, currently compilation with MSVC
22+
is not supported because of an issue with missing inline assembly.</p>
2223
<h2 id="dependencies">Dependencies</h2>
2324
<p>In order to build the engine, you will need:</p>
2425
<ul>

docs/html/DESIGN.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
</div>
1818
<h1 id="design">Design</h1>
1919
<p>THIS DOCUMENT IS A DRAFT AND IT IS NOT COMPLETE</p>
20-
<p>Game engines are complex pieces of software. They provide an
21-
interface to define logic, render graphics, and access system resources
22-
like audio and input, as well as providing a cross-platform abstraction
23-
to the developer.</p>
20+
<p>Game engines are complex pieces of software. They provide an platform
21+
to define logic, render graphics, and access system resources like audio
22+
and input, as well as providing a cross-platform abstraction to the
23+
developer.</p>
2424
<figure>
2525
<img src="./brenta-picture.png" alt="high-level-overview" />
2626
<figcaption aria-hidden="true">high-level-overview</figcaption>

docs/html/GUIDE.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,8 @@ <h3 id="text">Text</h3>
334334
<span id="cb15-13"><a href="#cb15-13" aria-hidden="true" tabindex="-1"></a>hello<span class="op">.</span>render<span class="op">();</span></span></code></pre></div>
335335
<h2 id="renderer">Renderer</h2>
336336
<p>TODO</p>
337+
<h2 id="pipeline">Pipeline</h2>
338+
<p>TODO</p>
337339
<h2 id="ecs">ECS</h2>
338340
<p>The ECS is a framework to organize your objects and how they update.
339341
It is popular because it is arguably simple and elegant, and (if

docs/html/annotated.html

Lines changed: 53 additions & 47 deletions
Large diffs are not rendered by default.

docs/html/annotated_dup.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ var annotated_dup =
3535
[ "Mouse", "classbrenta_1_1Mouse.html", null ],
3636
[ "Node", "classbrenta_1_1Node.html", null ],
3737
[ "NodeComponent", "classbrenta_1_1NodeComponent.html", null ],
38+
[ "OpaquePass", "classbrenta_1_1OpaquePass.html", null ],
3839
[ "ParticleEmitter", "classbrenta_1_1ParticleEmitter.html", "classbrenta_1_1ParticleEmitter" ],
3940
[ "ParticleEmitterEcsComponent", "classbrenta_1_1ParticleEmitterEcsComponent.html", null ],
4041
[ "ParticleEmitterNodeComponent", "classbrenta_1_1ParticleEmitterNodeComponent.html", null ],
@@ -47,6 +48,8 @@ var annotated_dup =
4748
[ "PointLightNodeComponent", "classbrenta_1_1PointLightNodeComponent.html", null ],
4849
[ "PointLightRenderSystem", "classbrenta_1_1PointLightRenderSystem.html", null ],
4950
[ "Renderer", "classbrenta_1_1Renderer.html", "classbrenta_1_1Renderer" ],
51+
[ "RenderPass", "classbrenta_1_1RenderPass.html", null ],
52+
[ "RenderPipeline", "classbrenta_1_1RenderPipeline.html", null ],
5053
[ "Scene", "classbrenta_1_1Scene.html", "classbrenta_1_1Scene" ],
5154
[ "Script", "classbrenta_1_1Script.html", null ],
5255
[ "Shader", "classbrenta_1_1Shader.html", "classbrenta_1_1Shader" ],
@@ -61,7 +64,9 @@ var annotated_dup =
6164
[ "Time", "classbrenta_1_1Time.html", null ],
6265
[ "Transform", "classbrenta_1_1Transform.html", null ],
6366
[ "TransformEcsComponent", "classbrenta_1_1TransformEcsComponent.html", null ],
67+
[ "TransparentPass", "classbrenta_1_1TransparentPass.html", null ],
6468
[ "Ubo", "classbrenta_1_1Ubo.html", null ],
69+
[ "UiPass", "classbrenta_1_1UiPass.html", null ],
6570
[ "Vao", "classbrenta_1_1Vao.html", null ],
6671
[ "Window", "classbrenta_1_1Window.html", "classbrenta_1_1Window" ]
6772
] ]

docs/html/app_8hpp_source.html

Lines changed: 63 additions & 55 deletions
Large diffs are not rendered by default.
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
66
<meta name="generator" content="Doxygen 1.9.8"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>Brenta Engine: src/asset_manager.cpp Source File</title>
8+
<title>Brenta Engine: src/asset.cpp Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
@@ -70,7 +70,7 @@
7070
</div>
7171
<script type="text/javascript">
7272
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
73-
$(document).ready(function(){initNavTree('asset__manager_8cpp_source.html',''); initResizable(); });
73+
$(document).ready(function(){initNavTree('asset_8cpp_source.html',''); initResizable(); });
7474
/* @license-end */
7575
</script>
7676
<div id="doc-content">
@@ -96,15 +96,15 @@
9696
</div>
9797

9898
<div class="header">
99-
<div class="headertitle"><div class="title">asset_manager.cpp</div></div>
99+
<div class="headertitle"><div class="title">asset.cpp</div></div>
100100
</div><!--header-->
101101
<div class="contents">
102102
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
103103
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Author: Giovanni Santini</span></div>
104104
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// Mail: giovanni.santini@proton.me</span></div>
105105
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// Github: @San7o</span></div>
106106
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
107-
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;brenta/asset_manager.hpp&gt;</span></div>
107+
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;brenta/asset.hpp&gt;</span></div>
108108
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;brenta/logger.hpp&gt;</span></div>
109109
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
110110
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">using namespace </span>brenta;</div>
@@ -546,23 +546,23 @@
546546
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno"> 445</span> </div>
547547
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> AssetManager::hotreload_pending.clear();</div>
548548
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span>}</div>
549-
<div class="ttc" id="aclassbrenta_1_1AssetManager_html"><div class="ttname"><a href="classbrenta_1_1AssetManager.html">brenta::AssetManager</a></div><div class="ttdef"><b>Definition</b> <a href="asset__manager_8hpp_source.html#l00045">asset_manager.hpp:46</a></div></div>
549+
<div class="ttc" id="aclassbrenta_1_1AssetManager_html"><div class="ttname"><a href="classbrenta_1_1AssetManager.html">brenta::AssetManager</a></div><div class="ttdef"><b>Definition</b> <a href="asset_8hpp_source.html#l00045">asset.hpp:46</a></div></div>
550550
<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>
551551
<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>
552552
<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>
553553
<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>
554-
<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#l00058">scene.hpp:59</a></div></div>
554+
<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>
555555
<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>
556556
<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>
557557
<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>
558-
<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__manager_8hpp_source.html#l00136">asset_manager.hpp:137</a></div></div>
559-
<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__manager_8hpp_source.html#l00129">asset_manager.hpp:130</a></div></div>
558+
<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>
559+
<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>
560560
</div><!-- fragment --></div><!-- contents -->
561561
</div><!-- doc-content -->
562562
<!-- start footer part -->
563563
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
564564
<ul>
565-
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>asset_manager.cpp</b></li>
565+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>asset.cpp</b></li>
566566
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
567567
</ul>
568568
</div>
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
66
<meta name="generator" content="Doxygen 1.9.8"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>Brenta Engine: include/brenta/asset_manager.hpp Source File</title>
8+
<title>Brenta Engine: include/brenta/asset.hpp Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
@@ -70,7 +70,7 @@
7070
</div>
7171
<script type="text/javascript">
7272
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
73-
$(document).ready(function(){initNavTree('asset__manager_8hpp_source.html',''); initResizable(); });
73+
$(document).ready(function(){initNavTree('asset_8hpp_source.html',''); initResizable(); });
7474
/* @license-end */
7575
</script>
7676
<div id="doc-content">
@@ -96,7 +96,7 @@
9696
</div>
9797

9898
<div class="header">
99-
<div class="headertitle"><div class="title">asset_manager.hpp</div></div>
99+
<div class="headertitle"><div class="title">asset.hpp</div></div>
100100
</div><!--header-->
101101
<div class="contents">
102102
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
@@ -255,24 +255,24 @@
255255
</div>
256256
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
257257
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span>} <span class="comment">// namespace brenta</span></div>
258-
<div class="ttc" id="aclassbrenta_1_1AssetManager_html"><div class="ttname"><a href="classbrenta_1_1AssetManager.html">brenta::AssetManager</a></div><div class="ttdef"><b>Definition</b> <a href="asset__manager_8hpp_source.html#l00045">asset_manager.hpp:46</a></div></div>
258+
<div class="ttc" id="aclassbrenta_1_1AssetManager_html"><div class="ttname"><a href="classbrenta_1_1AssetManager.html">brenta::AssetManager</a></div><div class="ttdef"><b>Definition</b> <a href="asset_8hpp_source.html#l00045">asset.hpp:46</a></div></div>
259259
<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>
260260
<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>
261261
<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>
262262
<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>
263-
<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#l00027">scene.hpp:28</a></div></div>
263+
<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>
264264
<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>
265-
<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#l00090">sound.hpp:91</a></div></div>
265+
<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>
266266
<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>
267-
<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__manager_8hpp_source.html#l00136">asset_manager.hpp:137</a></div></div>
268-
<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__manager_8hpp_source.html#l00129">asset_manager.hpp:130</a></div></div>
269-
<div class="ttc" id="astructbrenta_1_1AssetManager_1_1HotReloadItem_html"><div class="ttname"><a href="structbrenta_1_1AssetManager_1_1HotReloadItem.html">brenta::AssetManager::HotReloadItem</a></div><div class="ttdef"><b>Definition</b> <a href="asset__manager_8hpp_source.html#l00142">asset_manager.hpp:143</a></div></div>
267+
<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>
268+
<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>
269+
<div class="ttc" id="astructbrenta_1_1AssetManager_1_1HotReloadItem_html"><div class="ttname"><a href="structbrenta_1_1AssetManager_1_1HotReloadItem.html">brenta::AssetManager::HotReloadItem</a></div><div class="ttdef"><b>Definition</b> <a href="asset_8hpp_source.html#l00142">asset.hpp:143</a></div></div>
270270
</div><!-- fragment --></div><!-- contents -->
271271
</div><!-- doc-content -->
272272
<!-- start footer part -->
273273
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
274274
<ul>
275-
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8be729f266d03cf130ed75096ea9284a.html">brenta</a></li><li class="navelem"><b>asset_manager.hpp</b></li>
275+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8be729f266d03cf130ed75096ea9284a.html">brenta</a></li><li class="navelem"><b>asset.hpp</b></li>
276276
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
277277
</ul>
278278
</div>

0 commit comments

Comments
 (0)