Skip to content

Commit

Permalink
Deploy preview for PR 1338 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@tomas7770
tomas7770 committed Oct 7, 2024
1 parent e2aea62 commit fe251d0
Show file tree
Hide file tree
Showing 91 changed files with 4,081 additions and 1,911 deletions.
6 changes: 4 additions & 2 deletions preview/pr-1338/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,7 @@ <h1>Classes</h1>
<li>struct <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> <span class="m-doc">Component which assigns a uniform scale to an entity.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1Scene.html" class="m-doc">Scene</a> <span class="m-doc"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> equivalent to ECS blueprints - a bundle of entities and their components.</span></li>
<li>class <a href="classcubos_1_1engine_1_1SceneBridge.html" class="m-doc">SceneBridge</a> <span class="m-doc">Bridge which loads and saves <a href="structcubos_1_1engine_1_1Scene.html" class="m-doc">Scene</a> assets.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1Selection.html" class="m-doc">Selection</a> <span class="m-doc">Resource which identifies the current selection.</span></li>
<li>class <a href="classcubos_1_1engine_1_1Settings.html" class="m-doc">Settings</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Stores settings as key-value pairs and provides methods to retrieve them.</span></li>
<li>class <a href="classcubos_1_1engine_1_1Shader.html" class="m-doc">Shader</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Contains a shader stage created from GLSL code.</span></li>
<li>class <a href="classcubos_1_1engine_1_1ShaderBridge.html" class="m-doc">ShaderBridge</a> <span class="m-doc">Bridge for loading shader assets.</span></li>
Expand All @@ -541,6 +542,7 @@ <h1>Classes</h1>
<li>struct <a href="structcubos_1_1engine_1_1SpotShadowCaster.html" class="m-doc">SpotShadowCaster</a> <span class="m-doc">Component which enables shadow casting on a spot light.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1SSAO.html" class="m-doc">SSAO</a> <span class="m-doc">Component which stores the <a href="structcubos_1_1engine_1_1SSAO.html" class="m-doc">SSAO</a> textures for a render target.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1ToneMapping.html" class="m-doc">ToneMapping</a> <span class="m-doc">Component which stores Tone Mapping configuration for a render target.</span></li>
<li>class <a href="classcubos_1_1engine_1_1Toolbox.html" class="m-doc">Toolbox</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Manages the visibility of each tool.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1Torque.html" class="m-doc">Torque</a> <span class="m-doc">Component which holds torque applied on a body.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UICanvas.html" class="m-doc">UICanvas</a> <span class="m-doc">Component which represents a target for UI rendering.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1UIColorRect.html" class="m-doc">UIColorRect</a> <span class="m-doc">Component that draws a UI element as a solid color.</span></li>
Expand All @@ -566,6 +568,8 @@ <h1>Classes</h1>
<li>class <a href="classcubos_1_1engine_1_1VoxelGrid.html" class="m-doc">VoxelGrid</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Represents a voxel object using a 3D grid.</span></li>
<li>class <a href="classcubos_1_1engine_1_1VoxelGridBridge.html" class="m-doc">VoxelGridBridge</a> <span class="m-doc">Bridge which loads and saves Grid assets.</span></li>
<li>struct <a href="structcubos_1_1engine_1_1VoxelMaterial.html" class="m-doc">VoxelMaterial</a> <span class="m-doc">Describes a voxel material.</span></li>
<li>class <a href="classcubos_1_1engine_1_1VoxelModel.html" class="m-doc">VoxelModel</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Holds the data loaded from voxel model files, such as Qubicle models.</span></li>
<li>class <a href="classcubos_1_1engine_1_1VoxelModelBridge.html" class="m-doc">VoxelModelBridge</a> <span class="m-doc">Bridge which loads and saves <a href="classcubos_1_1engine_1_1VoxelModel.html" class="m-doc">VoxelModel</a> assets.</span></li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1engine_1_1VoxelPalette.html" class="m-doc">VoxelPalette</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Holds a palette of materials. Supports up to 65535 materials.</span>
<ul class="m-doc">
Expand All @@ -581,8 +585,6 @@ <h1>Classes</h1>
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacetesseratos.html" class="m-doc">tesseratos</a> <span class="m-doc"><a href="group__tesseratos.html" class="m-doc">Tesseratos</a> namespace.</span>
<ul class="m-doc">
<li>struct <a href="structtesseratos_1_1AssetSelectedEvent.html" class="m-doc">AssetSelectedEvent</a> <span class="m-doc">Event sent when an asset is selected.</span></li>
<li>struct <a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> <span class="m-doc">Resource which identifies the currently selected entity.</span></li>
<li>class <a href="classtesseratos_1_1Toolbox.html" class="m-doc">Toolbox</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Resource which manages other tools windows.</span></li>
</ul>
</li>
</ul>
Expand Down
98 changes: 97 additions & 1 deletion preview/pr-1338/classcubos_1_1engine_1_1Assets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ <h2><a href="#pub-types">Public types</a></h2>
<span class="m-doc-wrap-bumper">enum class <a href="#a5b5adddb5a35766e6213ff1cb4adbe96" class="m-doc">Status</a> { </span><span class="m-doc-wrap"><a href="#a5b5adddb5a35766e6213ff1cb4adbe96a88183b946cc5f0e8c96b2e66e1c74a7e" class="m-doc">Unknown</a>,
<a href="#a5b5adddb5a35766e6213ff1cb4adbe96aa5ae20aa7fda5bd38bf0dce98e65bd2d" class="m-doc">Unloaded</a>,
<a href="#a5b5adddb5a35766e6213ff1cb4adbe96a16bfbf9c462762cf1cba4134ec53c504" class="m-doc">Loading</a>,
<a href="#a5b5adddb5a35766e6213ff1cb4adbe96a7381d487d18845b379422325c0a768d6" class="m-doc">Loaded</a> }</span>
<a href="#a5b5adddb5a35766e6213ff1cb4adbe96a7381d487d18845b379422325c0a768d6" class="m-doc">Loaded</a>,
<a href="#a5b5adddb5a35766e6213ff1cb4adbe96ad7c8c85bf79bbe1b7188497c32c3b0ca" class="m-doc">Failed</a> }</span>
</dt>
<dd>Possible statuses for an asset.</dd>
</dl>
Expand All @@ -97,6 +98,14 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<span class="m-doc-wrap-bumper">void <a href="#aa969a9a1dd0c38baf813843bfe428ef1" class="m-doc-self">cleanup</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Cleans up all assets that are not in use. Should be called periodically to free up memory.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#a6dfa5eea8f8b92c68f2bd061701fd5aa" class="m-doc">importAll</a>(</span><span class="m-doc-wrap">std::string_view path)</span>
</dt>
<dd>Similar to <a href="classcubos_1_1engine_1_1Assets.html#ae64176ab58187c7cd8bee61f871618e3" class="m-doc">loadMeta</a>, but also creates new .meta files with random UUIDs for files without one.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#afe605fbd4ed9e0d3aa2aa4069df789f1" class="m-doc">find</a>(</span><span class="m-doc-wrap">std::string_view path) -&gt; <a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a></span>
</dt>
<dd>Obtains an asset handle with an UUID from a path.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#ae64176ab58187c7cd8bee61f871618e3" class="m-doc">loadMeta</a>(</span><span class="m-doc-wrap">std::string_view path)</span>
</dt>
Expand Down Expand Up @@ -126,6 +135,11 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<span class="m-doc-wrap-bumper">auto <a href="#a1516e8aa8d7184fdfbc6f73e7cc625be" class="m-doc">read</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>&lt;T&gt; handle) const -&gt; <a href="group__assets-plugin.html#gaceca2b8de7d01d914f7d9ce5fffd40a5" class="m-doc">AssetRead</a>&lt;T&gt;</span>
</dt>
<dd>Gets read-only access to the asset data associated with the given handle.</dd>
<dt>
<div class="m-doc-template">template&lt;typename T&gt;</div>
<span class="m-doc-wrap-bumper">auto <a href="#afe23255c25feadfededb64a76ef6c26c" class="m-doc">tryRead</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>&lt;T&gt; handle) const -&gt; <a href="classcubos_1_1core_1_1memory_1_1Opt.html" class="m-doc">core::<wbr />memory::<wbr />Opt</a>&lt;<a href="group__assets-plugin.html#gaceca2b8de7d01d914f7d9ce5fffd40a5" class="m-doc">AssetRead</a>&lt;T&gt;&gt;</span>
</dt>
<dd>Gets read-only access to the asset data associated with the given handle.</dd>
<dt>
<div class="m-doc-template">template&lt;typename T&gt;</div>
<span class="m-doc-wrap-bumper">auto <a href="#acb41ad9267389341425706213c464ddf" class="m-doc">write</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>&lt;T&gt; handle) -&gt; <a href="group__assets-plugin.html#ga3befb4912d95d097c98bc627a8e7cf97" class="m-doc">AssetWrite</a>&lt;T&gt;</span>
Expand Down Expand Up @@ -207,6 +221,12 @@ <h3>
<p>The asset is loaded.</p>
</td>
</tr>
<tr>
<td><a href="#a5b5adddb5a35766e6213ff1cb4adbe96ad7c8c85bf79bbe1b7188497c32c3b0ca" class="m-doc-self" id="a5b5adddb5a35766e6213ff1cb4adbe96ad7c8c85bf79bbe1b7188497c32c3b0ca">Failed</a></td>
<td>
<p>The asset failed to load.</p>
</td>
</tr>
</tbody>
</table>
</div></section>
Expand Down Expand Up @@ -236,6 +256,46 @@ <h3>
</table>
<p>If more than one extension match a given asset&#x27;s name, the longest extension is picked.</p>
</div></section>
<section class="m-doc-details" id="a6dfa5eea8f8b92c68f2bd061701fd5aa"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />engine::<wbr />Assets::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6dfa5eea8f8b92c68f2bd061701fd5aa" class="m-doc-self">importAll</a>(</span><span class="m-doc-wrap">std::string_view path)</span></span>
</h3>
<p>Similar to <a href="classcubos_1_1engine_1_1Assets.html#ae64176ab58187c7cd8bee61f871618e3" class="m-doc">loadMeta</a>, but also creates new .meta files with random UUIDs for files without one.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">path</td>
<td>Path to load metadata from.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="afe605fbd4ed9e0d3aa2aa4069df789f1"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="classcubos_1_1engine_1_1AnyAsset.html" class="m-doc">AnyAsset</a> cubos::<wbr />engine::<wbr />Assets::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#afe605fbd4ed9e0d3aa2aa4069df789f1" class="m-doc-self">find</a>(</span><span class="m-doc-wrap">std::string_view path)</span></span>
</h3>
<p>Obtains an asset handle with an UUID from a path.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">path</td>
<td>Path to get handle from.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> handle with the found UUID, or null if not found.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="ae64176ab58187c7cd8bee61f871618e3"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />engine::<wbr />Assets::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae64176ab58187c7cd8bee61f871618e3" class="m-doc-self">loadMeta</a>(</span><span class="m-doc-wrap">std::string_view path)</span></span>
Expand Down Expand Up @@ -408,6 +468,42 @@ <h3>
</tfoot>
</table>
<p>If the asset is not loaded, this blocks until it is. If the asset cannot be loaded, abort is called.</p>
</div></section>
<section class="m-doc-details" id="afe23255c25feadfededb64a76ef6c26c"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper"><a href="classcubos_1_1core_1_1memory_1_1Opt.html" class="m-doc">core::<wbr />memory::<wbr />Opt</a>&lt;<a href="group__assets-plugin.html#gaceca2b8de7d01d914f7d9ce5fffd40a5" class="m-doc">AssetRead</a>&lt;T&gt;&gt; cubos::<wbr />engine::<wbr />Assets::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#afe23255c25feadfededb64a76ef6c26c" class="m-doc-self">tryRead</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>&lt;T&gt; handle) const</span></span>
</h3>
<p>Gets read-only access to the asset data associated with the given handle.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">T</td>
<td>Type of the asset data.</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>handle</td>
<td>Handle to get the asset data for.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td>Reference to the asset data.</td>
</tr>
</tfoot>
</table>
<p>If the asset is not loaded, this blocks until it is. If the asset cannot be loaded, returns a null option.</p>
</div></section>
<section class="m-doc-details" id="acb41ad9267389341425706213c464ddf"><div>
<h3>
Expand Down
4 changes: 4 additions & 0 deletions preview/pr-1338/classcubos_1_1engine_1_1FileBridge.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
class <a href="classcubos_1_1engine_1_1VoxelGridBridge.html" class="m-doc">VoxelGridBridge</a>
</dt>
<dd>Bridge which loads and saves Grid assets.</dd>
<dt>
class <a href="classcubos_1_1engine_1_1VoxelModelBridge.html" class="m-doc">VoxelModelBridge</a>
</dt>
<dd>Bridge which loads and saves <a href="classcubos_1_1engine_1_1VoxelModel.html" class="m-doc">VoxelModel</a> assets.</dd>
<dt>
class <a href="classcubos_1_1engine_1_1VoxelPaletteBridge.html" class="m-doc">VoxelPaletteBridge</a>
</dt>
Expand Down
Loading

0 comments on commit fe251d0

Please sign in to comment.