Vk ext shader object optional layer

framework/core/hpp_instance.cpp

@@ -75,6 +75,41 @@ static VKAPI_ATTR VkBool32 VKAPI_CALL debug_callback(VkDebugReportFlagsEXT flags
 }
 #endif
 
+bool validate_layers(std::unordered_map<const char *, bool> &required,
+                     const std::vector<vk::LayerProperties> &available)
+{
+	std::vector<const char *> remove_vec;
+	for (auto layer : required)
+	{
+		bool found = false;
+		for (auto &available_layer : available)
+		{
+			if (strcmp(available_layer.layerName, layer.first) == 0)
+			{
+				found = true;
+				break;
+			}
+		}
+
+		if (!found)
+		{
+			if (!layer.second)
+			{
+				LOGW("Optional Layer {} not found, removing it", layer.first)
+				remove_vec.push_back(layer.first);
+				continue;
+			}
+			LOGE("Validation Layer {} not found", layer.first)
+			return false;
+		}
+	}
+	for (auto &rem : remove_vec)
+	{
+		required.erase(rem);
+	}
+	return true;
+}
+
 bool validate_layers(const std::vector<const char *>        &required,
                      const std::vector<vk::LayerProperties> &available)
 {
@@ -291,6 +326,20 @@ HPPInstance::HPPInstance(const std::string                            &applicati
 		throw std::runtime_error("Required validation layers are missing.");
 	}
 
+	std::unordered_map<const char *, bool> layers = (std::unordered_map<const char *, bool>) (requested_layers);
+	if (validate_layers(layers, supported_validation_layers))
+	{
+		LOGI("Enabled Validation Layers:")
+		for (const auto &layer : layers)
+		{
+			LOGI("	\t{}", layer.first);
+		}
+	}
+	else
+	{
+		throw std::runtime_error("Required validation layers are missing.");
+	}
+
 	vk::ApplicationInfo app_info(application_name.c_str(), 0, "Vulkan Samples", 0, api_version);
 
 	vk::InstanceCreateInfo instance_info({}, &app_info, requested_validation_layers, enabled_extensions);

framework/core/instance.cpp

@@ -76,6 +76,41 @@ static VKAPI_ATTR VkBool32 VKAPI_CALL debug_callback(VkDebugReportFlagsEXT flags
 }
 #endif
 
+bool validate_layers(std::unordered_map<const char *, bool> &required,
+                     const std::vector<VkLayerProperties>   &available)
+{
+	std::vector<const char *> remove_vec;
+	for (auto layer : required)
+	{
+		bool found = false;
+		for (auto &available_layer : available)
+		{
+			if (strcmp(available_layer.layerName, layer.first) == 0)
+			{
+				found = true;
+				break;
+			}
+		}
+
+		if (!found)
+		{
+			if (!layer.second)
+			{
+				LOGW("Optional Layer {} not found, removing it", layer.first)
+				remove_vec.push_back(layer.first);
+				continue;
+			}
+			LOGE("Validation Layer {} not found", layer.first)
+			return false;
+		}
+	}
+	for (auto &rem : remove_vec)
+	{
+		required.erase(rem);
+	}
+	return true;
+}
+
 bool validate_layers(const std::vector<const char *>      &required,
                      const std::vector<VkLayerProperties> &available)
 {
@@ -302,6 +337,20 @@ Instance::Instance(const std::string                            &application_nam
 		throw std::runtime_error("Required validation layers are missing.");
 	}
 
+	std::unordered_map<const char *, bool> layers = (std::unordered_map<const char *, bool>) (requested_layers);
+	if (validate_layers(layers, supported_validation_layers))
+	{
+		LOGI("Enabled Validation Layers:")
+		for (const auto &layer : layers)
+		{
+			LOGI("	\t{}", layer.first);
+		}
+	}
+	else
+	{
+		throw std::runtime_error("Required validation layers are missing.");
+	}
+
 	VkApplicationInfo app_info{VK_STRUCTURE_TYPE_APPLICATION_INFO};
 
 	app_info.pApplicationName   = application_name.c_str();

framework/vulkan_sample.h

@@ -431,6 +431,7 @@ class VulkanSample : public vkb::Application
 
 	/** @brief Set of instance extensions to be enabled for this example and whether they are optional (must be set in the derived constructor) */
 	std::unordered_map<const char *, bool> instance_extensions;
+	std::unordered_map<const char *, bool> instance_layers;
 
 	/** @brief Vector of layer settings to be enabled for this example (must be set in the derived constructor) */
 	std::vector<vk::LayerSettingEXT> layer_settings;

samples/extensions/shader_object/README.adoc

@@ -1,5 +1,5 @@
 ////
-- Copyright 2023 Nintendo
+- Copyright 2024 Nintendo
  -
  - Licensed under the Apache License, Version 2.0 (the "License");
  - you may not use this file except in compliance with the License.
@@ -436,13 +436,15 @@ The layer can be shipped with your application, and it will disable itself if a
 The emulation layer can be enabled by adding `VK_LAYER_KHRONOS_shader_object` to `ppEnabledLayerNames` in `VkDeviceCreateInfo`.
 
 The sample framework already has an existing abstraction normally used for enabling the validation layer.
-This sample repurposes this mechanism to instead load the emulation layer.
+This
+sample repurposes this mechanism to instead load the emulation layer. NB: the layer is set to be optional as that's
+what the false does.
 
 [,CPP]
 ----
-const std::vector<const char *> ShaderObject::get_validation_layers()
+const std::unordered_map<const char *, bool> ShaderObject::get_validation_layers()
 {
-    return {"VK_LAYER_KHRONOS_shader_object"};
+    return {"VK_LAYER_KHRONOS_shader_object", false};
 }
 ----
 

samples/extensions/shader_object/shader_object.cpp

@@ -41,6 +41,9 @@ ShaderObject::ShaderObject()
 
 	// Enable extensions for sample
 	add_device_extension(VK_KHR_CREATE_RENDERPASS_2_EXTENSION_NAME);
+
+	// Enable the shader object layer if it's available.  Its optional.
+	add_layer("VK_LAYER_KHRONOS_shader_object", false);
 }
 
 ShaderObject::~ShaderObject()
@@ -105,13 +108,6 @@ ShaderObject::~ShaderObject()
 	}
 }
 
