Add a new sample - subgroups operations

framework/api_vulkan_sample.h

@@ -294,7 +294,7 @@ class ApiVulkanSample : public vkb::VulkanSampleC
 	/**
 	 * @brief Creates a new (graphics) command pool object storing command buffers
 	 */
-	void create_command_pool();
+	virtual void create_command_pool();
 
 	/**
 	 * @brief Setup default depth and stencil views

samples/CMakeLists.txt

@@ -48,99 +48,90 @@ endforeach ()
 
 # Order of the sample ids
 set(ORDER_LIST
-    #API Samples
-    "hello_triangle"
-    "dynamic_uniform_buffers"
-    "texture_loading"
-    "hdr"
-    "instancing"
-    "compute_nbody"
-    "terrain_tessellation"
-    "hlsl"
-    "oit_linked_lists"
-    "oit_depth_peeling"
-
-    #Extension Samples
-    "dynamic_rendering"
-    "conservative_rasterization"
-    "fragment_shading_rate"
-    "fragment_shading_rate_dynamic"
-    "full_screen_exclusive"
-    "calibrated_timestamps"
-    "graphics_pipeline_library"
-    "memory_budget"
-    "mesh_shader_culling"
-    "push_descriptors"
-    "ray_queries"
-    "ray_tracing_basic"
-    "ray_tracing_extended"
-    "ray_tracing_reflection"
-    "timeline_semaphore"
-    "shader_object"
-    "shader_debugprintf"
-    "synchronization_2"
-    "buffer_device_address"
-    "descriptor_indexing"
-    "portability"
-    "vertex_dynamic_state"
-    "extended_dynamic_state2"
-    "logic_op_dynamic_state"
-    "patch_control_points"
-    "fragment_shader_barycentric"
-    "gshader_to_mshader"
-    "color_write_enable"
-    "sparse_image"
-    "dynamic_primitive_clipping"
-
-    #Performance Samples
-    "swapchain_images"
-    "surface_rotation"
-    "pipeline_cache"
-    "descriptor_management"
-    "constant_data"
-    "render_passes"
-    "msaa"
-    "subpasses"
-    "pipeline_barriers"
-    "wait_idle"
-    "layout_transitions"
-    "specialization_constants"
-    "command_buffer_usage"
-    "multithreading_render_passes"
-    "afbc"
-    "16bit_storage_input_output"
-    "16bit_arithmetic"
-    "async_compute"
-    "multi_draw_indirect"
-    "texture_compression_comparison"
-
-    #Tooling samples
-    "profiles"
-
-    #HPP API Samples
-    "hpp_compute_nbody"
-	"hpp_dynamic_uniform_buffers"
-	"hpp_hdr"
-    "hpp_hello_triangle"
-	"hpp_hlsl_shaders"
-	"hpp_instancing"
-	"hpp_oit_depth_peeling"
-	"hpp_oit_linked_lists"
-	"hpp_separate_image_sampler"
-	"hpp_terrain_tessellation"
-	"hpp_texture_loading"
-	"hpp_texture_mipmap_generation"
-
-	#HPP Extension Samples
-	"hpp_mesh_shading"
-
-    #HPP Performance Samples
-    "hpp_pipeline_cache"
-    "hpp_swapchain_images"
-	"hpp_texture_compression_comparison"
-
-    #General Samples
-    "mobile_nerf")
+  #API Samples
+        "hello_triangle"
+        "dynamic_uniform_buffers"
+        "texture_loading"
+        "hdr"
+        "instancing"
+        "compute_nbody"
+        "terrain_tessellation"
+        "hlsl"
+
+        #Extension Samples
+        "dynamic_rendering"
+        "conservative_rasterization"
+        "fragment_shading_rate"
+        "fragment_shading_rate_dynamic"
+        "full_screen_exclusive"
+        "calibrated_timestamps"
+        "graphics_pipeline_library"
+        "memory_budget"
+        "mesh_shader_culling"
+        "push_descriptors"
+        "ray_queries"
+        "ray_tracing_basic"
+        "ray_tracing_extended"
+        "ray_tracing_reflection"
+        "timeline_semaphore"
+        "shader_object"
+        "synchronization_2"
+        "buffer_device_address"
+        "descriptor_indexing"
+        "portability"
+        "vertex_dynamic_state"
+        "extended_dynamic_state2"
+        "logic_op_dynamic_state"
+        "patch_control_points"
+        "fragment_shader_barycentric"
+        "gshader_to_mshader"
+        "color_write_enable"
+        "subgroups_operations"
+
+        #Performance Samples
+        "swapchain_images"
+        "surface_rotation"
+        "pipeline_cache"
+        "descriptor_management"
+        "constant_data"
+        "render_passes"
+        "msaa"
+        "subpasses"
+        "pipeline_barriers"
+        "wait_idle"
+        "layout_transitions"
+        "specialization_constants"
+        "command_buffer_usage"
+        "multithreading_render_passes"
+        "afbc"
+        "16bit_storage_input_output"
+        "16bit_arithmetic"
+        "async_compute"
+        "multi_draw_indirect"
+        "texture_compression_comparison"
+
+        #Tooling samples
+        "profiles"
+
+        #HPP API Samples
+        "hpp_compute_nbody"
+        "hpp_dynamic_uniform_buffers"
+        "hpp_hdr"
+        "hpp_hello_triangle"
+        "hpp_hlsl_shaders"
+        "hpp_instancing"
+        "hpp_separate_image_sampler"
+        "hpp_terrain_tessellation"
+        "hpp_texture_loading"
+        "hpp_texture_mipmap_generation"
+
+        #HPP Performance Samples
+        "hpp_pipeline_cache"
+        "hpp_swapchain_images"
+	    "hpp_texture_compression_comparison"
+
+        #General Samples
+        "mobile_nerf")
 
 # Orders the sample ids by the order list above
 set(ORDERED_LIST)

samples/extensions/subgroups_operations/CMakeLists.txt

@@ -0,0 +1,43 @@
+ # Copyright (c) 2024, Mobica Limited
+ #
+ # 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(
+    ID ${FOLDER_NAME}
+    CATEGORY ${CATEGORY_NAME}
+    AUTHOR "Mobica"
+    NAME "subgroups_operations"
+    DESCRIPTION "Demonstrates the use of a subgroups operations feature"
+    SHADER_FILES_GLSL
+         "subgroups_operations/ocean.vert"
+         "subgroups_operations/ocean.frag"
+         "subgroups_operations/ocean.tesc"
+         "subgroups_operations/ocean.tese"
+         "subgroups_operations/fft_invert.comp"
+         "subgroups_operations/butterfly_precomp.comp"
+         "subgroups_operations/fft_tilde_h.comp"
+         "subgroups_operations/fft_tilde_h0.comp"
+         "subgroups_operations/fft_normal_map.comp"
+         "subgroups_operations/fft.comp"
+         "subgroups_operations/fft_invert_subgroups_off.comp"
+         "subgroups_operations/butterfly_precomp_subgroups_off.comp"
+         "subgroups_operations/fft_tilde_h_subgroups_off.comp"
+         "subgroups_operations/fft_tilde_h0_subgroups_off.comp"
+         "subgroups_operations/fft_normal_map_subgroups_off.comp"
+         "subgroups_operations/fft_subgroups_off.comp")

samples/extensions/subgroups_operations/README.adoc

@@ -0,0 +1,98 @@
+////
+Copyright (c) 2024, Mobica Limited
+
+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.
+////
+
+= Subgroups Operations
+
+== Overview
+
+The example demonstrates the use of the feature subgroups operations. An ocean animation based on the FFT is implemented to demonstrate this feature (Fast Fourier Transform https://en.wikipedia.org/wiki/Fast_Fourier_transform).
+image:image/image.png[]
+
+Subgroups operation feature introduces a mechanism to share data between the invocations that run in parallel on a single compute unit. 
+
+
+== GLSL Shaders
+
+To make full use of the feature subgroups operation, one of the following extensions must be enabled:
+
+* `#extension GL_KHR_shader_subgroup_basic`
+
+* `#extension GL_KHR_shader_subgroup_vote`
+
+* `#extension GL_KHR_shader_subgroup_ballot`
+
+* `#extension GL_KHR_shader_subgroup_arithmetic`
+
+* `#extension GL_KHR_shader_subgroup_shuffle`
+
+* `#extension GL_KHR_shader_subgroup_shuffle_relative`
+
+* `#extension GL_KHR_shader_subgroup_clustered`
+
+* `#extension GL_KHR_shader_subgroup_quad`
+
+
+This sample focuse on `GL_KHR_shader_subgroup_basic` extension.
+More about subgroups you can read in this article https://www.khronos.org/blog/vulkan-subgroup-tutorial.
+
+
+== Enabling the Feature
+
+In order to use subgroups operations, the required extensions must be enabled, an instance of the Vulkan API must be created with a minimum of version 1.1 and SPIR-V 1.4 must be used.
+
+VkDevice must be created with this `VK_EXT_subgroup_size_control` extension.
+It is also required to enable `VK_KHR_spirv_1_4` and `VK_KHR_shader_float_controls` in addition (`VK_KHR_spirv_1_4` requires this).
+
+
+To get the properties of the supported subgroups, the following should be taken:
+[,cpp]
+----
+VkPhysicalDeviceSubgroupProperties subgroups_properties;
+subgroups_properties.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_PROPERTIES;
+subgroups_properties.pNext = VK_NULL_HANDLE;
+
+VkPhysicalDeviceProperties2 device_properties2 = {};
+device_properties2.sType                       = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2;
+device_properties2.pNext                       = &subgroups_properties;
+vkGetPhysicalDeviceProperties2(gpu.get_handle(), &device_properties2);
+----
+
+
+== Documentation
+
+* https://docs.vulkan.org/guide/latest/subgroups.html
+
+* https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkPhysicalDeviceSubgroupProperties.html
+
+* https://www.khronos.org/blog/vulkan-subgroup-tutorial
+
+
+== Sources
+The implementation was based on the following sources:
+
+* https://tore.tuhh.de/entities/publication/1cd390d3-732b-41c1-aa2b-07b71a64edd2
+* https://people.computing.clemson.edu/~jtessen/reports/papers_files/coursenotes2004.pdf
+* https://github.com/achalpandeyy/OceanFFT
+* https://github.com/deiss/fftocean
+* https://github.com/iamyoukou/fftWater
+
+== Authors
+* Patryk Jastrzębski
+* Krzysztof Dmitruk
+* Seweryn Zielas
+* Piotr Plenański