monado/doc/mainpage.md

Monado

This documentation is intended for developers wanting to dive into the code of Monado. And assumes that you have read README.md, the file also holdss getting started information and general documentation.

Useful pages

• @ref md_writing-a-new-driver (not complete)

Source layout

• 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.