1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# celeritas-core
Celeritas is an engine 'core' written in C that acts as an extendable base layer for creating custom game-specific "engines" (frameworks). It includes helpful wrappers around input handling, cameras, rendering abstractions, and other helpful APIs for making games and binding to other languages' FFIs.
Higher-level concepts can then be overlaid on top of this core!
**Work-in-progress**: This code is currently in flux as I experiment with APIs and is ultimately intended to support a 3D game I'm in the process of making.
All third-party dependencies are licensed under their own license.
## Project Structure
```
/bindgen - bindings code generation for other languages
/deps - third-party dependencies
/docs - high-level documentation
/scripts
```
## Developing
#### Handy commands
* Check symbols in an 'archive' (static library)
* `nm -C build/libcore.a`
* Generate compiler_commands.json
* `xmake project -k compile_commands`
* Formatting
* `xmake format`
* Lint (no change) `find src/ -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror`
* Format (edit in place) `find src/ \( -iname "*.h" -o -iname "*.c" \) | xargs clang-format -i --style=file`
* `clang-format` must be installed!
* Documentation
* serve mkdocs locally
* `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
* Build docs static site
* `docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`
## TODO
#### Engine
- [ ] Embedded assets - shaders, textures, et al (probably will use C23's `#embed`?)
- [ ] Shader hot-reloading
- [ ] Cross-platform threadpool
- [ ] Frame pacing
- [ ] Logging
- [x] level-based logging
- [ ] log level with module granularity
- [ ] multithreaded buffered logging
- Strings
- [x] custom fat pointer string type
- [ ] utf8 handling
- Maths
- [x] Vector functions
- [x] Mat4 functions
- [ ] SIMD 4x4 multiply
- [ ] Quaternion functions (not fully fleshed out)
- [ ] Transform gizmo
- [ ] Mesh generation
- [x] Cube
- [x] Plane
- [x] Sphere
- [ ] Cylinder
- [ ] Cone
- [ ] Torus
- [ ] Prism
- [ ] Bindings generation (targets: rust, odin, zig, ocaml) (future)
#### Memory
- [x] Arena allocator
- [x] malloc backed
- [ ] overcommit address-space backed (`VirtualAlloc` & `mmap`)
- [x] Pool allocator (typed)
- [ ] Generational handles
- [ ] SoA hot/cold pool allocator (pool for all entities of same type, split into two structs in SoA so we can have hot ,(`VkHandle`and cold `size`, `format` data separated)) (future)
#### Scene
- [ ] Transform hierarchy / Scene tree
- [ ] Transform propagation
- [ ] Asset streaming
#### Renderer
- [ ] PBR
- [x] Basic implementation using learnopengl
- [ ] Implementation using Google filament as a reference for first in class PBR
- [ ] Handle metallic / roughness being in different channels, combined, or absent
- [ ] Shadows
- [x] Shadowmaps
- [ ] PCF
- [ ] Cascading shadowmaps (CSM)
- [ ] Point light shadows
- [ ] Resizing viewport
- [ ] Debug views (shadow map quad, etc)
- [ ] Cel shading
- [ ] rim light
- [ ] fresnel
- [ ] outline
- [ ] Instanced rendering
- [ ] instanced grass
- [ ] Terrain
- [ ] Heightmaps
- [ ] Chunking + culling
- [ ] Terrain editing (in-game)
- [ ] SSAO
- [ ] depth pre-pass
- [ ] Water
- [ ] water plane
- [ ] Animation
- [x] Joint and keyframe loading
- [ ] Handle multiple animations in one GLTF
- [ ] Animation Blending
- [ ] Frustum culling (CPU)
- [ ] Postprocessing stack
- *TBD*
- [ ] Imposters
- [ ] Volumetric clouds (future)
- [ ] Global illumination (future)
- [ ] GPU-driven rendering (future)
#### RAL
- [x] Buffer/texture creation
- [x] Graphics pipeline creation/deletion
- [ ] Compute shader pipeline creation/deletion/run
#### Physics
- [ ] Ground check against heightmap terrain or simple plane
- [ ] Jolt integration
- [ ] In-house Collision detection
#### UI
*TBD*
- buttons
- text inputs
- colour picker
- file drag-and-drop
- dock-able (sub)windows
- node graph editor
#### Logistics
- [ ] Replace screenshot with one using PBR + skybox + shadows
- [ ] Update website
- [ ] Check licenses of assets currently in `assets` folder
|
