helios API Reference
This section contains the Doxygen-generated API reference for the current multi-repository helios modules. The pages are generated from the local sibling repositories during the website build.
For conceptual documentation and module-level README content, see the module overview. This API reference focuses on symbols, namespaces, classes, concepts, files, and generated source-level relationships.
Module API references
| Module | Scope |
|---|---|
| helios::ecs | Generic ECS primitives, typed entity domains, component storage, views, and registries |
| helios::engine | Runtime, world orchestration, rendering abstractions, state, scene, spatial, platform, and utility APIs |
| helios::math | Vector, matrix, transform, projection, and math utility APIs |
| helios::opengl | OpenGL backend integration, shader compilation, render resources, and OpenGL-specific components |
| helios::glfw | GLFW platform/window integration, platform manager, components, systems, and types |
| helios::imgui | Dear ImGui backend, overlay orchestration, log sink, and diagnostics widgets |
Generation model
The API reference is regenerated by npm run convert-doxygen and as part of
npm run build.
helios-ecs/src ┐
helios-engine/src │
helios-math/src ├─ Doxygen XML ─ doxygen2docusaurus ─ docs/api/<module>
helios-opengl/src │
helios-glfw/src │
helios-imgui/src ┘
Generated files are not intended to be edited manually. Update the module source or Doxygen comments in the corresponding repository, then rebuild the website.