The open source OpenXR runtime
c/util: comp_base doc improvement
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2322>
+16
-15
+16
-15
src/xrt/compositor/util/comp_base.h
+16
-15
src/xrt/compositor/util/comp_base.h
···
41
41
* A simple compositor base that handles a lot of things for you.
42
42
*
43
43
* Things it handles for you:
44
-
* * App swapchains
45
-
* * App fences
46
-
* * Vulkan bundle (needed for swapchains and fences)
47
-
* * Layer tracking, not @ref xrt_compositor::layer_commit
48
-
* * Wait function, not @ref xrt_compositor::predict_frame
49
44
*
50
-
* Functions it does not handle:
51
-
* * @ref xrt_compositor::begin_session
52
-
* * @ref xrt_compositor::end_session
53
-
* * @ref xrt_compositor::predict_frame
54
-
* * @ref xrt_compositor::mark_frame
55
-
* * @ref xrt_compositor::begin_frame
56
-
* * @ref xrt_compositor::discard_frame
57
-
* * @ref xrt_compositor::layer_commit
58
-
* * @ref xrt_compositor::poll_events
59
-
* * @ref xrt_compositor::destroy
45
+
* - App swapchains
46
+
* - App fences
47
+
* - Vulkan bundle (needed for swapchains and fences)
48
+
* - Layer tracking, not @ref xrt_compositor::layer_commit
49
+
* - Wait function, not @ref xrt_compositor::predict_frame
50
+
*
51
+
* Functions it does not implement:
52
+
*
53
+
* - @ref xrt_compositor::begin_session
54
+
* - @ref xrt_compositor::end_session
55
+
* - @ref xrt_compositor::predict_frame
56
+
* - @ref xrt_compositor::mark_frame
57
+
* - @ref xrt_compositor::begin_frame
58
+
* - @ref xrt_compositor::discard_frame
59
+
* - @ref xrt_compositor::layer_commit
60
+
* - @ref xrt_compositor::destroy
60
61
*
61
62
* Partially implements @ref xrt_compositor_native, meant to serve as
62
63
* the base of a main compositor implementation.