mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-03-03 21:26:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

comp: Improve docs on comp_target_swapchain

Browse source
This commit is contained in:
Ryan Pavlik 2021-04-13 11:30:34 -05:00
parent 1e1fe01374
commit cb2710db87
1 changed files with 19 additions and 1 deletions

20
src/xrt/compositor/main/comp_target_swapchain.h
View file

@ -76,7 +76,23 @@ struct comp_target_swapchain
*/
/*!
* Pre Vulkan initialisation, sets function pointers.
* @brief Pre Vulkan initialisation, sets function pointers.
*
* Call from the creation function for your "subclass", after allocating.
*
* Initializes these function pointers, all other methods of @ref comp_target are the responsibility of the caller (the
* "subclass"):
*
* - comp_target::create_images
* - comp_target::acquire
* - comp_target::present
* - comp_target::calc_frame_timings
* - comp_target::mark_timing_point
* - comp_target::update_timings
*
* Also sets comp_target_swapchain::timing_usage to the provided value.
*
* @protected @memberof comp_target_swapchain
*
* @ingroup comp_main
*/
@ -88,6 +104,8 @@ comp_target_swapchain_init_and_set_fnptrs(struct comp_target_swapchain *cts,
* Free all managed resources on the given @ref comp_target_swapchain,
* does not free the struct itself.
*
* @protected @memberof comp_target_swapchain
*
* @ingroup comp_main
*/
void