Correctly handle vk::Result::eOutOfDate from vk::raii::SwapchainKHR::acquireNextImage and vk::raii::Queue::presentKHR

Author: asuessenbach

attachments/17_swap_chain_recreation.cpp

@@ -511,13 +511,18 @@ class HelloTriangleApplication
 
 		auto [result, imageIndex] = swapChain.acquireNextImage(UINT64_MAX, *presentCompleteSemaphores[frameIndex], nullptr);
 
+		// Due to VULKAN_HPP_HANDLE_ERROR_OUT_OF_DATE_AS_SUCCESS being defined, eErrorOutOfDateKHR can be checked as a result
+		// here and does not need to be caught by an exception.
 		if (result == vk::Result::eErrorOutOfDateKHR)
 		{
 			recreateSwapChain();
 			return;
 		}
+		// On other success codes than eSuccess and eSuboptimalKHR we just throw an exception.
+		// On any error code, aquireNextImage already threw an exception.
 		if (result != vk::Result::eSuccess && result != vk::Result::eSuboptimalKHR)
 		{
+			assert(result == vk::Result::eTimeout || result == vk::Result::eNotReady);
 			throw std::runtime_error("failed to acquire swap chain image!");
 		}
 
@@ -535,35 +540,23 @@ class HelloTriangleApplication
 		                                  .pSignalSemaphores    = &*renderFinishedSemaphores[imageIndex]};
 		queue.submit(submitInfo, *inFlightFences[frameIndex]);
 
-		try
+		const vk::PresentInfoKHR presentInfoKHR{.waitSemaphoreCount = 1,
+			                                      .pWaitSemaphores    = &*renderFinishedSemaphores[imageIndex],
+			                                      .swapchainCount     = 1,
+			                                      .pSwapchains        = &*swapChain,
+			                                      .pImageIndices      = &imageIndex};
+		result = queue.presentKHR(presentInfoKHR);
+		// Due to VULKAN_HPP_HANDLE_ERROR_OUT_OF_DATE_AS_SUCCESS being defined, eErrorOutOfDateKHR can be checked as a result
+		// here and does not need to be caught by an exception.
+		if ((result == vk::Result::eSuboptimalKHR) || (result == vk::Result::eErrorOutOfDateKHR) || framebufferResized)
 		{
-			const vk::PresentInfoKHR presentInfoKHR{.waitSemaphoreCount = 1,
-			                                        .pWaitSemaphores    = &*renderFinishedSemaphores[imageIndex],
-			                                        .swapchainCount     = 1,
-			                                        .pSwapchains        = &*swapChain,
-			                                        .pImageIndices      = &imageIndex};
-			result = queue.presentKHR(presentInfoKHR);
-			if (result == vk::Result::eSuboptimalKHR || framebufferResized)
-			{
-				framebufferResized = false;
-				recreateSwapChain();
-			}
-			else if (result != vk::Result::eSuccess)
-			{
-				throw std::runtime_error("failed to present swap chain image!");
-			}
+			framebufferResized = false;
+			recreateSwapChain();
 		}
-		catch (const vk::SystemError &e)
+		else
 		{
-			if (e.code().value() == static_cast<int>(vk::Result::eErrorOutOfDateKHR))
-			{
-				recreateSwapChain();
-				return;
-			}
-			else
-			{
-				throw;
-			}
+			// There are no other success codes than eSuccess; on any error code, presentKHR already threw an exception.
+			assert(result == vk::Result::eSuccess);
 		}
 		frameIndex   = (frameIndex + 1) % MAX_FRAMES_IN_FLIGHT;
 	}

attachments/CMakeLists.txt

@@ -14,7 +14,7 @@ endif()
 
 find_package (glfw3 REQUIRED)
 find_package (glm REQUIRED)
-find_package (Vulkan REQUIRED)
+find_package (Vulkan 1.4.335 REQUIRED)      # Require Vulkan SDK version 1.4.335 or higher
 find_package (tinyobjloader REQUIRED)
 find_package (tinygltf REQUIRED)
 find_package (KTX REQUIRED)
@@ -139,6 +139,9 @@ function (add_chapter CHAPTER_NAME)
     target_compile_definitions(${CHAPTER_NAME} PRIVATE USE_CPP20_MODULES=1)
   endif()
 
+  # Define VULKAN_HPP_HANDLE_ERROR_OUT_OF_DATE_AS_SUCCESS to treat VK_ERROR_OUT_OF_DATE_KHR as a success code
+  target_compile_definitions(${CHAPTER_NAME} PRIVATE "VULKAN_HPP_HANDLE_ERROR_OUT_OF_DATE_AS_SUCCESS" )
+
   if(WIN32)
     if(${CMAKE_GENERATOR} MATCHES "Visual Studio.*")
       set_target_properties(${CHAPTER_NAME} PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/${CHAPTER_NAME}")