From 64d1705730e0c7ca57e7f10afd9b181002a9311f Mon Sep 17 00:00:00 2001
From: Sebastian Aaltonen <sebastian.aaltonen@gmail.com>
Date: Sat, 3 Oct 2020 01:08:42 +0300
Subject: [PATCH] Optimized example fences. Waited immediately. Now waits
 before reuse (next frame) (#327)

* Optimized example fences. Waited immediately. Now waits before reuse (next frame).

* rust fmt + clippy warning silenced

* Add comments for record_submit_commandbuffer

Co-authored-by: Sebastian Aaltonen <sebastian.aaltonen@unity3d.com>
Co-authored-by: Maik Klein <maikklein@googlemail.com>
---
 examples/src/bin/texture.rs  |  2 ++
 examples/src/bin/triangle.rs |  1 +
 examples/src/lib.rs          | 49 ++++++++++++++++++++++++++++--------
 3 files changed, 42 insertions(+), 10 deletions(-)

diff --git a/examples/src/bin/texture.rs b/examples/src/bin/texture.rs
index a8ffd91..0377159 100644
--- a/examples/src/bin/texture.rs
+++ b/examples/src/bin/texture.rs
@@ -355,6 +355,7 @@ fn main() {
         record_submit_commandbuffer(
             &base.device,
             base.setup_command_buffer,
+            base.setup_commands_reuse_fence,
             base.present_queue,
             &[],
             &[],
@@ -736,6 +737,7 @@ fn main() {
             record_submit_commandbuffer(
                 &base.device,
                 base.draw_command_buffer,
+                base.draw_commands_reuse_fence,
                 base.present_queue,
                 &[vk::PipelineStageFlags::BOTTOM_OF_PIPE],
                 &[base.present_complete_semaphore],
diff --git a/examples/src/bin/triangle.rs b/examples/src/bin/triangle.rs
index 86ca5ed..9e5ed96 100644
--- a/examples/src/bin/triangle.rs
+++ b/examples/src/bin/triangle.rs
@@ -394,6 +394,7 @@ fn main() {
             record_submit_commandbuffer(
                 &base.device,
                 base.draw_command_buffer,
+                base.draw_commands_reuse_fence,
                 base.present_queue,
                 &[vk::PipelineStageFlags::COLOR_ATTACHMENT_OUTPUT],
                 &[base.present_complete_semaphore],
diff --git a/examples/src/lib.rs b/examples/src/lib.rs
index 6f54b07..d350c3d 100644
--- a/examples/src/lib.rs
+++ b/examples/src/lib.rs
@@ -25,10 +25,14 @@ macro_rules! offset_of {
         }
     }};
 }
-
+/// Helper function for submitting command buffers. Immediately waits for the fence before the command buffer
+/// is executed. That way we can delay the waiting for the fences by 1 frame which is good for performance.
+/// Make sure to create the fence in a signaled state on the first use.
+#[allow(clippy::too_many_arguments)]
 pub fn record_submit_commandbuffer<D: DeviceV1_0, F: FnOnce(&D, vk::CommandBuffer)>(
     device: &D,
     command_buffer: vk::CommandBuffer,
+    command_buffer_reuse_fence: vk::Fence,
     submit_queue: vk::Queue,
     wait_mask: &[vk::PipelineStageFlags],
     wait_semaphores: &[vk::Semaphore],
@@ -36,6 +40,14 @@ pub fn record_submit_commandbuffer<D: DeviceV1_0, F: FnOnce(&D, vk::CommandBuffe
     f: F,
 ) {
     unsafe {
+        device
+            .wait_for_fences(&[command_buffer_reuse_fence], true, std::u64::MAX)
+            .expect("Wait for fence failed.");
+
+        device
+            .reset_fences(&[command_buffer_reuse_fence])
+            .expect("Reset fences failed.");
+
         device
             .reset_command_buffer(
                 command_buffer,
@@ -54,10 +66,6 @@ pub fn record_submit_commandbuffer<D: DeviceV1_0, F: FnOnce(&D, vk::CommandBuffe
             .end_command_buffer(command_buffer)
             .expect("End commandbuffer");
 
-        let submit_fence = device
-            .create_fence(&vk::FenceCreateInfo::default(), None)
-            .expect("Create fence failed.");
-
         let command_buffers = vec![command_buffer];
 
         let submit_info = vk::SubmitInfo::builder()
@@ -67,12 +75,12 @@ pub fn record_submit_commandbuffer<D: DeviceV1_0, F: FnOnce(&D, vk::CommandBuffe
             .signal_semaphores(signal_semaphores);
 
         device
-            .queue_submit(submit_queue, &[submit_info.build()], submit_fence)
+            .queue_submit(
+                submit_queue,
+                &[submit_info.build()],
+                command_buffer_reuse_fence,
+            )
             .expect("queue submit failed.");
-        device
-            .wait_for_fences(&[submit_fence], true, std::u64::MAX)
-            .expect("Wait for fence failed.");
-        device.destroy_fence(submit_fence, None);
     }
 }
 
@@ -178,6 +186,9 @@ pub struct ExampleBase {
 
     pub present_complete_semaphore: vk::Semaphore,
     pub rendering_complete_semaphore: vk::Semaphore,
+
+    pub draw_commands_reuse_fence: vk::Fence,
+    pub setup_commands_reuse_fence: vk::Fence,
 }
 
 impl ExampleBase {
@@ -459,9 +470,20 @@ impl ExampleBase {
                 .bind_image_memory(depth_image, depth_image_memory, 0)
                 .expect("Unable to bind depth image memory");
 
+            let fence_create_info =
+                vk::FenceCreateInfo::builder().flags(vk::FenceCreateFlags::SIGNALED);
+
+            let draw_commands_reuse_fence = device
+                .create_fence(&fence_create_info, None)
+                .expect("Create fence failed.");
+            let setup_commands_reuse_fence = device
+                .create_fence(&fence_create_info, None)
+                .expect("Create fence failed.");
+
             record_submit_commandbuffer(
                 &device,
                 setup_command_buffer,
+                setup_commands_reuse_fence,
                 present_queue,
                 &[],
                 &[],
@@ -519,6 +541,7 @@ impl ExampleBase {
             let rendering_complete_semaphore = device
                 .create_semaphore(&semaphore_create_info, None)
                 .unwrap();
+
             ExampleBase {
                 events_loop: RefCell::new(events_loop),
                 entry,
@@ -543,6 +566,8 @@ impl ExampleBase {
                 depth_image_view,
                 present_complete_semaphore,
                 rendering_complete_semaphore,
+                draw_commands_reuse_fence,
+                setup_commands_reuse_fence,
                 surface,
                 debug_call_back,
                 debug_utils_loader,
@@ -560,6 +585,10 @@ impl Drop for ExampleBase {
                 .destroy_semaphore(self.present_complete_semaphore, None);
             self.device
                 .destroy_semaphore(self.rendering_complete_semaphore, None);
+            self.device
+                .destroy_fence(self.draw_commands_reuse_fence, None);
+            self.device
+                .destroy_fence(self.setup_commands_reuse_fence, None);
             self.device.free_memory(self.depth_image_memory, None);
             self.device.destroy_image_view(self.depth_image_view, None);
             self.device.destroy_image(self.depth_image, None);