diff options
| author | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 11:03:21 +1000 |
|---|---|---|
| committer | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 11:03:21 +1000 |
| commit | f926234600af1883c2be259360b44173bb7c12b4 (patch) | |
| tree | 8938056cf43f7fc1fa5c2362ee022c5599ac8b28 /docs | |
| parent | 0942a484a90695749f05d49273951f2b8d452866 (diff) | |
updating docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 4 | ||||
| -rw-r--r-- | docs/project-layout.md | 27 | ||||
| -rw-r--r-- | docs/rendering.md | 2 |
3 files changed, 26 insertions, 7 deletions
diff --git a/docs/index.md b/docs/index.md index 54d6383..f71d8fe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,9 +30,7 @@ Celeritas is the original Latin word for celerity that the English is derived fr **Roadmap going forwards** -* Collision detection -* Terrain rendering -* GPU-driven rendering +[See here (README)](https://github.com/omnisci3nce/celeritas-core/blob/winter-cleaning/README.md#todo) ## Getting started diff --git a/docs/project-layout.md b/docs/project-layout.md index 74a84aa..3d8f466 100644 --- a/docs/project-layout.md +++ b/docs/project-layout.md @@ -1,9 +1,30 @@ --- -title: Project Layout +title: Project Structure --- ``` deps/ - third-party dependencies docs/ - these docs you're reading now that get built with mkdocs -TODO: the rest... -```
\ No newline at end of file +src/ + core/ - core game engine facilities + logos/ - + maths/ + platform/ + ral/ + render/ + resources/ + std/ + systems/ + ui/ +``` + + +#### Core + +Core holds specifically functionality vital to making games or 3D applications. Contrast this with `std` which contains +code that could form the base layer of almost any software out there. + +#### Std + +Data structures, algorithms, memory management, etc - all code here forms a foundation for everything above it and can conceivably +be reused in non-game applications.
\ No newline at end of file diff --git a/docs/rendering.md b/docs/rendering.md index 05da5fc..f23fbd1 100644 --- a/docs/rendering.md +++ b/docs/rendering.md @@ -3,5 +3,5 @@ Rendering is split into 3 'registers'. 1. **RAL** (Render Abstraction Layer) - thin abstraction over graphics APIs -2. **render** - implements the default renderer and higher-level functions like `draw_scene` +2. **render** - implements the default renderer and higher-level functions 3. **immediate** - immediate-mode drawing API for things like debug visualisation and UI
\ No newline at end of file |