Monado OpenXR Runtime
comp_documentation.h
Go to the documentation of this file.
1 // Copyright 2019, Collabora, Ltd.
2 // SPDX-License-Identifier: BSL-1.0
3 /*!
4  * @file
5  * @brief Documentation for the compositor.
6  * @author Jakob Bornecrantz <jakob@collabora.com>
7  * @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
8  * @ingroup comp
9  */
10 
11 #pragma once
12 
13 
14 /*!
15  * @defgroup comp Compositor
16  * @ingroup xrt
17  *
18  * @brief All of the compositor code.
19  */
20 
21 /*!
22  * @defgroup comp_main Main compositor code
23  * @ingroup comp
24  *
25  * @brief Main compositor code.
26  */
27 
28 /*!
29  * @defgroup comp_util Compositor utility code
30  * @ingroup comp
31  *
32  * @brief General compositor utility code.
33  */
34 
35 /*!
36  * @defgroup comp_client Compositor client code
37  * @ingroup comp
38  *
39  * @brief Glue code between client program to the main compositor.
40  */
41 
42 /*!
43  * @dir compositor
44  * @ingroup xrt
45  *
46  * @brief All of the compositor code.
47  */
48 
49 /*!
50  * @dir compositor/client
51  * @ingroup comp
52  *
53  * @brief Compositor client code.
54  */
55 
56 /*!
57  * @dir compositor/main
58  * @ingroup comp
59  *
60  * @brief Main compositor code.
61  */