- Generated by
1.9.4
|
Monado OpenXR Runtime
|
This documentation is intended for developers wanting to dive into the code of Monado. It also assumes that you have read README.md: that file also holds getting started information and general documentation.
This documentation is maintained in part in documentation comments in the code itself, extracted and rendered by Doxygen. These extracted documentation pages are best browsed through the "Modules" or "Files" links above. (The directory structure matches the top levels of modules, but some are sub-divided further into sub-modules within a directory.)
There are also a number of pages in this site (including this one) that are maintained as fully human-authored Markdown files outside of source code files, but still in the repository in the doc/ directory. Some are linked below in a logical outline, and some documentation comments in code cross-reference these pages. See the "Related Pages" link above for a complete list of these non-code-based documentation pages. (Since they are not maintained in the source code files directly, they may sometimes be slightly out-of-date, so in case of conflict, the code-based documentation is correct. Please submit a merge request to fix any such issues you may notice.)
If you are viewing this on the web at https://monado.pages.freedesktop.org/monado/, the changelog above also includes a section for changes that have not yet been in a tagged release.
Monado is architected as a collection of loosely-coupled, internally cohesive components that interact through the internal, abstract "XRT" (XrRunTime) API. State Trackers consume implementations of these APIs provided by other modules.
xrt_instance, IPC, OpenXR, etc) are brought together for use.The key interfaces to begin learning Monado are:
Here is the documentation for all XRT interfaces used to interact between modules.
1.9.4