Skip to content

Commit b49c80a

Browse files
github-actions[bot]github-actions[bot]
committed
Documentation update
1 parent a4f3da5 commit b49c80a

8 files changed

+657
-6
lines changed

‎.github/cache.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"branches": {
3-
"develop": "02461a3c6350c6f45c2a08c64eae8a35e4bf5aba",
3+
"develop": "64f3108c83dade8a68aa073db722d0445826d1f4",
44
"feature/cppfront": "d516bb81caccb74a44abed908374e990d3dac9a4",
55
"feature/format-parser-v2": "47deb0099368729e68165bc5fd9f536160c34233",
66
"feature/new_format": "1781728a630b072d681a8161e4a939217c2d53f6",
@@ -10,7 +10,6 @@
1010
"improve/android-app-sleep": "3f6db653442c03e14c4877a9ecd7acfb5fcacf9c",
1111
"jdl/bundle-instance-data-abstraction": "8ad7eb52217ffabaf20adc37b7465efcdb959c12",
1212
"jdl/csharp-bindings": "823598c3ede755983ddfeb6bd352241c37d22572",
13-
"jdl/improve-buffer-performance": "02dfdeb07d601d759139657030e09207b4a0e74e",
1413
"jdl/resource_rewrite": "c894b8a566f18f3d6f339bdbf3f69b4a477ff2ad"
1514
},
1615
"generator": "017f4e1d4dcc5b5a5bb16dc1e243557b76b6250f",

‎docs/develop/annotated.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ <h1>classes</h1>
201201
<li> <a href="classpsl_1_1ecs_1_1details_1_1dependency__pack.html" class="m-doc class">dependency_pack</a> <span class="m-doc">describes a set of dependencies for a given system</span></li>
202202
<li> <a href="classpsl_1_1ecs_1_1details_1_1entity__relationship__handler__t.html" class="m-doc class">entity_relationship_handler_t</a> <span class="m-doc">A null implementation of the entity relationship handler.</span></li>
203203
<li> <a href="structpsl_1_1ecs_1_1details_1_1mutate__instruction__t.html" class="m-doc struct">mutate_instruction_t</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Wrapper around a component type to allow for mutations of the given component.</span></li>
204+
<li> <a href="classpsl_1_1ecs_1_1details_1_1system__scheduler__t.html" class="m-doc class">system_scheduler_t</a> <span class="m-doc">Manages the scheduling of systems which are ready to be executed. This scheduler is responsible for ensuring that systems are executed. Internally it will make sure that the system has enough cache to be scheduled, and that the components it has need for are not being used by other systems. If that&#x27;s the case it will immediately run the system on the calling thread. Otherwise it will store the system as a pending task, and once resources are freed up the scheduler will check the pending tasks and try to execute them.</span></li>
204205
</ul>
205206
</li>
206207
<li> <a href="classpsl_1_1ecs_1_1accessor.html" class="m-doc class">accessor</a> <span class="m-doc">A helper class to construct and assign components in case they have private constructors or assignment operators.</span></li>
@@ -265,6 +266,7 @@ <h1>classes</h1>
265266
<li> <a href="classpsl_1_1thread__safety__guard__t_1_1scoped__guard__t.html" class="m-doc class">scoped_guard_t</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">A scoped guard that ensures that the current thread is the only one accessing the guarded scope.</span></li>
266267
</ul>
267268
</li>
269+
<li> <a href="classpsl_1_1thread__safety__noop__guard__t.html" class="m-doc class">thread_safety_noop_guard_t</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">A thread safety guard that does nothing. Mirrors the interface of <a href="classpsl_1_1thread__safety__guard__t.html" class="m-doc">thread_<wbr />safety_<wbr />guard_<wbr />t</a>.</span></li>
268270
<li> <a href="structpsl_1_1_u_i_d.html" class="m-doc struct">UID</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">is an object holding a Unique IDentifier (<a href="structpsl_1_1_u_i_d.html" class="m-doc">UID</a>)</span></li>
269271
<li> <a href="classpsl_1_1view__ptr.html" class="m-doc class">view_ptr</a> <span class="m-doc">a non-owning &#x27;smart&#x27; pointer type</span></li>
270272
</ul>

