Add descriptor indexing sample

bldsys/cmake/global_options.cmake

@@ -1,5 +1,5 @@
 #[[
- Copyright (c) 2019-2020, Arm Limited and Contributors
+ Copyright (c) 2019-2021, Arm Limited and Contributors
 
  SPDX-License-Identifier: Apache-2.0
 
@@ -35,6 +35,7 @@ set(VKB_WARNINGS_AS_ERRORS ON CACHE BOOL "Enable Warnings as Errors")
 set(VKB_ENTRYPOINTS OFF CACHE BOOL "Enable create entrypoint project for every application.")
 set(VKB_SYMLINKS OFF CACHE BOOL "Enable create symlink folders for every application.")
 set(VKB_VALIDATION_LAYERS OFF CACHE BOOL "Enable validation layers for every application.")
+set(VKB_VALIDATION_LAYERS_GPU_ASSISTED OFF CACHE BOOL "Enable GPU assisted validation layers for every application.")
 set(VKB_BUILD_SAMPLES ON CACHE BOOL "Enable generation and building of Vulkan best practice samples.")
 set(VKB_BUILD_TESTS OFF CACHE BOOL "Enable generation and building of Vulkan best practice tests.")
 set(VKB_DIRECT_2_DISPLAY OFF CACHE BOOL "Force using D2D (if available)")
@@ -51,4 +52,4 @@ string(LENGTH "${CMAKE_SOURCE_DIR}/" ROOT_PATH_SIZE)
 add_definitions(-DROOT_PATH_SIZE=${ROOT_PATH_SIZE})
 
 set(CMAKE_C_FLAGS_DEBUG   "-DDEBUG=0 ${CMAKE_C_FLAGS_DEBUG}")
-set(CMAKE_CXX_FLAGS_DEBUG "-DDEBUG=0 ${CMAKE_CXX_FLAGS_DEBUG}")
+set(CMAKE_CXX_FLAGS_DEBUG "-DDEBUG=0 ${CMAKE_CXX_FLAGS_DEBUG}")

docs/build.md

