Merge branch 'master' into develop

.github/workflows/ci-build.yml

@@ -25,15 +25,17 @@ on:
     - 'CMake/**'
     - 'CMakeLists.txt'
     - 'CMakePresets.json'
-  schedule:
-    - cron: '20 23 * * 3'
+
+# Do not schedule workflow with "cron", so that it could run in GitHub forks (scheduled workflows are disabled in forks)
 
 env:
   product_ver_major: 0
   product_ver_minor: 7
-  product_ver_patch: 2
+  product_ver_patch: 3
   product_ver_build: ${{ github.run_number }}
   tracy_release_version: "0.9.1"
+  vulkan_sdk_version: "1.3.250.1"
+  is_origin_repository: ${{ github.repository == 'MethanePowered/MethaneKit' }}
   # TSC Invariant check is disabled to allow running Catch test executables only for tests list query by CTest
   TRACY_NO_INVARIANT_CHECK: 1
 
@@ -53,6 +55,7 @@ jobs:
             named_logo: Windows
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -62,6 +65,7 @@ jobs:
             named_logo: Windows
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -71,6 +75,7 @@ jobs:
             named_logo: Windows
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -80,6 +85,7 @@ jobs:
             named_logo: Windows
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -89,6 +95,7 @@ jobs:
             named_logo: Windows
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -98,6 +105,7 @@ jobs:
             named_logo: Windows
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -107,6 +115,7 @@ jobs:
             named_logo: Windows
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
 
           - os: windows-latest
             os_name: Windows
@@ -116,6 +125,7 @@ jobs:
             named_logo: Windows
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
 
           - os: ubuntu-latest
             os_name: Ubuntu
@@ -125,6 +135,7 @@ jobs:
             named_logo: Linux
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: ubuntu-latest
             os_name: Ubuntu
@@ -134,6 +145,17 @@ jobs:
             named_logo: Linux
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
+
+          - os: macos-latest
+            os_name: MacOS
+            name: "MacOS_VK_Release"
+            config_preset: "Xcode-Mac-VK-Default"
+            build_preset: "Xcode-Mac-VK-Release"
+            named_logo: Apple
+            run_tests: true
+            add_tracy_app: false
+            install_vulkan_sdk: true
 
           - os: macos-latest
             os_name: MacOS
@@ -143,6 +165,7 @@ jobs:
             named_logo: Apple
             run_tests: true
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: macos-latest
             os_name: MacOS
@@ -152,6 +175,7 @@ jobs:
             named_logo: Apple
             run_tests: false
             add_tracy_app: true
+            install_vulkan_sdk: false
 
           - os: macos-latest
             os_name: MacOS
@@ -161,6 +185,7 @@ jobs:
             named_logo: Apple
             run_tests: false
             add_tracy_app: false
+            install_vulkan_sdk: false
 
           - os: macos-latest
             os_name: MacOS
@@ -170,6 +195,7 @@ jobs:
             named_logo: Apple
             run_tests: false
             add_tracy_app: false
+            install_vulkan_sdk: false
 
     runs-on: ${{ matrix.os }}
 
@@ -187,10 +213,45 @@ jobs:
       uses: actions/checkout@v3
 
     - name: Install Testspace
+      if: ${{ env.is_origin_repository }}
       uses: testspace-com/setup-testspace@v1
       with:
         domain: ${{ github.repository_owner }}
 
+    - name: Install Vulkan SDK ${{ env.vulkan_sdk_version }}
+      if: ${{ matrix.install_vulkan_sdk }}
+      run: |
+        runner_os=$(uname -s)
+        case $runner_os in
+          macOS|Darwin) sdk_os=mac ; sdk_os_subdir=macOS ;;
+          Linux) sdk_os=linux ; sdk_os_subdir=linux ;;
+          Windows|MINGW*) sdk_os=windows ; sdk_os_subdir=windows ;;
+          *) echo "Unknown runner_os: $runner_os" ; exit 7 ; ;;
+        esac
+        sdk_ver="${{ env.vulkan_sdk_version }}"
+        sdk_dir="${{ runner.tool_cache }}/VulkanSDK"
+        sdk_ver_dir="$sdk_dir/$sdk_ver/$sdk_os_subdir"
+        if [ -d "$sdk_ver_dir" ]; then
+          echo "Vulkan SDK version directory already exists: $sdk_ver_dir"
+        else
+          test -d $sdk_dir || mkdir -pv $sdk_dir
+          vulkan_sdk_url=https://github.com/MethanePowered/VulkanHeaders/releases/download/sdk-$sdk_ver/vulkan_sdk_$sdk_os.7z
+          echo "Downloading Vulkan SDK archive $vulkan_sdk_url ..."
+          curl -sSLo vulkan_sdk.7z $vulkan_sdk_url
+          echo "Unpacking Vulkan SDK archive to $sdk_dir ..."
+          7z x vulkan_sdk.7z -o$sdk_dir
+          if [ ! -d $sdk_ver_dir ]; then
+            echo "Vulkan SDK subdirectory not found: $sdk_ver_dir"
+            exit 7
+          fi
+        fi
+        echo "Setting VULKAN_SDK* environment variables..."
+        echo "VULKAN_SDK=$sdk_ver_dir" >> $GITHUB_ENV
+        echo "VULKAN_SDK_VERSION=$sdk_ver" >> $GITHUB_ENV
+        echo "VULKAN_SDK_PLATFORM=$sdk_os" >> $GITHUB_ENV
+        echo "PATH=$PATH:$sdk_ver_dir/bin" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=$sdk_ver_dir/lib:${DYLD_LIBRARY_PATH:-}" >> $GITHUB_ENV
+
     - name: Initialize Externals Cache
       uses: actions/cache@v3
       with:
