diff options
Diffstat (limited to 'scripts')
-rw-r--r-- | scripts/apidocs/gen_apidocs.py | 8 | ||||
-rw-r--r-- | scripts/apidocs/index.html | 18 |
2 files changed, 22 insertions, 4 deletions
diff --git a/scripts/apidocs/gen_apidocs.py b/scripts/apidocs/gen_apidocs.py index 390a081..cfce6ec 100644 --- a/scripts/apidocs/gen_apidocs.py +++ b/scripts/apidocs/gen_apidocs.py @@ -1,4 +1,9 @@ # Generates a static webpage for the public C-API of `celeritas-core` +# +# TODO: +# - remove prefixes like 'static' and 'inline' +# - parse docstrings from source + import re import os from pathlib import Path @@ -52,7 +57,8 @@ def emit_function_sig(signature: str) -> str: categories = { "RAL": "src/ral", - "Render": "src/new_render" + "Render": "src/new_render", + "Maths": "src/maths" } def find_pub_functions_in_folder(folder_path): diff --git a/scripts/apidocs/index.html b/scripts/apidocs/index.html index 878b7f9..0c19c0c 100644 --- a/scripts/apidocs/index.html +++ b/scripts/apidocs/index.html @@ -20,7 +20,7 @@ <main> <header> - <h1>CELERITAS CORE</h1> + <h1>CELERITAS CORE DOCS</h1> </header> <h3>RAL</h3><ul class="category-list"> <li class="signature"> @@ -40,6 +40,14 @@ </li> <li class="signature"> + <pre><code class="language-c">void GPU_CmdEncoder_Begin(GPU_CmdEncoder* encoder)</code></pre> + </li> + + <li class="signature"> + <pre><code class="language-c">void GPU_CmdEncoder_Finish(GPU_CmdEncoder* encoder)</code></pre> + </li> + + <li class="signature"> <pre><code class="language-c">void GPU_CmdEncoder_BeginRender(GPU_CmdEncoder* encoder, GPU_Renderpass* renderpass)</code></pre> </li> @@ -80,7 +88,7 @@ </li> <li class="signature"> - <pre><code class="language-c">void GPU_EncodeBindShaderData(GPU_CmdEncoder* encoder, u32 group, ShaderData* data)</code></pre> + <pre><code class="language-c">void GPU_EncodeBindShaderData(GPU_CmdEncoder* encoder, u32 group, ShaderData data)</code></pre> </li> <li class="signature"> @@ -200,7 +208,7 @@ </li> <li class="signature"> - <pre><code class="language-c">void Shadow_Init(Shadow_Storage* storage)</code></pre> + <pre><code class="language-c">void Shadow_Init(Shadow_Storage* storage, u32x2 shadowmap_extents)</code></pre> </li> <li class="signature"> @@ -230,6 +238,10 @@ <li class="signature"> <pre><code class="language-c">void Skybox_Draw(Skybox* skybox)</code></pre> </li> + </ul><h3>Maths</h3><ul class="category-list"> + <li class="signature"> + <pre><code class="language-c">static inline Vec3 vec3_create(f32 x, f32 y, f32 z)</code></pre> + </li> </ul> </main> </body> |