Skip to content

Commit

Permalink
Deploy preview for PR 926 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@RiscadoA
RiscadoA committed Jan 31, 2024
1 parent c21c7f9 commit c3a9b4f
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 31 deletions.
27 changes: 0 additions & 27 deletions docs-preview/pr-926/classcubos_1_1core_1_1ecs_1_1Dispatcher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,11 @@ <h3>Contents</h3>
<li>
Reference
<ul>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
</ul>
</li>
</ul>
</nav>
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper"><a href="#a71d880b9191efdb6269c0c2d0fa6f7bd" class="m-doc">Dispatcher</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world)</span>
</dt>
<dd>Constructs.</dd>
</dl>
</section>
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
Expand Down Expand Up @@ -126,23 +116,6 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="a71d880b9191efdb6269c0c2d0fa6f7bd"><div>
<h3>
<span class="m-doc-wrap-bumper"> cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a71d880b9191efdb6269c0c2d0fa6f7bd" class="m-doc-self">Dispatcher</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world)</span></span>
</h3>
<p>Constructs.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">world</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a82553ac4bd873b2a01ea453a110bd87a"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a82553ac4bd873b2a01ea453a110bd87a" class="m-doc-self">addTag</a>(</span><span class="m-doc-wrap">const std::string&amp; tag)</span></span>
Expand Down
6 changes: 3 additions & 3 deletions docs-preview/pr-926/classcubos_1_1core_1_1ecs_1_1System.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2><a href="#pub-static-methods">Public static functions</a></h2>
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper"><a href="#a3f2267a04b11165efb74c2e17135f38e" class="m-doc">System</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a>&amp;&amp; system) <span class="m-label m-flat m-info">defaulted</span></span>
<span class="m-doc-wrap-bumper"><a href="#abf5d26910e0ac4158398656b8a704807" class="m-doc">System</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a>&amp;&amp; system) <span class="m-label m-flat m-info">defaulted</span> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Move constructs.</dd>
</dl>
Expand Down Expand Up @@ -141,12 +141,12 @@ <h3>
</table>
<p>The first option is applied to the first argument which requests it, and the same for subsequent options. If there are more options than arguments which request them, aborts. Otherwise, if there are more arguments requesting options than supplied options, the remaining arguments are assigned default-value options.</p>
</div></section>
<section class="m-doc-details" id="a3f2267a04b11165efb74c2e17135f38e"><div>
<section class="m-doc-details" id="abf5d26910e0ac4158398656b8a704807"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper"> cubos::<wbr />core::<wbr />ecs::<wbr />System&lt;T&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3f2267a04b11165efb74c2e17135f38e" class="m-doc-self">System</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a>&amp;&amp; system) <span class="m-label m-info">defaulted</span></span></span>
<span class="m-doc-wrap-bumper"> cubos::<wbr />core::<wbr />ecs::<wbr />System&lt;T&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abf5d26910e0ac4158398656b8a704807" class="m-doc-self">System</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a>&amp;&amp; system) <span class="m-label m-info">defaulted</span> <span class="m-label m-success">noexcept</span></span></span>
</h3>
<p>Move constructs.</p>
<table class="m-table m-fullwidth m-flat">
Expand Down
113 changes: 113 additions & 0 deletions docs-preview/pr-926/classcubos_1_1core_1_1ecs_1_1SystemFetcher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,119 @@ <h1>
</tr>
</tbody>
</table>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#pub-static-attribs">Public static variables</a></li>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
</ul>
</li>
</ul>
</nav>
<section id="pub-static-attribs">
<h2><a href="#pub-static-attribs">Public static variables</a></h2>
<dl class="m-doc">
<dt id="a1980969a6b6c644e222b3bb2c372d890">
static bool <a href="#a1980969a6b6c644e222b3bb2c372d890" class="m-doc-self">ConsumesOptions</a> <span class="m-label m-flat m-primary">constexpr</span>
</dt>
<dd>Indicates whether this argument type consumes system options.</dd>
</dl>
</section>
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper"><a href="#aa1ff80f1c2f67efeb02e5b7a4b19561c" class="m-doc">SystemFetcher</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world,
const <a href="structcubos_1_1core_1_1ecs_1_1SystemOptions.html" class="m-doc">SystemOptions</a>&amp; options)</span>
</dt>
<dd>Called when a system is constructed for the first time.</dd>
</dl>
</section>
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">void <a href="#a566abe2156d2898e356dda05fec6b8c4" class="m-doc">analyze</a>(</span><span class="m-doc-wrap"><a href="structcubos_1_1core_1_1ecs_1_1SystemAccess.html" class="m-doc">SystemAccess</a>&amp; access) const</span>
</dt>
<dd>Called to determine the access patterns of the argument.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a31c74f7b8fb6dd529a8942bfe2238575" class="m-doc">fetch</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmdBuffer) -&gt; T</span>
</dt>
<dd>Called each system run to fetch the data from the world.</dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="aa1ff80f1c2f67efeb02e5b7a4b19561c"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper"> cubos::<wbr />core::<wbr />ecs::<wbr />SystemFetcher&lt;T&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa1ff80f1c2f67efeb02e5b7a4b19561c" class="m-doc-self">SystemFetcher</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world,
const <a href="structcubos_1_1core_1_1ecs_1_1SystemOptions.html" class="m-doc">SystemOptions</a>&amp; options)</span></span>
</h3>
<p>Called when a system is constructed for the first time.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">world</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a> to extract data from.</td>
</tr>
<tr>
<td>options</td>
<td>Argument options.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a566abe2156d2898e356dda05fec6b8c4"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />SystemFetcher&lt;T&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a566abe2156d2898e356dda05fec6b8c4" class="m-doc-self">analyze</a>(</span><span class="m-doc-wrap"><a href="structcubos_1_1core_1_1ecs_1_1SystemAccess.html" class="m-doc">SystemAccess</a>&amp; access) const</span></span>
</h3>
<p>Called to determine the access patterns of the argument.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">access&nbsp;<span class="m-label m-flat m-warning">out</span></td>
<td>Access patterns to add info to.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a31c74f7b8fb6dd529a8942bfe2238575"><div>
<h3>
<div class="m-doc-template">
template&lt;typename T&gt;
</div>
<span class="m-doc-wrap-bumper">T cubos::<wbr />core::<wbr />ecs::<wbr />SystemFetcher&lt;T&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a31c74f7b8fb6dd529a8942bfe2238575" class="m-doc-self">fetch</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmdBuffer)</span></span>
</h3>
<p>Called each system run to fetch the data from the world.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">cmdBuffer</td>
<td>Command buffer.</td>
</tr>
</tbody>
</table>
</div></section>
</section>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs-preview/pr-926/searchdata-v2.js
View file

Large diffs are not rendered by default.

0 comments on commit c3a9b4f

Please sign in to comment.