forked from RigsOfRods/rigs-of-rods
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📚 Doxygen: added codebase overview page
- Loading branch information
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
/*! | ||
* @page Codebase overview | ||
* | ||
* # The application | ||
* | ||
* Rigs of Rods is a monolithic C++ program with it's own main input/rendering loop. | ||
* The entry point is a standard main() function which performs all initialization, message processing and cleanup. | ||
* | ||
* # Input handling | ||
* Inputs are received via OIS library's listener mechanism. | ||
* Class RoR::AppContext is the sole listener for all inputs and serves as a dispatcher between various subsystems. | ||
* Gameplay inputs are defined by enum events and handled by InputEngine. RoR::InputEngine also reads input configuration files '*.map', the default being 'input.map'. | ||
* | ||
* # Rendering | ||
* Graphical output is done via OGRE 3D rendering engine (not to be confused with game engine). | ||
* Startup is done by RoR::AppContext::SetUpRendering(). | ||
* Window events are handled by RoR::AppContext via OGRE's OgreBites::WindowEventListener. Note Ogre::FrameListener interface is not used, we roll our own rendering loop in main(). | ||
* | ||
* | ||
* | ||
* | ||
*/ |