Merge pull request #1691 from CesiumGS/ue56

Add support for Unreal Engine 5.6

Author: j9liu

.github/actions/install-unreal-windows/action.yml

@@ -29,7 +29,14 @@ runs:
       run: |
         7z x -mmt=8 "D:/Program Files/Epic Games/UE.zip" "-oD:/Program Files/Epic Games/"
         del "D:/Program Files/Epic Games/UE.zip"
-    - name: Install Unreal Engine
+    - name: Install Unreal Engine (older versions)
+      if: ${{ inputs.unreal-program-name != 'UE_5.6' }}
       shell: pwsh
       run: |
         Start-Process "D:/Program Files/Epic Games/${{ inputs.unreal-program-name }}/Engine/Extras/Redist/en-us/UEPrereqSetup_x64.exe" -Args "-q" -Wait
+    - name: Install Unreal Engine (5.6+)
+      if: ${{ inputs.unreal-program-name == 'UE_5.6' }}
+      shell: pwsh
+      run: |
+        Start-Process "D:/Program Files/Epic Games/${{ inputs.unreal-program-name }}/Engine/Extras/Redist/en-us/vc_redist.x64.exe" -Args "-q" -Wait
+        

.github/workflows/build.yml

@@ -390,3 +390,121 @@ jobs:
       test-package-base-name: "CesiumForUnreal-55"
       visual-studio-version: "2022"
       visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.38.17.8.x86.x64,Microsoft.VisualStudio.Component.Windows11SDK.22621"
+  Windows56:
+    uses: ./.github/workflows/buildWindows.yml
+    secrets: inherit
+    with:
+      runner-label: "windows-2022"
+      unreal-engine-version: "5.6.0"
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/UE_5.6.zip"
+      unreal-program-name: "UE_5.6"
+      upload-package-base-name: "CesiumForUnreal-56-windows"
+      # These are specified in the Unreal Engine release notes under "IDE Version the Build farm compiles against"
+      # and using them ensures we're compiling our plugin in the exact same way that Unreal Engine itself is compiled.
+      cmake-generator: "Visual Studio 17 2022"
+      cmake-toolchain: "version=14.38"
+      cmake-platform: "x64,version=10.0.22621.0"
+      visual-studio-version: "2022"
+      visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.38.17.8.x86.x64,Microsoft.VisualStudio.Component.Windows11SDK.22621"
+  TestWindows56:
+    needs: [Windows56]
+    uses: ./.github/workflows/testWindows.yml
+    secrets: inherit
+    with:
+      runner-label: windows-2022
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/UE_5.6.zip"
+      unreal-program-name: "UE_5.6"
+      test-package-base-name: "CesiumForUnreal-56-windows"
+  Android56:
+    uses: ./.github/workflows/buildAndroid.yml
+    secrets: inherit
+    with:
+      runner-label: windows-2022
+      unreal-engine-version: "5.6.0"
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/UE_5.6.zip"
+      unreal-program-name: "UE_5.6"
+      upload-package-base-name: "CesiumForUnreal-56-android"
+      android-ndk-version: "r25b"
+  Linux56:
+    uses: ./.github/workflows/buildLinux.yml
+    secrets: inherit
+    with:
+      runner-label: ubuntu-22.04
+      unreal-engine-version: "5.6.0"
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/Linux_Unreal_Engine_5.6.0.zip"
+      unreal-program-name: "UE_5.6"
+      upload-package-base-name: "CesiumForUnreal-56-linux"
+      clang-version: "v25_clang-18.1.0-rockylinux8"
+  Apple56:
+    uses: ./.github/workflows/buildApple.yml
+    secrets: inherit
+    with:
+      runner-label: macos-14
+      unreal-engine-version: "5.6.0"
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/UE_56-mac.zip"
+      unreal-program-name: "UE_5.6"
+      upload-package-base-name: "CesiumForUnreal-56-apple"
+      xcode-version: "16.1"
+  Combine56:
+    runs-on: ubuntu-latest
+    needs: [Windows56, Android56, Linux56, Apple56]
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Set environment variables
+        run: |
+          export CESIUM_UNREAL_VERSION=$GITHUB_REF_NAME
+          export BUILD_CESIUM_UNREAL_PACKAGE_NAME="CesiumForUnreal-56-${CESIUM_UNREAL_VERSION}"
+          export BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME="CesiumForUnreal-56-SourceOnly-${CESIUM_UNREAL_VERSION}"
+          # Make these available to subsequent steps
+          echo "CESIUM_UNREAL_VERSION=$CESIUM_UNREAL_VERSION" >> $GITHUB_ENV
+          echo "BUILD_CESIUM_UNREAL_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_PACKAGE_NAME" >> $GITHUB_ENV
+          echo "BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME" >> $GITHUB_ENV
+      - name: Download Apple build
+        uses: actions/download-artifact@v4
+        with:
+          name: CesiumForUnreal-56-apple-${{ env.CESIUM_UNREAL_VERSION}}
+          path: combine
+      - name: Download Android build
+        uses: actions/download-artifact@v4
+        with:
+          name: CesiumForUnreal-56-android-${{ env.CESIUM_UNREAL_VERSION}}
+          path: combine
+      - name: Download Linux build
+        uses: actions/download-artifact@v4
+        with:
+          name: CesiumForUnreal-56-linux-${{ env.CESIUM_UNREAL_VERSION}}
+          path: combine
+      - name: Download Windows build
+        uses: actions/download-artifact@v4
+        with:
+          name: CesiumForUnreal-56-windows-${{ env.CESIUM_UNREAL_VERSION}}
+          path: combine
+      - name: Publish combined package artifact
+        if: ${{ success() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.BUILD_CESIUM_UNREAL_PACKAGE_NAME}}
+          path: combine
+      - name: Publish combined package artifact for the Unreal Marketplace
+        if: ${{ success() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME}}
+          path: |
+            combine
+            # These are built by Epic, and including them seems to confuse their process.
+            !combine/CesiumForUnreal/Binaries/**/*
+            !combine/CesiumForUnreal/Intermediate/**/*
+  TestPackage56:
+    needs: [Combine56]
+    uses: ./.github/workflows/testPackageOnWindows.yml
+    secrets: inherit
+    with:
+      runner-label: windows-2022
+      unreal-engine-zip: "s3://cesium-unreal-engine/5.6.0/UE_5.6.zip"
+      unreal-program-name: "UE_5.6"
+      unreal-engine-association: "5.6"
+      test-package-base-name: "CesiumForUnreal-56"
+      visual-studio-version: "2022"
+      visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.38.17.8.x86.x64,Microsoft.VisualStudio.Component.Windows11SDK.22621"