@@ -255,7 +316,7 @@ jobs:
         path: ${{ env.INSTALL_DIR }}/Tests/*_result.xml
 
     - name: Upload Test Results and Build Log to Testspace server
-      if: ${{ matrix.run_tests && (success() || failure()) }}
+      if: ${{ env.is_origin_repository && matrix.run_tests && (success() || failure()) }}
       run: testspace "[ ${{ matrix.name }} ]${{ env.INSTALL_DIR }}/Tests/*_result.xml" "[ ${{ matrix.name }} ]${{ env.BUILD_LOG_FILE }}"
 
     - name: Add README and BUILD files
@@ -300,7 +361,7 @@ jobs:
 
     - name: Update Badge Parameters
       id: badge-params
-      if: ${{ github.event_name == 'push' && always() }}
+      if: ${{ env.is_origin_repository && github.event_name == 'push' && always() }}
       shell: bash
       run: |
         case "${{ job.status }}" in
@@ -323,7 +384,7 @@ jobs:
         esac
 
     - name: Update Badge JSON
-      if: ${{ github.event_name == 'push' && always() }}
+      if: ${{ env.is_origin_repository && github.event_name == 'push' && always() }}
       uses: schneegans/[email protected] # https://github.com/marketplace/actions/dynamic-badges
       with:
         auth: ${{ secrets.GIST_TOKEN }}

.github/workflows/ci-codeql-scan.yml

@@ -26,11 +26,12 @@ on:
     - 'CMakeLists.txt'
     - 'CMakePresets.json'
   schedule:
-    - cron: '20 23 * * 3'
+    - cron: '20 23 * * 3' # Scheduled workflow will not run in GitHub forks
 
 jobs:
   analyze:
     name: ${{ matrix.name }}
+    if: ${{ github.repository == 'MethanePowered/MethaneKit' }}
 
     strategy:
       fail-fast: false
@@ -41,10 +42,12 @@ jobs:
           #  name: "Win64_DX_CodeQL-Scan"
           #  config_preset: "VS2022-Win64-DX-Scan"
           #  build_preset: "VS2022-Win64-DX-Scan"
+
           - os: ubuntu-latest
             name: "Ubuntu_VK_CodeQL-Scan"
             config_preset: "Make-Lin-VK-Scan"
             build_preset: "Make-Lin-VK-Scan"
+
           - os: macos-latest
             name: "MacOS_MTL_CodeQL-Scan"
             config_preset: "Xcode-Mac-MTL-Scan"

.github/workflows/ci-sonar-scan.yml

@@ -32,11 +32,13 @@ on:
       - 'CMake/**'
       - 'CMakeLists.txt'
       - 'CMakePresets.json'
+  schedule:
+    - cron: '20 23 * * 3' # Scheduled workflow will not run in GitHub forks
 
 env:
   product_ver_major: 0
   product_ver_minor: 7
-  product_ver_patch: 2
+  product_ver_patch: 3
   product_ver_build: ${{ github.run_number }}
   sonar_server_url: "https://sonarcloud.io"
   sonar_organization: methane-powered
@@ -45,6 +47,7 @@ env:
 jobs:
   sonar_scan:
     name: ${{ matrix.name }}
+    if: ${{ github.repository == 'MethanePowered/MethaneKit' }}
 
     strategy:
       fail-fast: false
@@ -108,7 +111,7 @@ jobs:
           dotnet-version: 6.0.400
 
       - name: Install Sonar-Scanner
-        uses: sonarsource/sonarcloud-github-c-cpp@v1
+        uses: sonarsource/sonarcloud-github-c-cpp@v2
 
       - name: Install Ninja
         uses: MethanePowered/gha-setup-ninja@master

.github/workflows/ci-tests-report.yml

@@ -22,6 +22,7 @@ jobs:
           - name: "Win32_DX_Release"
           - name: "Win32_VK_Release"
           - name: "Ubuntu_VK_Release"
+          - name: "MacOS_VK_Release"
           - name: "MacOS_MTL_Release"
 
     runs-on: ubuntu-latest

Apps/01-HelloTriangle/HelloTriangleApp.cpp

@@ -87,7 +87,7 @@ class HelloTriangleApp final // NOSONAR - destructor required
         for (HelloTriangleFrame& frame : GetFrames())
         {
             frame.render_cmd_list = cmd_queue.CreateRenderCommandList(frame.screen_pass);
-            frame.render_cmd_list.SetName(IndexedName("Render Triangle", frame.index));
+            frame.render_cmd_list.SetName(fmt::format("Render Triangle {}", frame.index));
             frame.execute_cmd_list_set = Rhi::CommandListSet({ frame.render_cmd_list.GetInterface() }, frame.index);
         }
 

Apps/01-HelloTriangle/README.md

@@ -138,7 +138,7 @@ public:
         for (HelloTriangleFrame& frame : GetFrames())
         {
             frame.render_cmd_list = cmd_queue.CreateRenderCommandList(frame.screen_pass);
-            frame.render_cmd_list.SetName(IndexedName("Render Triangle", frame.index));
+            frame.render_cmd_list.SetName(fmt::format("Render Triangle {}", frame.index));
             frame.execute_cmd_list_set = Rhi::CommandListSet({ frame.render_cmd_list.GetInterface() }, frame.index);
         }
 

Apps/02-HelloCube/HelloCubeApp.cpp

@@ -204,23 +204,23 @@ class HelloCubeApp final // NOSONAR - destructor required
 #ifdef UNIFORMS_BUFFER_ENABLED
             // Create uniforms buffer with volatile parameters for frame rendering
             frame.uniforms_buffer = GetRenderContext().CreateBuffer(Rhi::BufferSettings::ForConstantBuffer(uniforms_data_size, false, true));
-            frame.uniforms_buffer.SetName(IndexedName("Uniforms Buffer", frame.index));
+            frame.uniforms_buffer.SetName(fmt::format("Uniforms Buffer {}", frame.index));
 
             // Configure program resource bindings
             frame.program_bindings = m_render_state.GetProgram().CreateBindings({
                 { { Rhi::ShaderType::Vertex, "g_uniforms"  }, { { frame.uniforms_buffer.GetInterface() } } }
             }, frame.index);
-            frame.program_bindings.SetName(IndexedName("Cube Bindings {}", frame.index));
+            frame.program_bindings.SetName(fmt::format("Cube Bindings {}", frame.index));
 #else
             // Create vertex buffers for each frame
             Rhi::Buffer vertex_buffer = GetRenderContext().CreateBuffer(Rhi::BufferSettings::ForVertexBuffer(m_cube_mesh.GetVertexDataSize(), m_cube_mesh.GetVertexSize(), true));
-            vertex_buffer.SetName(IndexedName("Cube Vertex Buffer", frame.index));
+            vertex_buffer.SetName(fmt::format("Cube Vertex Buffer {}", frame.index));
             frame.vertex_buffer_set = Rhi::BufferSet(Rhi::BufferType::Vertex, { vertex_buffer });
 #endif
 
             // Create command list for rendering
             frame.render_cmd_list = m_render_cmd_queue.CreateRenderCommandList(frame.screen_pass);
-            frame.render_cmd_list.SetName(IndexedName("Cube Rendering", frame.index));
+            frame.render_cmd_list.SetName(fmt::format("Cube Rendering {}", frame.index));
             frame.execute_cmd_list_set = Rhi::CommandListSet({ frame.render_cmd_list.GetInterface() }, frame.index);
         }
 

Apps/03-TexturedCube/TexturedCubeApp.cpp

@@ -157,7 +157,7 @@ void TexturedCubeApp::Init()
     {
         // Create uniforms buffer with volatile parameters for frame rendering
         frame.uniforms_buffer = GetRenderContext().CreateBuffer(rhi::BufferSettings::ForConstantBuffer(uniforms_data_size, false, true));
-        frame.uniforms_buffer.SetName(IndexedName("Uniforms Buffer", frame.index));
+        frame.uniforms_buffer.SetName(fmt::format("Uniforms Buffer {}", frame.index));
 
         // Configure program resource bindings
         frame.program_bindings = m_render_state.GetProgram().CreateBindings({
@@ -166,11 +166,11 @@ void TexturedCubeApp::Init()
             { { rhi::ShaderType::Pixel, "g_texture"   }, { { m_cube_texture.GetInterface()        } } },
             { { rhi::ShaderType::Pixel, "g_sampler"   }, { { m_texture_sampler.GetInterface()     } } },
         }, frame.index);
-        frame.program_bindings.SetName(IndexedName("Cube Bindings", frame.index));
+        frame.program_bindings.SetName(fmt::format("Cube Bindings {}", frame.index));
 
         // Create command list for rendering
         frame.render_cmd_list = render_cmd_queue.CreateRenderCommandList(frame.screen_pass);
-        frame.render_cmd_list.SetName(IndexedName("Cube Rendering", frame.index));
+        frame.render_cmd_list.SetName(fmt::format("Cube Rendering {}", frame.index));
         frame.execute_cmd_list_set = rhi::CommandListSet({ frame.render_cmd_list.GetInterface() }, frame.index);
     }