Merge branch 'section/dear-imgui' into section/graphics-pipeline

Author: karnkaul

guide/src/rendering/dynamic_rendering.md

@@ -6,7 +6,7 @@ Add these new members to `App`:
 
 ```cpp
 auto acquire_render_target() -> bool;
-auto wait_for_frame() -> vk::CommandBuffer;
+auto begin_frame() -> vk::CommandBuffer;
 void transition_for_render(vk::CommandBuffer command_buffer) const;
 void render(vk::CommandBuffer command_buffer);
 void transition_for_present(vk::CommandBuffer command_buffer) const;
@@ -23,15 +23,15 @@ The main loop can now use these to implement the Swapchain and rendering loop:
 while (glfwWindowShouldClose(m_window.get()) == GLFW_FALSE) {
   glfwPollEvents();
   if (!acquire_render_target()) { continue; }
-  auto const command_buffer = wait_for_frame();
+  auto const command_buffer = begin_frame();
   transition_for_render(command_buffer);
   render(command_buffer);
   transition_for_present(command_buffer);
   submit_and_present();
 }
 ```
 
-Acquire the Render Target:
+Before acquiring a Swapchain image, we need to wait for the current frame's fence. If acquisition is successful, reset the fence ('un'signal it):
 
 ```cpp
 auto App::acquire_render_target() -> bool {
@@ -40,36 +40,38 @@ auto App::acquire_render_target() -> bool {
   if (m_framebuffer_size.x <= 0 || m_framebuffer_size.y <= 0) {
     return false;
   }
-  // an eErrorOutOfDateKHR result is not guaranteed if the
-  // framebuffer size does not match the Swapchain image size, check it
-  // explicitly.
-  auto fb_size_changed = m_framebuffer_size != m_swapchain->get_size();
+
   auto& render_sync = m_render_sync.at(m_frame_index);
+
+  // wait for the fence to be signaled.
+  static constexpr auto fence_timeout_v =
+    static_cast<std::uint64_t>(std::chrono::nanoseconds{3s}.count());
+  auto result =
+    m_device->waitForFences(*render_sync.drawn, vk::True, fence_timeout_v);
+  if (result != vk::Result::eSuccess) {
+    throw std::runtime_error{"Failed to wait for Render Fence"};
+  }
+
   m_render_target = m_swapchain->acquire_next_image(*render_sync.draw);
-  if (fb_size_changed || !m_render_target) {
+  if (!m_render_target) {
+    // acquire failure => ErrorOutOfDate. Recreate Swapchain.
     m_swapchain->recreate(m_framebuffer_size);
     return false;
   }
 
+  // reset fence _after_ acquisition of image: if it fails, the
+  // fence remains signaled.
+  m_device->resetFences(*render_sync.drawn);
+
   return true;
 }
 ```
 
-Wait for the Fence associated with the current frame and reset ('un'signal) it, and begin Command Buffer recording:
+Since the fence has been reset, a queue submission must be made that signals it before continuing, otherwise the app will deadlock on the next wait (and eventually throw after 3s). Begin Command Buffer recording:
 
 ```cpp
-auto App::wait_for_frame() -> vk::CommandBuffer {
+auto App::begin_frame() -> vk::CommandBuffer {
   auto const& render_sync = m_render_sync.at(m_frame_index);
-  static constexpr auto fence_timeout_v =
-    static_cast<std::uint64_t>(std::chrono::nanoseconds{3s}.count());
-  auto result =
-    m_device->waitForFences(*render_sync.drawn, vk::True, fence_timeout_v);
-  if (result != vk::Result::eSuccess) {
-    throw std::runtime_error{"Failed to wait for Render Fence"};
-  }
-  // reset fence _after_ acquisition of image: if it fails, the
-  // fence remains signaled.
-  m_device->resetFences(*render_sync.drawn);
 
   auto command_buffer_bi = vk::CommandBufferBeginInfo{};
   // this flag means recorded commands will not be reused.
@@ -79,24 +81,22 @@ auto App::wait_for_frame() -> vk::CommandBuffer {
 }
 ```
 