.github/workflows/buildApple.yml

@@ -50,10 +50,16 @@ jobs:
           sudo rm -rf /Applications/Xcode_15.2.app
           sudo rm -rf /Applications/Xcode_15.3.0.app
           sudo rm -rf /Applications/Xcode_15.3.app
+          if [ "${{ inputs.xcode-version }}" != "15.4" ]; then
+            sudo rm -rf /Applications/Xcode_15.4.0.app
+            sudo rm -rf /Applications/Xcode_15.4.app
+          fi
           sudo rm -rf /Applications/Xcode_16.0.0.app
           sudo rm -rf /Applications/Xcode_16.0.app
-          sudo rm -rf /Applications/Xcode_16.1.0.app
-          sudo rm -rf /Applications/Xcode_16.1.app
+          if [ "${{ inputs.xcode-version }}" != "16.1" ]; then
+            sudo rm -rf /Applications/Xcode_16.1.0.app
+            sudo rm -rf /Applications/Xcode_16.1.app
+          fi
           sudo rm -rf /Applications/Xcode_16.1_beta.app
           sudo rm -rf /Applications/Xcode_16_beta_6.app
           ls /Applications

.github/workflows/buildLinux.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Removed unneeded packages to gain disk space
         run: |
           sudo apt update
-          sudo apt remove google-chrome-stable clang-13 clang-14 clang-15 llvm-13-dev llvm-13-linker-tools llvm-13-runtime llvm-13-tools llvm-13 llvm-14-dev llvm-14-linker-tools llvm-14-runtime llvm-14-tools llvm-14 llvm-15-dev llvm-15-linker-tools llvm-15-runtime llvm-15-tools llvm-15 x11-common xserver-common aspnetcore-runtime-6.0 aspnetcore-runtime-7.0 aspnetcore-runtime-8.0 aspnetcore-targeting-pack-6.0 aspnetcore-targeting-pack-7.0 aspnetcore-targeting-pack-8.0 docker-ce-cli docker-ce dotnet-apphost-pack-6.0 dotnet-apphost-pack-7.0 dotnet-apphost-pack-8.0 dotnet-host dotnet-hostfxr-6.0 dotnet-hostfxr-7.0 dotnet-hostfxr-8.0 dotnet-runtime-6.0 dotnet-runtime-7.0 dotnet-runtime-8.0 dotnet-runtime-deps-6.0 dotnet-runtime-deps-7.0 dotnet-runtime-deps-8.0 dotnet-sdk-6.0 dotnet-sdk-7.0 dotnet-sdk-8.0 dotnet-targeting-pack-6.0 dotnet-targeting-pack-7.0 dotnet-targeting-pack-8.0 eatmydata emacsen-common firebird3.0-common-doc firebird3.0-common firefox kubectl mercurial-common mercurial microsoft-edge-stable mssql-tools mysql-client-8.0 mysql-client-core-8.0 mysql-client mysql-common mysql-server-8.0 php8.1 postgresql-14 azure-cli microsoft-edge-stable google-cloud-cli temurin-21-jdk temurin-17-jdk temurin-11-jdk temurin-8-jdk powershell google-cloud-cli-anthoscli mysql-server-core-8.0 containerd.io libllvm15 libllvm14 libllvm13 mono-devel libclang-common-15-dev libclang-common-14-dev libclang-common-13-dev
+          sudo apt remove google-chrome-stable clang-13 clang-14 clang-15 clang-format-13 clang-format-14 clang-format-15 llvm-13-dev llvm-13-linker-tools llvm-13-runtime llvm-13-tools llvm-13 llvm-14-dev llvm-14-linker-tools llvm-14-runtime llvm-14-tools llvm-14 llvm-15-dev llvm-15-linker-tools llvm-15-runtime llvm-15-tools llvm-15 x11-common xserver-common aspnetcore-runtime-6.0 aspnetcore-runtime-7.0 aspnetcore-runtime-8.0 aspnetcore-runtime-9.0 aspnetcore-targeting-pack-6.0 aspnetcore-targeting-pack-7.0 aspnetcore-targeting-pack-8.0 aspnetcore-targeting-pack-9.0 docker-ce-cli docker-ce dotnet-apphost-pack-6.0 dotnet-apphost-pack-7.0 dotnet-apphost-pack-8.0 dotnet-apphost-pack-9.0 dotnet-host dotnet-hostfxr-6.0 dotnet-hostfxr-7.0 dotnet-hostfxr-8.0 dotnet-hostfxr-9.0 dotnet-runtime-6.0 dotnet-runtime-7.0 dotnet-runtime-8.0 dotnet-runtime-9.0 dotnet-runtime-deps-6.0 dotnet-runtime-deps-7.0 dotnet-runtime-deps-8.0 dotnet-runtime-deps-9.0 dotnet-sdk-6.0 dotnet-sdk-7.0 dotnet-sdk-8.0 dotnet-sdk-9.0 dotnet-targeting-pack-6.0 dotnet-targeting-pack-7.0 dotnet-targeting-pack-8.0 dotnet-targeting-pack-9.0 eatmydata emacsen-common firebird3.0-common-doc firebird3.0-common firefox kubectl mercurial-common mercurial microsoft-edge-stable mssql-tools mysql-client-8.0 mysql-client-core-8.0 mysql-client mysql-common mysql-server-8.0 php8.1 postgresql-14 azure-cli microsoft-edge-stable google-cloud-cli temurin-21-jdk temurin-17-jdk temurin-11-jdk temurin-8-jdk powershell google-cloud-cli-anthoscli mysql-server-core-8.0 containerd.io libllvm15 libllvm14 libllvm13 mono-devel libclang-common-15-dev libclang-common-14-dev libclang-common-13-dev apache2-bin apache2-data apache2-utils apache2 containerd.io cpp-9 cpp-10 cpp-11 cpp-12 cpp docker-ce-cli docker-ce emacsen-common g++-9 g++-10 g++-11 g++-12 g++ gcc-9-base gcc-10-base gcc-11-base gcc-9 gcc-10 gcc-11 gcc-12 gcc gfortran-9 gfortran-10 gfortran-11 gfortran-12 gfortran
           df -h
       - name: Create some space to work in /mnt
         run: |
