diff --git a/include/vkcv/SyncResources.hpp b/include/vkcv/SyncResources.hpp index ea421dd4d3503e5553add124d57113f50705cc80..9a2de30f92da73c02ec59e56d6afd4e8f29c90cd 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