@@ -26,6 +26,7 @@
   - [VKB_SYMLINKS](#vkb_symlinks)
   - [VKB_ENTRYPOINTS](#vkb_entrypoints)
   - [VKB_VALIDATION_LAYERS](#vkb_validation_layers)
+  - [VKB_VALIDATION_LAYERS_GPU_ASSISTED](#vkb_validation_layers_gpu_assisted)
   - [VKB_WARNINGS_AS_ERRORS](#vkb_warnings_as_errors)
 - [3D models](#3d-models)
 - [Performance data](#performance-data)
@@ -94,6 +95,12 @@ Enable Validation Layers
 
 **Default:** `OFF`
 
+#### VKB_VALIDATION_LAYERS_GPU_ASSISTED
+
+Enable GPU assisted Validation Layers, used primarily for VK_EXT_descriptor_indexing.
+
+**Default:** `OFF`
+
 #### VKB_WARNINGS_AS_ERRORS
 
 Treat all warnings as errors

framework/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2020, Arm Limited and Contributors
+# Copyright (c) 2019-2021, Arm Limited and Contributors
 #
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -379,6 +379,15 @@ if(${VKB_VALIDATION_LAYERS})
     target_compile_definitions(${PROJECT_NAME} PUBLIC VKB_VALIDATION_LAYERS)
 endif()
 
+# GPU assisted validation layers are not available on macOS.
+if(${VKB_VALIDATION_LAYERS_GPU_ASSISTED})
+    if (APPLE)
+        message(WARNING "GPU assisted validation layers are not currently available on macOS.")
+    else()
+        target_compile_definitions(${PROJECT_NAME} PUBLIC VKB_VALIDATION_LAYERS_GPU_ASSISTED)
+    endif()
+endif()
+
 if(${VKB_WARNINGS_AS_ERRORS})
     message(STATUS "Warnings as Errors Enabled")
     if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")

framework/core/instance.cpp

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018-2020, Arm Limited and Contributors
+/* Copyright (c) 2018-2021, Arm Limited and Contributors
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -165,6 +165,27 @@ Instance::Instance(const std::string &                           application_nam
 	}
 #endif
 
+#if (defined(VKB_DEBUG) || defined(VKB_VALIDATION_LAYERS)) && defined(VKB_VALIDATION_LAYERS_GPU_ASSISTED)
+	bool validation_features = false;
+	{
+		uint32_t layer_instance_extension_count;
+		VK_CHECK(vkEnumerateInstanceExtensionProperties("VK_LAYER_KHRONOS_validation", &layer_instance_extension_count, nullptr));
+
+		std::vector<VkExtensionProperties> available_layer_instance_extensions(layer_instance_extension_count);
+		VK_CHECK(vkEnumerateInstanceExtensionProperties("VK_LAYER_KHRONOS_validation", &layer_instance_extension_count, available_layer_instance_extensions.data()));
+
+		for (auto &available_extension : available_layer_instance_extensions)
+		{
+			if (strcmp(available_extension.extensionName, VK_EXT_VALIDATION_FEATURES_EXTENSION_NAME) == 0)
+			{
+				validation_features = true;
+				LOGI("{} is available, enabling it", VK_EXT_VALIDATION_FEATURES_EXTENSION_NAME);
+				enabled_extensions.push_back(VK_EXT_VALIDATION_FEATURES_EXTENSION_NAME);
+			}
+		}
+	}
+#endif
+
 	// Try to enable headless surface extension if it exists
 	if (headless)
 	{
@@ -293,6 +314,21 @@ Instance::Instance(const std::string &                           application_nam
 	}
 #endif
 
+#if (defined(VKB_DEBUG) || defined(VKB_VALIDATION_LAYERS)) && defined(VKB_VALIDATION_LAYERS_GPU_ASSISTED)
+	VkValidationFeaturesEXT validation_features_info = {VK_STRUCTURE_TYPE_VALIDATION_FEATURES_EXT};
+	if (validation_features)
+	{
+		static const VkValidationFeatureEnableEXT enable_features[2] = {
+		    VK_VALIDATION_FEATURE_ENABLE_GPU_ASSISTED_RESERVE_BINDING_SLOT_EXT,
+		    VK_VALIDATION_FEATURE_ENABLE_GPU_ASSISTED_EXT,
+		};
+		validation_features_info.enabledValidationFeatureCount = 2;
+		validation_features_info.pEnabledValidationFeatures    = enable_features;
+		validation_features_info.pNext                         = instance_info.pNext;
+		instance_info.pNext                                    = &validation_features_info;
+	}
+#endif
+
 	// Create the Vulkan instance
 	result = vkCreateInstance(&instance_info, nullptr, &handle);
 

samples/CMakeLists.txt

@@ -61,6 +61,7 @@ set(ORDER_LIST
     "conservative_rasterization"
     "push_descriptors"
     "raytracing_basic"
+    "descriptor_indexing"
 
     #Performance Samples
     "swapchain_images"

samples/README.md

@@ -1,4 +1,3 @@
-<!--
 - Copyright (c) 2020-2021, Arm Limited and Contributors
 -
 - SPDX-License-Identifier: Apache-2.0
@@ -170,4 +169,8 @@ Render a basic scene using the official cross-vendor ray tracing extension. Show
 
 ### [OpenGL interoperability](./extensions/open_gl_interop)<br/>
 **Extensions**: [```VK_KHR_external_memory```](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_KHR_external_memory.html), [```VK_KHR_external_semaphore```](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_KHR_external_semaphore.html)<br/>
-Render a procedural image using OpenGL and incorporate that rendered content into a Vulkan scene.  Demonstrates using the same backing memory for a texture in both OpenGL and Vulkan and how to synchronize the APIs using shared semaphores and barriers.
+Render a procedural image using OpenGL and incorporate that rendered content into a Vulkan scene.  Demonstrates using the same backing memory for a texture in both OpenGL and Vulkan and how to synchronize the APIs using shared semaphores and barriers.
+
+### [Descriptor indexing](./extensions/descriptor_indexing)<br/>
+**Extensions**: [```VK_EXT_descriptor_indexing```](https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_EXT_descriptor_indexing.html)
+Demonstrates how to use descriptor indexing to enable update-after-bind and non-dynamically uniform indexing of descriptors.

samples/extensions/descriptor_indexing/CMakeLists.txt

@@ -0,0 +1,27 @@
+# Copyright (c) 2021, Arm Limited and Contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 the "License";
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+get_filename_component(FOLDER_NAME ${CMAKE_CURRENT_LIST_DIR} NAME)
+get_filename_component(PARENT_DIR ${CMAKE_CURRENT_LIST_DIR} PATH)
+get_filename_component(CATEGORY_NAME ${PARENT_DIR} NAME)
+
+add_sample_with_tags(
+        ID ${FOLDER_NAME}
+        CATEGORY ${CATEGORY_NAME}
+        AUTHOR "Hans-Kristian Arntzen"
+        NAME "Descriptor indexing"
+        DESCRIPTION "Demonstrates update-after-bind as well as non-uniform indexing of descriptors (VK_EXT_descriptor_indexing)")