‎docs/develop/classpsl_1_1ecs_1_1details_1_1dependency__pack.html‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,52 @@ <h1>
4747
<span class="m-breadcrumb"><a href="namespacepsl.html">psl</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacepsl_1_1ecs.html">ecs</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacepsl_1_1ecs_1_1details.html">details</a>::<wbr/></span>dependency_pack <span class="m-thin">class</span>
4848
</h1>
4949
<p>describes a set of dependencies for a given system</p>
50+
51+
<nav class="m-block m-default">
52+
<h3>content</h3>
53+
<ul>
54+
<li><a href="#member-functions">member functions</a></li>
55+
</ul>
56+
</nav>
5057
<p>systems can have various dependencies, for example a movement system could have dependencies on both a psl::ecs::components::transform component and a psl::ecs::components::renderable component. This dependency will output a set of <a href="structpsl_1_1ecs_1_1entity__t.html" class="m-doc">psl::<wbr />ecs::<wbr />entity_t</a>&#x27;s that have all required psl::ecs::components present. Certain systems could have sets of dependencies, for example the render system requires knowing about both all <code>psl::ecs::components::renderable</code> that have a <code>psl::ecs::components::transform</code>, but also needs to know all <code>psl::ecs::components::camera&#x27;s</code>. So that system would require several <a href="classpsl_1_1ecs_1_1details_1_1dependency__pack.html" class="m-doc">dependency_<wbr />pack</a>&#x27;s.</p>
58+
<section id="member-functions">
59+
<h2><a href="#member-functions">member-functions</a></h2>
60+
<dl class="m-doc">
61+
<table style="width:100%">
62+
<tr>
63+
64+
<div class="m-entry-container hoverable" id="abee73dc3b3039447554d9f998afe829d">
65+
<div class="m-entry-row flex" id="brief">
66+
<button class="hiddenbutton" onclick="expandable_node(this.parentNode)"><i class="arrow right"></i></button>
67+
<div class="m-entry header">
68+
<span class="m-doc-wrap-bumper">align_of_first_binding </div>
69+
<div class="m-entry">used in conjunction with size_per_element to determine the overall alignment of a packed array so we can safely allocate memory for it.</div>
70+
<div class="m-entry modifiers"><span><span class="m-label m-flat m-const"> const</span> <span class="m-label m-flat m-public">public</span>
71+
<span class="m-label m-flat m-noexcept">noexcept</span></span></div>
72+
</div>
73+
<div class="m-entry-row flex collapsed" id="expanded">
74+
<div class="m-entry-row flex">
75+
<button class="hiddenbutton" onclick="expandable_node(this.parentNode.parentNode)"><i class="arrow down"></i></button>
76+
<div class="m-entry header" style="width: auto;max-width: unset;">align_of_first_binding</div>
77+
<div class="m-entry modifiers"><span><span class="m-label m-flat m-const"> const</span> <span class="m-label m-flat m-public">public</span>
78+
<span class="m-label m-flat m-noexcept">noexcept</span></span></div>
79+
</div>
80+
<div class="m-entry-row">
81+
</div>
82+
<div class="m-entry-row">
83+
<div class="m-entry header" style="margin-left:1rem;width:6rem;color:#9b9b9b;">returns</div>
84+
<div class="m-entry">size_t</div>
85+
</div>
86+
<div class="m-entry-row">
87+
<div class="m-entry header" style="margin-left:1rem;width:6rem;color:#9b9b9b;">description</div>
88+
<div class="m-entry">used in conjunction with size_per_element to determine the overall alignment of a packed array so we can safely allocate memory for it.</div>
89+
</div>
90+
</div>
91+
</div>
92+
</tr>
93+
</table>
94+
</dl>
95+
</section>
5196
</div>
5297
</div>
5398
</div>

0 commit comments

Comments
 (0)