-// Currently the sample calls through this function in order to get the list of any instance layers, not just validation layers.
-// This is not suitable for a real application implementation using the layer, the layer will need to be shipped with the application.
-const std::vector<const char *> ShaderObject::get_validation_layers()
-{
-	return {"VK_LAYER_KHRONOS_shader_object"};
-}
-
 bool ShaderObject::resize(const uint32_t _width, const uint32_t _height)
 {
 	if (!has_device())
@@ -229,6 +225,11 @@ void ShaderObject::setup_framebuffer()
 // Create render pass for UI drawing
 void ShaderObject::setup_render_pass()
 {
+	// delete existing render pass
+	if (render_pass != VK_NULL_HANDLE)
+	{
+		vkDestroyRenderPass(get_device().get_handle(), render_pass, VK_NULL_HANDLE);
+	}
 	VkAttachmentDescription color_attachment{};
 
 	// Color attachment set to load color and ignore stencil
@@ -415,6 +416,10 @@ void ShaderObject::load_assets()
 
 	VkSamplerCreateInfo sampler_create_info = vkb::initializers::sampler_create_info();
 
+	// destroy created sampler before re-creating
+	vkDestroySampler(get_device().get_handle(), heightmap_texture.sampler, nullptr);
+	vkDestroySampler(get_device().get_handle(), terrain_array_textures.sampler, nullptr);
+
 	// Setup a mirroring sampler for the height map
 	vkDestroySampler(get_device().get_handle(), heightmap_texture.sampler, nullptr);
 	sampler_create_info.magFilter    = filter;
@@ -1955,7 +1960,7 @@ void ShaderObject::build_linked_shaders(VkDevice device, ShaderObject::Shader *v
 		shader_create.flags |= VK_SHADER_CREATE_LINK_STAGE_BIT_EXT;
 	}
 
-	VkShaderEXT shaderEXTs[2];
+	VkShaderEXT shaderEXTs[2] = {VK_NULL_HANDLE, VK_NULL_HANDLE};
 
 	// Create the shader objects
 	VkResult result = vkCreateShadersEXT(device,

samples/extensions/shader_object/shader_object.h

@@ -128,8 +128,6 @@ class ShaderObject : public ApiVulkanSample
 	ShaderObject();
 	~ShaderObject() override;
 
-	const std::vector<const char *> get_validation_layers() override;
-
 	bool resize(const uint32_t width, const uint32_t height) override;
 	bool prepare(const vkb::ApplicationOptions &options) override;
 	void setup_framebuffer() override;