@@ -60,8 +60,6 @@ jobs:
           unreal-program-name: ${{ inputs.unreal-program-name }}
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-      - name: Install nasm
-        uses: ilammy/[email protected]
       - name: Install Ninja and patchelf
         run: |
           sudo apt install -y ninja-build patchelf

CHANGES.md

@@ -2,6 +2,12 @@
 
 ### ? - ?
 
+This is the last release of Cesium for Unreal that will support Unreal Engine v5.3. Future versions will require Unreal Engine v5.4+.
+
+##### Additions :tada:
+
+- Added support for Unreal Engine 5.6.
+
 ##### Breaking Changes :mega:
 
 - Feature IDs that are encoded by `UCesiumFeaturesMetadataComponent` will now use a default null feature ID of `-1` instead of `0`.

Source/CesiumRuntime/CesiumRuntime.Build.cs

@@ -19,7 +19,8 @@ public CesiumRuntime(ReadOnlyTargetRules Target) : base(Target)
 
         PrivateIncludePaths.AddRange(
             new string[] {
-              Path.Combine(GetModuleDirectory("Renderer"), "Private")
+              Path.Combine(GetModuleDirectory("Renderer"), "Private"),
+              Path.Combine(GetModuleDirectory("Renderer"), "Internal")
             }
         );
 

Source/CesiumRuntime/Private/CesiumGltfPointsSceneProxy.cpp

@@ -7,6 +7,7 @@
 #include "RHIResources.h"
 #include "Runtime/Launch/Resources/Version.h"
 #include "SceneInterface.h"
+#include "SceneView.h"
 #include "StaticMeshResources.h"
 
 FCesiumGltfPointsSceneProxyTilesetData::FCesiumGltfPointsSceneProxyTilesetData()