mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-29 11:06:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

c/util: comp_scratch doc improvements

Browse source 
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2220>
This commit is contained in:
Rylie Pavlik 2024-05-24 10:49:43 -05:00 committed by Simon Zeni
parent 1e047b5b6d
commit 342fab6b02
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/xrt/compositor/util/comp_scratch.h
View file

@ -91,6 +91,8 @@ struct comp_scratch_single_images
* not enough as it has a mutex in it and has native handles which on some * not enough as it has a mutex in it and has native handles which on some
* platforms zero is a valid handle. * platforms zero is a valid handle.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -99,6 +101,8 @@ comp_scratch_single_images_init(struct comp_scratch_single_images *cssi);
/*! /*!
* Ensure that the scratch images are allocated and match @p extent size. * Ensure that the scratch images are allocated and match @p extent size.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
bool bool
@ -108,6 +112,8 @@ comp_scratch_single_images_ensure(struct comp_scratch_single_images *cssi, struc
* Free all images allocated, @p init must be called before calling this * Free all images allocated, @p init must be called before calling this
* function, is safe to call without any image allocated. * function, is safe to call without any image allocated.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -117,6 +123,8 @@ comp_scratch_single_images_free(struct comp_scratch_single_images *cssi, struct
* Get the next free image, after this function has been called you must call * Get the next free image, after this function has been called you must call
* either @p done or @p discard before calling any other function. * either @p done or @p discard before calling any other function.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -127,6 +135,8 @@ comp_scratch_single_images_get(struct comp_scratch_single_images *cssi, uint32_t
* signal that you are done with this function, the GPU work needs to be fully * signal that you are done with this function, the GPU work needs to be fully
* completed before calling done. * completed before calling done.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -136,6 +146,8 @@ comp_scratch_single_images_done(struct comp_scratch_single_images *cssi);
* Discard a @g get call, this clears the image debug part causing no image to * Discard a @g get call, this clears the image debug part causing no image to
* be shown in the debug UI. * be shown in the debug UI.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -144,6 +156,8 @@ comp_scratch_single_images_discard(struct comp_scratch_single_images *cssi);
/*! /*!
* Clears the debug output, this causes nothing to be shown in the debug UI. * Clears the debug output, this causes nothing to be shown in the debug UI.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void
@ -154,6 +168,8 @@ comp_scratch_single_images_clear_debug(struct comp_scratch_single_images *cssi);
* @p free before as this function only destroys the mutex, and the @p unid must * @p free before as this function only destroys the mutex, and the @p unid must
* no longer be tracked. * no longer be tracked.
* *
* @public @memberof comp_scratch_single_images
*
* @ingroup comp_util * @ingroup comp_util
*/ */
void void