mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-28 02:26:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

c/util: comp_base doc improvement

Browse source 
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2322>
This commit is contained in:
Rylie Pavlik 2024-08-28 11:43:58 -05:00
parent e585d7aa55
commit 59b8b2dbae
1 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/xrt/compositor/util/comp_base.h
View file

@ -41,22 +41,23 @@ struct comp_frame_params
* A simple compositor base that handles a lot of things for you.
*
* Things it handles for you:
* * App swapchains
* * App fences
* * Vulkan bundle (needed for swapchains and fences)
* * Layer tracking, not @ref xrt_compositor::layer_commit
* * Wait function, not @ref xrt_compositor::predict_frame
*
* Functions it does not handle:
* * @ref xrt_compositor::begin_session
* * @ref xrt_compositor::end_session
* * @ref xrt_compositor::predict_frame
* * @ref xrt_compositor::mark_frame
* * @ref xrt_compositor::begin_frame
* * @ref xrt_compositor::discard_frame
* * @ref xrt_compositor::layer_commit
* * @ref xrt_compositor::poll_events
* * @ref xrt_compositor::destroy
* - App swapchains
* - App fences
* - Vulkan bundle (needed for swapchains and fences)
* - Layer tracking, not @ref xrt_compositor::layer_commit
* - Wait function, not @ref xrt_compositor::predict_frame
*
* Functions it does not implement:
*
* - @ref xrt_compositor::begin_session
* - @ref xrt_compositor::end_session
* - @ref xrt_compositor::predict_frame
* - @ref xrt_compositor::mark_frame
* - @ref xrt_compositor::begin_frame
* - @ref xrt_compositor::discard_frame
* - @ref xrt_compositor::layer_commit
* - @ref xrt_compositor::destroy
*
* Partially implements @ref xrt_compositor_native, meant to serve as
* the base of a main compositor implementation.