diff options
| author | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 12:08:41 +1000 |
|---|---|---|
| committer | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-07-19 12:08:41 +1000 |
| commit | 5359c011a08ef2e06ed54104cc16c32868ca88ff (patch) | |
| tree | cc644bb54934fb5d1980bd502c6f93e3737505da /docs | |
| parent | f926234600af1883c2be259360b44173bb7c12b4 (diff) | |
docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/project-layout.md | 6 | ||||
| -rw-r--r-- | docs/rendering.md | 10 | ||||
| -rw-r--r-- | docs/using-celeritas.md | 10 |
3 files changed, 22 insertions, 4 deletions
diff --git a/docs/project-layout.md b/docs/project-layout.md index 3d8f466..9a33e8f 100644 --- a/docs/project-layout.md +++ b/docs/project-layout.md @@ -3,8 +3,10 @@ title: Project Structure --- ``` -deps/ - third-party dependencies -docs/ - these docs you're reading now that get built with mkdocs +assets/ - shaders and bundled assets for examples (must be licensed open) +bindgen/ - bindings generation +deps/ - third-party dependencies +docs/ - these docs you're reading now that get built with mkdocs src/ core/ - core game engine facilities logos/ - diff --git a/docs/rendering.md b/docs/rendering.md index f23fbd1..5b1dfe2 100644 --- a/docs/rendering.md +++ b/docs/rendering.md @@ -3,5 +3,11 @@ 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 -3. **immediate** - immediate-mode drawing API for things like debug visualisation and UI
\ No newline at end of file +2. **Render** - implements the default renderer and higher-level functions +3. **Immediate** - immediate-mode drawing API for things like debug visualisation and UI + + +## RAL + +- RAL doesn't know what 'meshes' are or 'materials', it purely deals with buffers, textures, pipelines, etc. Those concepts + are left to the `Render` module.
\ No newline at end of file diff --git a/docs/using-celeritas.md b/docs/using-celeritas.md new file mode 100644 index 0000000..ceb3b7c --- /dev/null +++ b/docs/using-celeritas.md @@ -0,0 +1,10 @@ +--- +title: Using Celeritas +--- + +**TL;DR** + +- use the amalgamation header `celeritas.h` that exposes all public functions in a single header + - _you can recreate it with_ `scripts/amalgamation/gen_header.py` +- link the precompiled `core_static` or `core_shared` libraries +- _or_ compile using `xmake build`, the binaries will be in `build/<os>/x64/core_static`, etc
\ No newline at end of file |