add documentation

cg-tuwien · Mar 30, 2023 · 69721d4 · 69721d4
1 parent 14cf6ad
commit 69721d4
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/auto_vk b/auto_vk
diff --git a/auto_vk_toolkit/include/context_vulkan.hpp b/auto_vk_toolkit/include/context_vulkan.hpp
@@ -167,9 +167,23 @@ namespace avk
 		avk::command_buffer record_and_submit(std::vector<avk::recorded_commands_t> aRecordedCommandsAndSyncInstructions, const avk::queue& aQueue, vk::CommandBufferUsageFlags aUsageFlags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit);
 
 		avk::semaphore record_and_submit_with_semaphore(std::vector<avk::recorded_commands_t> aRecordedCommandsAndSyncInstructions, const avk::queue& aQueue, avk::stage::pipeline_stage_flags aSrcSignalStage, vk::CommandBufferUsageFlags aUsageFlags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit);
-
+		/** \brief Records and submits commands to a queue together with a newly created timeline semaphore, which is signalled upon completion.
+		* \param aRecordedCommandsAndSyncInstructions	List of commands to record and submit.
+		* \param aQueue									The queue to submit the commands to.
+		* \param aSrcSignalStage						Defines in which stage it is safe to signal the created timeline semaphore.
+		* \param aSignalValue							The value to SIGNAL the timeline semaphore to.
+		* \param aInitialValue				(optional)	The value to INITIALIZE the newly created timeline semaphore with.
+		* \param aUsageFlags				(optional)	CommandBuffer usage flags.
+		* \return The newly created timeline semaphore.
+		*/
 		avk::semaphore record_and_submit_with_timeline_semaphore(std::vector<avk::recorded_commands_t> aRecordedCommandsAndSyncInstructions, const avk::queue& aQueue, avk::stage::pipeline_stage_flags aSrcSignalStage, uint64_t aSignalValue, uint64_t aInitialValue = 0, vk::CommandBufferUsageFlags aUsageFlags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit);
 
+		/** \brief Records and submits commands to a queue together with the given timeline semaphore, which is signalled upon completion.
+		* \param aRecordedCommandsAndSyncInstructions	List of commands to record and submit.
+		* \param aQueue									The queue to submit the commands to.
+		* \param aSignalInfo							Used to specify the timeline semaphore, after which stage it's supposed to be triggered, and to which value it should be set.
+		* \param aUsageFlags				(optional)	CommandBuffer usage flags.
+		*/
 		void record_and_submit_with_timeline_semaphore(std::vector<avk::recorded_commands_t> aRecordedCommandsAndSyncInstructions, const avk::queue& aQueue, avk::semaphore_signal_info aSignalInfo, vk::CommandBufferUsageFlags aUsageFlags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit);
 
 		avk::fence record_and_submit_with_fence(std::vector<avk::recorded_commands_t> aRecordedCommandsAndSyncInstructions, const avk::queue& aQueue, vk::CommandBufferUsageFlags aUsageFlags = vk::CommandBufferUsageFlagBits::eOneTimeSubmit);