Overlay configuration flag for the graphics context

blade-graphics/src/lib.rs

@@ -74,10 +74,15 @@ pub use hal::*;
 
 use std::{fmt, num::NonZeroU32};
 
-#[derive(Debug)]
+#[derive(Clone, Debug, Default)]
 pub struct ContextDesc {
+    /// Enable validation of the GAPI, shaders,
+    /// and insert crash markers into command buffers.
     pub validation: bool,
+    /// Enable capture support with GAPI tools.
     pub capture: bool,
+    /// Enable GAPI overlay.
+    pub overlay: bool,
 }
 
 #[derive(Debug)]

blade-graphics/src/metal/mod.rs

@@ -346,6 +346,10 @@ impl Context {
         if desc.validation {
             std::env::set_var("METAL_DEVICE_WRAPPER_TYPE", "1");
         }
+        if desc.overlay {
+            std::env::set_var("MTL_HUD_ENABLED", "1");
+        }
+
         let device = metal::Device::system_default().ok_or(super::NotSupportedError)?;
         let queue = device.new_command_queue();
 

blade-graphics/src/vulkan/init.rs

@@ -5,8 +5,6 @@ use ash::{
 use naga::back::spv;
 use std::{ffi, mem, sync::Mutex};
 
-const OPTIONAL_LAYERS: &[&[u8]] = &[];
-
 const REQUIRED_DEVICE_EXTENSIONS: &[&ffi::CStr] = &[
     vk::ExtInlineUniformBlockFn::name(),
     vk::KhrTimelineSemaphoreFn::name(),
@@ -240,13 +238,16 @@ impl super::Context {
                 .collect::<Vec<_>>();
 
             let mut layers: Vec<&'static ffi::CStr> = Vec::new();
-            let mut required_layers = Vec::new();
+            let mut requested_layers = Vec::<&[u8]>::new();
 
             if desc.validation {
-                required_layers.push(b"VK_LAYER_KHRONOS_validation\0");
+                requested_layers.push(b"VK_LAYER_KHRONOS_validation\0");
+            }
+            if desc.overlay {
+                requested_layers.push(b"VK_LAYER_MESA_overlay\0");
             }
 
-            for required in required_layers {
+            for required in requested_layers {
                 let name = ffi::CStr::from_bytes_with_nul(required).unwrap();
                 if supported_layer_names.contains(&name) {
                     layers.push(name);
@@ -255,14 +256,6 @@ impl super::Context {
                 }
             }
 
-            for &optional in OPTIONAL_LAYERS {
-                let name = ffi::CStr::from_bytes_with_nul(optional).unwrap();
-                if supported_layer_names.contains(&name) {
-                    log::info!("Enabling optional layer: {:?}", name);
-                    layers.push(name);
-                }
-            }
-
             layers
         };
 

examples/bunnymark/main.rs

@@ -57,8 +57,9 @@ impl Example {
             gpu::Context::init_windowed(
                 window,
                 gpu::ContextDesc {
-                    validation: cfg!(debug_assertions),
+                    validation: false,
                     capture: false,
+                    overlay: true,
                 },
             )
             .unwrap()

examples/init/main.rs

@@ -1,6 +1,6 @@
 #![allow(irrefutable_let_patterns)]
 
 use std::{env, path::Path, ptr, sync::Arc};
 
 use blade_graphics as gpu;
 
@@ -132,13 +132,7 @@
     let mut rd = renderdoc::RenderDoc::<renderdoc::V120>::new();
 
     println!("Initializing");
-    let context = Arc::new(unsafe {
-        gpu::Context::init(gpu::ContextDesc {
-            validation: cfg!(debug_assertions),
-            capture: true,
-        })
-        .unwrap()
-    });
+    let context = Arc::new(unsafe { gpu::Context::init(gpu::ContextDesc::default()).unwrap() });
 
     #[cfg(any(target_os = "windows", target_os = "linux"))]
     if let Ok(ref mut rd) = rd {

examples/mini/main.rs

@@ -31,13 +31,7 @@ impl gpu::ShaderData for Globals {
 
 fn main() {
     env_logger::init();
-    let context = unsafe {
-        gpu::Context::init(gpu::ContextDesc {
-            validation: true,
-            capture: true,
-        })
-        .unwrap()
-    };
+    let context = unsafe { gpu::Context::init(gpu::ContextDesc::default()).unwrap() };
 
     let global_layout = <Globals as gpu::ShaderData>::layout();
     let shader_source = std::fs::read_to_string("examples/mini/shader.wgsl").unwrap();

examples/particle/main.rs

@@ -21,6 +21,7 @@ impl Example {
                 gpu::ContextDesc {
                     validation: cfg!(debug_assertions),
                     capture: false,
+                    overlay: false,
                 },
             )
             .unwrap()

examples/ray-query/main.rs

@@ -52,6 +52,7 @@ impl Example {
                 gpu::ContextDesc {
                     validation: cfg!(debug_assertions),
                     capture: false,
+                    overlay: false,
                 },
             )
             .unwrap()

examples/scene/main.rs

@@ -176,6 +176,7 @@ impl Example {
                 gpu::ContextDesc {
                     validation: cfg!(debug_assertions),
                     capture: false,
+                    overlay: false,
                 },
             )
             .unwrap()

src/lib.rs

@@ -252,6 +252,7 @@ impl Engine {
                 gpu::ContextDesc {
                     validation: cfg!(debug_assertions),
                     capture: false,
+                    overlay: false,
                 },
             )
             .unwrap()