2020-01-26 19:29:02 +00:00
|
|
|
# Monado
|
|
|
|
|
|
2020-10-30 22:05:10 +00:00
|
|
|
<!--
|
2021-04-30 21:35:40 +00:00
|
|
|
Copyright 2018-2021, Collabora, Ltd. and the Monado contributors
|
2020-10-30 22:05:10 +00:00
|
|
|
SPDX-License-Identifier: BSL-1.0
|
|
|
|
|
-->
|
|
|
|
|
|
2020-01-26 19:29:02 +00:00
|
|
|
This documentation is intended for developers wanting to dive into the code of
|
2020-05-26 17:03:57 +00:00
|
|
|
Monado. And assumes that you have read [README.md][], the file also holds
|
2020-01-26 19:29:02 +00:00
|
|
|
getting started information and general documentation.
|
|
|
|
|
|
2020-02-26 12:01:30 +00:00
|
|
|
## Useful pages
|
|
|
|
|
|
2021-03-01 19:41:45 +00:00
|
|
|
* @ref CHANGELOG - If this is the web version of the docs, the changelog also
|
2021-03-01 19:30:57 +00:00
|
|
|
includes a section for changes that have not yet been in a tagged release.
|
2021-04-30 21:35:40 +00:00
|
|
|
* @ref conventions
|
2021-06-18 15:56:00 +00:00
|
|
|
* @ref understanding-targets - How all the pieces (`xrt_instance`, IPC, OpenXR)
|
|
|
|
|
fit together.
|
2020-11-24 23:35:11 +00:00
|
|
|
* @ref vulkan-extensions
|
2021-11-03 21:10:40 +00:00
|
|
|
* @ref writing-driver
|
2021-02-02 15:37:48 +00:00
|
|
|
* @ref ipc-design
|
2022-01-18 19:51:16 +00:00
|
|
|
* @ref frame-pacing
|
2021-05-01 02:07:50 +00:00
|
|
|
* @ref tracing
|
2021-09-13 23:00:08 +00:00
|
|
|
* @ref implementing-extension
|
2022-03-21 21:23:50 +00:00
|
|
|
* @ref howto-remote-driver
|
2020-01-26 19:29:02 +00:00
|
|
|
|
2020-05-26 17:03:57 +00:00
|
|
|
## Source layout
|
2020-01-26 19:29:02 +00:00
|
|
|
|
2020-05-26 17:03:57 +00:00
|
|
|
* src/xrt/include - @ref xrt_iface defines the internal interfaces of Monado.
|
|
|
|
|
* src/xrt/drivers - Hardware @ref drv.
|
|
|
|
|
* src/xrt/compositor - @ref comp code for doing distortion and driving the
|
|
|
|
|
display hardware of a device.
|
|
|
|
|
* src/xrt/state_trackers/oxr - @ref oxr, implements the OpenXR API.
|
|
|
|
|
* src/xrt/state_trackers/gui - @ref gui, various helper and debug GUI code.
|
|
|
|
|
* src/xrt/auxiliary - @ref aux and other larger components, like @ref
|
|
|
|
|
aux_tracking and @ref aux_math.
|
|
|
|
|
* src/xrt/targets - glue code and build logic to produce final binaries.
|
|
|
|
|
* src/external - a small collection of external code and headers.
|
2020-01-26 19:29:02 +00:00
|
|
|
|
|
|
|
|
[README.md]: https://gitlab.freedesktop.org/monado/monado
|
