![]() |
vkmEngine 1.0.0
A C++ game engine · vkmengine.com
|
A C++17 engine with an OpenGL 4.3 backend, for Windows and Linux, that runs projects. It holds no game of its own: a game is a directory - a project.json, its scenes and assets, and gameplay code built into its own module - and the same four executables run any of them.
This is the generated reference for the types a project compiles against. It is not the manual. The manual is in docs/, and it is the better place to start:
| If you are | Start at |
|---|---|
| Writing gameplay | Vkm::Engine::Behavior, Vkm::Engine::BehaviorContext |
| Building a world in code | Vkm::Engine::Scene, Vkm::Engine::EntityId |
| Loading or making assets | Vkm::Engine::ResourceManager, Vkm::Engine::Handle |
| Reacting to things | Vkm::Engine::EventBus, Vkm::Engine::FrameContext |
| Writing a system | Vkm::Engine::System, Vkm::Engine::SystemStage |
Everything under Vkm::Engine that a project can include is public surface. Vkm::GL is the platform layer and is versioned separately. Anything in a detail namespace is not public and will move without notice.