From 593a404ad3927c45220d1317e8c30dafcb78030e Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sun, 22 May 2022 23:58:38 +0200
Subject: [PATCH] Added doxygen comments to sync resources
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
include/vkcv/SyncResources.hpp | 40 ++++++++++++++++++++++++++++++----
1 file changed, 36 insertions(+), 4 deletions(-)
diff --git a/include/vkcv/SyncResources.hpp b/include/vkcv/SyncResources.hpp
index ea421dd4..9a2de30f 100644
--- a/include/vkcv/SyncResources.hpp
+++ b/include/vkcv/SyncResources.hpp
@@ -15,9 +15,41 @@ namespace vkcv {
vk::Fence presentFinished;
};
- SyncResources createSyncResources(const vk::Device &device);
- void destroySyncResources(const vk::Device &device, const SyncResources &resources);
- vk::Fence createFence(const vk::Device &device);
- void waitForFence(const vk::Device& device, const vk::Fence& fence);
+ /**
+ * @brief Creates new synchronization resources for drawing
+ * and presenting with a swapchain.
+ *
+ * @param[in,out] device Vulkan-Device
+ * @return New created synchronization resources
+ */
+ SyncResources createSyncResources(const vk::Device &device);
+
+ /**
+ * @brief Destroys the synchronization resources with a
+ * given device.
+ *
+ * @param[in,out] device Vulkan-Device
+ * @param[in,out] resources Synchronizazion resources
+ */
+ void destroySyncResources(const vk::Device &device,
+ const SyncResources &resources);
+
+ /**
+ * @brief Creates a new fence with a given device and
+ * returns it.
+ *
+ * @param[in,out] device Vulkan-Device
+ * @return New created fence
+ */
+ vk::Fence createFence(const vk::Device &device);
+
+ /**
+ * @brief Calls a given device to wait for a specific fence.
+ *
+ * @param[in,out] device Vulkan-Device
+ * @param[in] fence Vulkan-Fence
+ */
+ void waitForFence(const vk::Device& device,
+ const vk::Fence& fence);
}
\ No newline at end of file
--
GitLab