-Since the fence has been reset, a queue submission must be made that signals it before continuing, otherwise the app will deadlock on the next wait (and eventually throw after 3s).
-
 Transition the image for rendering, ie Attachment Optimal layout. Set up the image barrier and record it:
 
 ```cpp
 void App::transition_for_render(vk::CommandBuffer const command_buffer) const {
   auto dependency_info = vk::DependencyInfo{};
   auto barrier = m_swapchain->base_barrier();
   // Undefined => AttachmentOptimal
-  // we don't need to block any operations before the barrier, since we
-  // rely on the image acquired semaphore to block rendering.
-  // any color attachment operations must happen after the barrier.
+  // the barrier must wait for prior color attachment operations to complete,
+  // and block subsequent ones.
   barrier.setOldLayout(vk::ImageLayout::eUndefined)
     .setNewLayout(vk::ImageLayout::eAttachmentOptimal)
-    .setSrcAccessMask(vk::AccessFlagBits2::eNone)
-    .setSrcStageMask(vk::PipelineStageFlagBits2::eTopOfPipe)
-    .setDstAccessMask(vk::AccessFlagBits2::eColorAttachmentWrite)
-    .setDstStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
+    .setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentRead |
+              vk::AccessFlagBits2::eColorAttachmentWrite)
+    .setSrcStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput)
+    .setDstAccessMask(barrier.srcAccessMask)
+    .setDstStageMask(barrier.srcStageMask);
   dependency_info.setImageMemoryBarriers(barrier);
   command_buffer.pipelineBarrier2(dependency_info);
 }
@@ -133,15 +133,15 @@ void App::transition_for_present(vk::CommandBuffer const command_buffer) const {
   auto dependency_info = vk::DependencyInfo{};
   auto barrier = m_swapchain->base_barrier();
   // AttachmentOptimal => PresentSrc
-  // the barrier must wait for color attachment operations to complete.
-  // we don't need any post-synchronization as the present Sempahore takes
-  // care of that.
+  // the barrier must wait for prior color attachment operations to complete,
+  // and block subsequent ones.
   barrier.setOldLayout(vk::ImageLayout::eAttachmentOptimal)
     .setNewLayout(vk::ImageLayout::ePresentSrcKHR)
-    .setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentWrite)
+    .setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentRead |
+              vk::AccessFlagBits2::eColorAttachmentWrite)
     .setSrcStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput)
-    .setDstAccessMask(vk::AccessFlagBits2::eNone)
-    .setDstStageMask(vk::PipelineStageFlagBits2::eBottomOfPipe);
+    .setDstAccessMask(barrier.srcAccessMask)
+    .setDstStageMask(barrier.srcStageMask);
   dependency_info.setImageMemoryBarriers(barrier);
   command_buffer.pipelineBarrier2(dependency_info);
 }
@@ -159,7 +159,7 @@ void App::submit_and_present() {
     vk::CommandBufferSubmitInfo{render_sync.command_buffer};
   auto wait_semaphore_info = vk::SemaphoreSubmitInfo{};
   wait_semaphore_info.setSemaphore(*render_sync.draw)
-    .setStageMask(vk::PipelineStageFlagBits2::eTopOfPipe);
+    .setStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
   auto signal_semaphore_info = vk::SemaphoreSubmitInfo{};
   signal_semaphore_info.setSemaphore(*render_sync.present)
     .setStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
@@ -171,7 +171,13 @@ void App::submit_and_present() {
   m_frame_index = (m_frame_index + 1) % m_render_sync.size();
   m_render_target.reset();
 
-  if (!m_swapchain->present(m_queue, *render_sync.present)) {
+  // an eErrorOutOfDateKHR result is not guaranteed if the
+  // framebuffer size does not match the Swapchain image size, check it
+  // explicitly.
+  auto const fb_size_changed = m_framebuffer_size != m_swapchain->get_size();
+  auto const out_of_date =
+    !m_swapchain->present(m_queue, *render_sync.present);
+  if (fb_size_changed || out_of_date) {
     m_swapchain->recreate(m_framebuffer_size);
   }
 }

src/app.cpp

@@ -222,7 +222,7 @@ void App::main_loop() {
 	while (glfwWindowShouldClose(m_window.get()) == GLFW_FALSE) {
 		glfwPollEvents();
 		if (!acquire_render_target()) { continue; }
-		auto const command_buffer = wait_for_frame();
+		auto const command_buffer = begin_frame();
 		transition_for_render(command_buffer);
 		render(command_buffer);
 		transition_for_present(command_buffer);
@@ -236,34 +236,36 @@ auto App::acquire_render_target() -> bool {
 	if (m_framebuffer_size.x <= 0 || m_framebuffer_size.y <= 0) {
 		return false;
 	}
-	// an eErrorOutOfDateKHR result is not guaranteed if the
-	// framebuffer size does not match the Swapchain image size, check it
-	// explicitly.
-	auto fb_size_changed = m_framebuffer_size != m_swapchain->get_size();
-	auto& render_sync = m_render_sync.at(m_frame_index);
-	m_render_target = m_swapchain->acquire_next_image(*render_sync.draw);
-	if (fb_size_changed || !m_render_target) {
-		m_swapchain->recreate(m_framebuffer_size);
-		return false;
-	}
 
-	return true;
-}
+	auto& render_sync = m_render_sync.at(m_frame_index);
 
-auto App::wait_for_frame() -> vk::CommandBuffer {
-	auto const& render_sync = m_render_sync.at(m_frame_index);
+	// wait for the fence to be signaled.
 	static constexpr auto fence_timeout_v =
 		static_cast<std::uint64_t>(std::chrono::nanoseconds{3s}.count());
 	auto result =
 		m_device->waitForFences(*render_sync.drawn, vk::True, fence_timeout_v);
 	if (result != vk::Result::eSuccess) {
 		throw std::runtime_error{"Failed to wait for Render Fence"};
 	}
+
+	m_render_target = m_swapchain->acquire_next_image(*render_sync.draw);
+	if (!m_render_target) {
+		// acquire failure => ErrorOutOfDate. Recreate Swapchain.
+		m_swapchain->recreate(m_framebuffer_size);
+		return false;
+	}
+
 	// reset fence _after_ acquisition of image: if it fails, the
 	// fence remains signaled.
 	m_device->resetFences(*render_sync.drawn);
 	m_imgui->new_frame();
 
+	return true;
+}
+
+auto App::begin_frame() -> vk::CommandBuffer {
+	auto const& render_sync = m_render_sync.at(m_frame_index);
+
 	auto command_buffer_bi = vk::CommandBufferBeginInfo{};
 	// this flag means recorded commands will not be reused.
 	command_buffer_bi.setFlags(vk::CommandBufferUsageFlagBits::eOneTimeSubmit);
@@ -275,15 +277,15 @@ void App::transition_for_render(vk::CommandBuffer const command_buffer) const {
 	auto dependency_info = vk::DependencyInfo{};
 	auto barrier = m_swapchain->base_barrier();
 	// Undefined => AttachmentOptimal
-	// we don't need to block any operations before the barrier, since we
-	// rely on the image acquired semaphore to block rendering.
-	// any color attachment operations must happen after the barrier.
+	// the barrier must wait for prior color attachment operations to complete,
+	// and block subsequent ones.
 	barrier.setOldLayout(vk::ImageLayout::eUndefined)
 		.setNewLayout(vk::ImageLayout::eAttachmentOptimal)
-		.setSrcAccessMask(vk::AccessFlagBits2::eNone)
-		.setSrcStageMask(vk::PipelineStageFlagBits2::eTopOfPipe)
-		.setDstAccessMask(vk::AccessFlagBits2::eColorAttachmentWrite)
-		.setDstStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
+		.setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentRead |
+						  vk::AccessFlagBits2::eColorAttachmentWrite)
+		.setSrcStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput)
+		.setDstAccessMask(barrier.srcAccessMask)
+		.setDstStageMask(barrier.srcStageMask);
 	dependency_info.setImageMemoryBarriers(barrier);
 	command_buffer.pipelineBarrier2(dependency_info);
 }
@@ -323,15 +325,15 @@ void App::transition_for_present(vk::CommandBuffer const command_buffer) const {
 	auto dependency_info = vk::DependencyInfo{};
 	auto barrier = m_swapchain->base_barrier();
 	// AttachmentOptimal => PresentSrc
-	// the barrier must wait for color attachment operations to complete.
-	// we don't need any post-synchronization as the present Sempahore takes
-	// care of that.
+	// the barrier must wait for prior color attachment operations to complete,
+	// and block subsequent ones.
 	barrier.setOldLayout(vk::ImageLayout::eAttachmentOptimal)
 		.setNewLayout(vk::ImageLayout::ePresentSrcKHR)
-		.setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentWrite)
+		.setSrcAccessMask(vk::AccessFlagBits2::eColorAttachmentRead |
+						  vk::AccessFlagBits2::eColorAttachmentWrite)
 		.setSrcStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput)
-		.setDstAccessMask(vk::AccessFlagBits2::eNone)
-		.setDstStageMask(vk::PipelineStageFlagBits2::eBottomOfPipe);
+		.setDstAccessMask(barrier.srcAccessMask)
+		.setDstStageMask(barrier.srcStageMask);
 	dependency_info.setImageMemoryBarriers(barrier);
 	command_buffer.pipelineBarrier2(dependency_info);
 }
@@ -345,7 +347,7 @@ void App::submit_and_present() {
 		vk::CommandBufferSubmitInfo{render_sync.command_buffer};
 	auto wait_semaphore_info = vk::SemaphoreSubmitInfo{};
 	wait_semaphore_info.setSemaphore(*render_sync.draw)
-		.setStageMask(vk::PipelineStageFlagBits2::eTopOfPipe);
+		.setStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
 	auto signal_semaphore_info = vk::SemaphoreSubmitInfo{};
 	signal_semaphore_info.setSemaphore(*render_sync.present)
 		.setStageMask(vk::PipelineStageFlagBits2::eColorAttachmentOutput);
@@ -357,7 +359,13 @@ void App::submit_and_present() {
 	m_frame_index = (m_frame_index + 1) % m_render_sync.size();
 	m_render_target.reset();
 
-	if (!m_swapchain->present(m_queue, *render_sync.present)) {
+	// an eErrorOutOfDateKHR result is not guaranteed if the
+	// framebuffer size does not match the Swapchain image size, check it
+	// explicitly.
+	auto const fb_size_changed = m_framebuffer_size != m_swapchain->get_size();
+	auto const out_of_date =
+		!m_swapchain->present(m_queue, *render_sync.present);
+	if (fb_size_changed || out_of_date) {
 		m_swapchain->recreate(m_framebuffer_size);
 	}
 }

src/app.hpp

@@ -43,7 +43,7 @@ class App {
 	void main_loop();
 
 	auto acquire_render_target() -> bool;
-	auto wait_for_frame() -> vk::CommandBuffer;
+	auto begin_frame() -> vk::CommandBuffer;
 	void transition_for_render(vk::CommandBuffer command_buffer) const;
 	void render(vk::CommandBuffer command_buffer);
 	void transition_for_present(vk::CommandBuffer command_buffer) const;