Update additional samples to use new sync

Replace fences with timeline semaphores
Cleanup

Author: SaschaWillems

base/vulkanexamplebase.cpp

@@ -179,16 +179,6 @@ VkResult VulkanExampleBase::createInstance()
 	return result;
 }
 
-// @todo: Only used by few examples, can be removed when new sync is fully in place
-void VulkanExampleBase::renderFrame()
-{
-	VulkanExampleBase::prepareFrame();
-	submitInfo.commandBufferCount = 1;
-	submitInfo.pCommandBuffers = &drawCmdBuffers[currentBuffer];
-	VK_CHECK_RESULT(vkQueueSubmit(queue, 1, &submitInfo, VK_NULL_HANDLE));
-	VulkanExampleBase::submitFrame();
-}
-
 std::string VulkanExampleBase::getWindowTitle() const
 {
 	std::string windowTitle{ title + " - " + deviceProperties.deviceName };
@@ -758,12 +748,14 @@ void VulkanExampleBase::drawUI(const VkCommandBuffer commandBuffer)
 	}
 }
 
-void VulkanExampleBase::prepareFrame()
+void VulkanExampleBase::prepareFrame(bool waitForFence)
 {
 	if (useNewSync) {
 		// Ensure command buffer execution has finished
-		VK_CHECK_RESULT(vkWaitForFences(device, 1, &waitFences[currentBuffer], VK_TRUE, UINT64_MAX));
-		VK_CHECK_RESULT(vkResetFences(device, 1, &waitFences[currentBuffer]));
+		if (waitForFence) {
+			VK_CHECK_RESULT(vkWaitForFences(device, 1, &waitFences[currentBuffer], VK_TRUE, UINT64_MAX));
+			VK_CHECK_RESULT(vkResetFences(device, 1, &waitFences[currentBuffer]));
+		}
 		// Update UI if necessary
 		updateOverlay();
 		// Acquire the next image from the swap chain
@@ -797,13 +789,20 @@ void VulkanExampleBase::prepareFrame()
 	}
 }
 
-void VulkanExampleBase::submitFrame(bool skipQueueSubmit)
+void VulkanExampleBase::submitFrame(VkCommandBuffer cmdBuffer, bool skipQueueSubmit)
 {
 	if (useNewSync) {
 		// @todo: make this an argument
 		if (!skipQueueSubmit) {
+			const VkPipelineStageFlags waitPipelineStage{ VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT };
+			VkSubmitInfo submitInfo{ .sType = VK_STRUCTURE_TYPE_SUBMIT_INFO };
+			submitInfo.pWaitDstStageMask = &waitPipelineStage;
 			submitInfo.commandBufferCount = 1;
-			submitInfo.pCommandBuffers = &drawCmdBuffers[currentBuffer];
+			if (cmdBuffer != VK_NULL_HANDLE) {
+				submitInfo.pCommandBuffers = &cmdBuffer;
+			} else {
+				submitInfo.pCommandBuffers = &drawCmdBuffers[currentBuffer];
+			}
 			submitInfo.pWaitSemaphores = &presentCompleteSemaphores[currentBuffer];
 			submitInfo.waitSemaphoreCount = 1;
 			submitInfo.pSignalSemaphores = &renderCompleteSemaphores[currentImageIndex];
@@ -1204,17 +1203,6 @@ bool VulkanExampleBase::initVulkan()
 	// Ensures that the image is not presented until all commands have been submitted and executed
 	VK_CHECK_RESULT(vkCreateSemaphore(device, &semaphoreCreateInfo, nullptr, &semaphores.renderComplete));
 
-	// Set up submit info structure
-	// Semaphores will stay the same during application lifetime
-	// Command buffer submission info is set by each example
-	// @todo: Rework when new sync is fully in place, feels odd building/setting this up in multiple places
-	submitInfo = vks::initializers::submitInfo();
-	submitInfo.pWaitDstStageMask = &submitPipelineStages;
-	submitInfo.waitSemaphoreCount = 1;
-	submitInfo.pWaitSemaphores = &semaphores.presentComplete;
-	submitInfo.signalSemaphoreCount = 1;
-	submitInfo.pSignalSemaphores = &semaphores.renderComplete;
-
 	return true;
 }
 

base/vulkanexamplebase.h

@@ -132,10 +132,6 @@ class VulkanExampleBase
 	VkFormat depthFormat{VK_FORMAT_UNDEFINED};
 	// Command buffer pool
 	VkCommandPool cmdPool{ VK_NULL_HANDLE };
-	/** @brief Pipeline stages used to wait at for graphics queue submissions */
-	VkPipelineStageFlags submitPipelineStages = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
-	// Contains command buffers and semaphores to be presented to the queue
-	VkSubmitInfo submitInfo{};
 	// Command buffers used for rendering
 	std::vector<VkCommandBuffer> drawCmdBuffers;
 	// Global render pass for frame buffer writes
@@ -159,13 +155,13 @@ class VulkanExampleBase
 		// Command buffer submission and execution
 		VkSemaphore renderComplete;
 	} semaphores{};
-	std::vector<VkFence> waitFences;
 
 	// This sample will be using a new synchronisation setup, which is closer to what should be used with Vulkan
 	bool useNewSync{ false };
 	uint32_t currentImageIndex{ 0 };
 	std::vector<VkSemaphore> presentCompleteSemaphores{};
 	std::vector<VkSemaphore> renderCompleteSemaphores{};
+	std::vector<VkFence> waitFences;
 
 	bool requiresStencil{ false };
 public:
@@ -414,12 +410,11 @@ class VulkanExampleBase
 	void drawUI(const VkCommandBuffer commandBuffer);
 
 	/** Prepare the next frame for workload submission by acquiring the next swap chain image and waiting for the previous command buffer to finish */
-	void prepareFrame();
+	// @todo: rework once new sync is in place, maybe overload with submission info
+	void prepareFrame(bool waitForFence = true);
 	/** @brief Presents the current image to the swap chain */
 	// @todo: rework once new sync is in place, maybe overload with submission info
-	void submitFrame(bool skipQueueSubmit = false);
-	/** @brief (Virtual) Default image acquire + submission and command buffer submission function */
-	virtual void renderFrame();
+	void submitFrame(VkCommandBuffer cmdBuffer = VK_NULL_HANDLE, bool skipQueueSubmit = false);
 
 	/** @brief (Virtual) Called when the UI overlay is updating, can be used to add custom elements to the overlay */
 	virtual void OnUpdateUIOverlay(vks::UIOverlay *overlay);