mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-04 06:06:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

c/util: Documentation

Browse source
This commit is contained in:
Jakob Bornecrantz 2021-11-03 17:45:54 +00:00
parent 029031cfd3
commit c3b8810bb0
5 changed files with 22 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/xrt/compositor/main/comp_documentation.h
View file

@ -25,6 +25,13 @@
* @brief Main compositor code. * @brief Main compositor code.
*/ */
/*!
* @defgroup comp_util Compositor utility code
* @ingroup comp
*
* @brief General compositor utility code.
*/
/*! /*!
* @defgroup comp_client Compositor client code * @defgroup comp_client Compositor client code
* @ingroup comp * @ingroup comp

2
src/xrt/compositor/util/comp_swapchain.c
View file

@ -4,7 +4,7 @@
* @file * @file
* @brief Independent swapchain implementation. * @brief Independent swapchain implementation.
* @author Jakob Bornecrantz <jakob@collabora.com> * @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup comp_main * @ingroup comp_util
*/ */
#include "xrt/xrt_handles.h" #include "xrt/xrt_handles.h"

17
src/xrt/compositor/util/comp_swapchain.h
View file

@ -5,7 +5,7 @@
* @brief Independent swapchain implementation. * @brief Independent swapchain implementation.
* @author Jakob Bornecrantz <jakob@collabora.com> * @author Jakob Bornecrantz <jakob@collabora.com>
* @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com> * @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
* @ingroup comp_main * @ingroup comp_util
*/ */
#pragma once #pragma once
@ -23,6 +23,8 @@ extern "C" {
/*! /*!
* A garbage collector that collects swapchains to be safely destroyed. * A garbage collector that collects swapchains to be safely destroyed.
*
* @ingroup comp_util
*/ */
struct comp_swapchain_gc struct comp_swapchain_gc
{ {
@ -33,7 +35,7 @@ struct comp_swapchain_gc
/*! /*!
* A single swapchain image, holds the needed state for tracking image usage. * A single swapchain image, holds the needed state for tracking image usage.
* *
* @ingroup comp_main * @ingroup comp_util
* @see comp_swapchain * @see comp_swapchain
*/ */
struct comp_swapchain_image struct comp_swapchain_image
@ -60,7 +62,7 @@ struct comp_swapchain_image
* sure that compositor lives for as long as the swapchain does and that all * sure that compositor lives for as long as the swapchain does and that all
* swapchains are destroyed before the compositor is destroyed. * swapchains are destroyed before the compositor is destroyed.
* *
* @ingroup comp_main * @ingroup comp_util
* @implements xrt_swapchain_native * @implements xrt_swapchain_native
* @see comp_compositor * @see comp_compositor
*/ */
@ -91,6 +93,7 @@ struct comp_swapchain
/*! /*!
* Convenience function to convert a xrt_swapchain to a comp_swapchain. * Convenience function to convert a xrt_swapchain to a comp_swapchain.
* *
* @ingroup comp_util
* @private @memberof comp_swapchain * @private @memberof comp_swapchain
*/ */
static inline struct comp_swapchain * static inline struct comp_swapchain *
@ -110,7 +113,7 @@ comp_swapchain(struct xrt_swapchain *xsc)
* Do garbage collection, destroying any resources that has been scheduled for * Do garbage collection, destroying any resources that has been scheduled for
* destruction from other threads. * destruction from other threads.
* *
* @public @memberof comp_compositor * @ingroup comp_util
*/ */
void void
comp_swapchain_garbage_collect(struct comp_swapchain_gc *cscgc); comp_swapchain_garbage_collect(struct comp_swapchain_gc *cscgc);
@ -118,7 +121,7 @@ comp_swapchain_garbage_collect(struct comp_swapchain_gc *cscgc);
/*! /*!
* A compositor function that is implemented in the swapchain code. * A compositor function that is implemented in the swapchain code.
* *
* @public @memberof comp_compositor * @ingroup comp_util
*/ */
xrt_result_t xrt_result_t
comp_swapchain_create(struct vk_bundle *vk, comp_swapchain_create(struct vk_bundle *vk,
@ -129,7 +132,7 @@ comp_swapchain_create(struct vk_bundle *vk,
/*! /*!
* A compositor function that is implemented in the swapchain code. * A compositor function that is implemented in the swapchain code.
* *
* @public @memberof comp_compositor * @ingroup comp_util
*/ */
xrt_result_t xrt_result_t
comp_swapchain_import(struct vk_bundle *vk, comp_swapchain_import(struct vk_bundle *vk,
@ -144,7 +147,7 @@ comp_swapchain_import(struct vk_bundle *vk,
* does the actual destruction and is called from @ref * does the actual destruction and is called from @ref
* comp_swapchain_garbage_collect. * comp_swapchain_garbage_collect.
* *
* @private @memberof comp_swapchain * @ingroup comp_util
*/ */
void void
comp_swapchain_really_destroy(struct comp_swapchain *sc); comp_swapchain_really_destroy(struct comp_swapchain *sc);

2
src/xrt/compositor/util/comp_sync.c
View file

@ -4,7 +4,7 @@
* @file * @file
* @brief Independent @ref xrt_compositor_fence implementation. * @brief Independent @ref xrt_compositor_fence implementation.
* @author Jakob Bornecrantz <jakob@collabora.com> * @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup comp_main * @ingroup comp_util
*/ */
#include "xrt/xrt_config_os.h" #include "xrt/xrt_config_os.h"

4
src/xrt/compositor/util/comp_sync.h
View file

@ -4,7 +4,7 @@
* @file * @file
* @brief Independent @ref xrt_compositor_fence implementation. * @brief Independent @ref xrt_compositor_fence implementation.
* @author Jakob Bornecrantz <jakob@collabora.com> * @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup comp_main * @ingroup comp_util
*/ */
#pragma once #pragma once
@ -25,6 +25,8 @@ extern "C" {
* The vk_bundle is owned by the compositor, its the state trackers job to make * The vk_bundle is owned by the compositor, its the state trackers job to make
* sure that compositor lives for as long as the fence does and that all fences * sure that compositor lives for as long as the fence does and that all fences
* are destroyed before the compositor is destroyed. * are destroyed before the compositor is destroyed.
*
* @ingroup comp_util
*/ */
xrt_result_t xrt_result_t
comp_fence_import(struct vk_bundle *vk, xrt_graphics_sync_handle_t handle, struct xrt_compositor_fence **out_xcf); comp_fence_import(struct vk_bundle *vk, xrt_graphics_sync_handle_t handle, struct xrt_compositor_fence **out_xcf);