Add a new sample - subgroups operations #715
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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") |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
Contributor
There was a problem hiding this comment. Typo: focuse -> focuses |
||
| 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 | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems, you've removed a couple of samples?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mobica#9 <-- hopefully they are not removed after the merge.