RageDisplay Vulkan support

.ci/vulkan_prebuilt_helpers.sh

@@ -0,0 +1,103 @@
+# MIT License
+
+# Copyright (c) 2022 humbletim
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# helper functions for downloading/installing platform-specific Vulkan SDKs
+# originally meant for use from GitHub Actions
+#   see: https://github.com/humbletim/install-vulkan-sdk
+# -- humbletim 2022.02
+
+# example of running manually:
+# $ . vulkan_prebuilt_helpers.
+# $ VULKAN_SDK_VERSION=1.3.204.0 download_linux    # fetches vulkan_sdk.tar.gz
+# $ VULKAN_SDK=$PWD/VULKAN_SDK install_linux       # installs
+
+function _os_filename() {
+  case $1 in
+    mac) echo vulkan_sdk.zip ;;
+    linux) echo vulkan_sdk.tar.gz ;;
+    windows) echo vulkan_sdk.exe ;;
+    *) echo "unknown $1" >&2 ; exit 9 ;;
+  esac
+}
+
+function download_vulkan_installer() {
+  local os=$1
+  local filename=$(_os_filename $os)
+  local url=https://sdk.lunarg.com/sdk/download/$VULKAN_SDK_VERSION/$os/$filename?Human=true
+  echo "_download_os_installer $os $filename $url" >&2
+  if [[ -f $filename ]] ; then
+    echo "using cached: $filename" >&2
+  else
+    curl --fail-with-body -s -L -o ${filename}.tmp $url || { echo "curl failed with error code: $?" >&2 ; curl -s -L --head $url >&2 ; exit 32 ; }
+    test -f ${filename}.tmp
+    mv -v ${filename}.tmp ${filename} 
+  fi
+  ls -lh $filename >&2
+}
+
+function unpack_vulkan_installer() {
+  local os=$1
+  local filename=$(_os_filename $os)
+  test -f $filename
+  install_${os}
+}
+
+function install_linux() {
+  test -d $VULKAN_SDK && test -f vulkan_sdk.tar.gz
+  echo "extract just the SDK's prebuilt binaries ($VULKAN_SDK_VERSION/x86_64) from vulkan_sdk.tar.gz into $VULKAN_SDK" >&2
+  tar -C "$VULKAN_SDK" --strip-components 2 -xf vulkan_sdk.tar.gz $VULKAN_SDK_VERSION/x86_64
+}
+
+function install_windows() {
+  test -d $VULKAN_SDK && test -f vulkan_sdk.exe
+  ./vulkan_sdk.exe in --al --am -c -t $VULKAN_SDK
+}
+
+function install_mac() {
+  test -d $VULKAN_SDK && test -f vulkan_sdk.zip
+  unzip vulkan_sdk.zip
+  local InstallVulkan
+  if [[ -d InstallVulkan-${VULKAN_SDK_VERSION}.app/Contents ]] ; then
+    InstallVulkan=InstallVulkan-${VULKAN_SDK_VERSION}
+  elif [[ -d vulkansdk-macOS-${VULKAN_SDK_VERSION}.app/Contents ]] ; then
+    InstallVulkan=vulkansdk-macOS-${VULKAN_SDK_VERSION}
+  elif [[ -d InstallVulkan.app/Contents ]] ; then
+    InstallVulkan=InstallVulkan
+  else
+    echo "expecting ..vulkan.app/Contents folder (perhaps lunarg changed the archive layout again?): vulkan_sdk.zip" >&2
+    echo "file vulkan_sdk.zip" >&2
+    file vulkan_sdk.zip
+    echo "unzip -t vulkan_sdk.zip" >&2
+    unzip -t vulkan_sdk.zip
+    exit 7
+  fi
+  echo "recognized zip layout 'vulkan_sdk.zip' ${InstallVulkan}.app/Contents" >&2
+  local sdk_temp=${VULKAN_SDK}.tmp
+  sudo ${InstallVulkan}.app/Contents/MacOS/${InstallVulkan} --root "$sdk_temp" --accept-licenses --default-answer --confirm-command install
+  du -hs $sdk_temp
+  test -d $sdk_temp/macOS || { echo "unrecognized dmg folder layout: $sdk_temp" ; ls -l $sdk_temp ; exit 10 ; }
+  cp -r $sdk_temp/macOS/* $VULKAN_SDK/
+  if [[ -d ${InstallVulkan}.app/Contents ]] ; then
+    sudo rm -rf "$sdk_temp"
+    rm -rf ${InstallVulkan}.app
+  fi
+}

.ci/vulkan_setup_env.sh

@@ -0,0 +1,55 @@
+# MIT License
+
+# Copyright (c) 2022 humbletim
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# helper functions for downloading/installing platform-specific Vulkan SDKs
+# originally meant for use from GitHub Actions
+#   see: https://github.com/humbletim/install-vulkan-sdk
+# -- humbletim 2022.02
+
+function preset_env() {
+    basedir=$PWD
+    runner_os=${RUNNER_OS:-`uname -s`}
+    case $runner_os in
+        macOS|Darwin) os=mac ;;
+        Linux) os=linux ;;
+        Windows|MINGW*) os=windows ; basedir=$(pwd -W) ;;
+        *) echo "unknown runner_os: $runner_os" ; exit 7 ; ;;
+    esac
+    version='latest' # hi hello
+    sdk_dir=${VULKAN_SDK:-$basedir/VULKAN_SDK}
+    test -d $sdk_dir || mkdir -pv $sdk_dir
+    if [[ $version == 'latest' ]] ; then
+        url=https://vulkan.lunarg.com/sdk/latest/$os.txt
+        echo "note: resolving '$version' for '$os' via webservices lookup: $url" >&2
+        version=$(curl -sL $url)
+        test -n "$version" || { echo "could not resolve latest version" ; exit 9 ; }
+        echo "::notice title=Using Vulkan SDK $version::resolved via '$url'"
+    fi
+
+    export VULKAN_SDK="$sdk_dir"
+    export VULKAN_SDK_VERSION="$version"
+    export VULKAN_SDK_PLATFORM="$os"
+
+    echo "VULKAN_SDK=$sdk_dir" >> "$GITHUB_ENV"
+    echo "VULKAN_SDK_VERSION=$version" >> "$GITHUB_ENV"
+    echo "VULKAN_SDK_PLATFORM=$os" >> "$GITHUB_ENV"
+}

.github/workflows/ci-workflow.yml

@@ -35,13 +35,22 @@ jobs:
         with:
           repository: etternagame/CrashpadTools
           path: tools
+
+      - name: Install Vulkan SDK
+        shell: bash
+        run: |
+          . main/.ci/vulkan_setup_env.sh
+          preset_env
+          . main/.ci/vulkan_prebuilt_helpers.sh
+          download_vulkan_installer ${VULKAN_SDK_PLATFORM}
+          unpack_vulkan_installer ${VULKAN_SDK_PLATFORM}
 
       - name: Install apt packages
         run: sudo apt update && sudo apt install ${{ matrix.cfg.cpp-version }} nasm ninja-build libglew-dev libxrandr-dev libxtst-dev libpulse-dev libasound-dev libogg-dev libvorbis-dev xorg-dev libcurl4-openssl-dev
       - name: Install OpenSSL 3.5
         run: mkdir -p tmp/openssl && cd tmp/openssl && wget https://github.com/openssl/openssl/releases/download/openssl-3.5.1/openssl-3.5.1.tar.gz && tar -xf openssl-3.5.1.tar.gz && cd openssl-3.5.1 && ./Configure --prefix="${HOME}/toolchain" && make -j `nproc` && make test -j `nproc` && sudo make install
       - name: Generate CMake
-        run: mkdir main/build && cd main/build && cmake -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTS=FALSE -DBUILD_EXAMPLES=FALSE -DOPENSSL_ROOT_DIR=~/toolchain/ ..
+        run: mkdir main/build && cd main/build && cmake -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTS=FALSE -DBUILD_EXAMPLES=FALSE -DOPENSSL_ROOT_DIR=~/toolchain/ -DCMAKE_CXX_FLAGS="-D_DEBUG" ..
         env:
           CXX: ${{matrix.cfg.cpp-version}}
 
@@ -123,6 +132,15 @@ jobs:
           repository: etternagame/CrashpadTools
           path: tools
 
+      - name: Install Vulkan SDK
+        shell: bash
+        run: |
+          . main/.ci/vulkan_setup_env.sh
+          preset_env
+          . main/.ci/vulkan_prebuilt_helpers.sh
+          download_vulkan_installer ${VULKAN_SDK_PLATFORM}
+          unpack_vulkan_installer ${VULKAN_SDK_PLATFORM}
+
       - name: Install homebrew packages
         run: brew install cmake nasm ninja openssl
 
@@ -234,6 +252,15 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: '3.12'
+
+      - name: Install Vulkan SDK
+        shell: bash
+        run: |
+          . main/.ci/vulkan_setup_env.sh
+          preset_env
+          . main/.ci/vulkan_prebuilt_helpers.sh
+          download_vulkan_installer ${VULKAN_SDK_PLATFORM}
+          unpack_vulkan_installer ${VULKAN_SDK_PLATFORM}
 
       - name: Update CPack Environment
         if: ${{matrix.cfg.dist}}
@@ -325,6 +352,15 @@ jobs:
           repository: etternagame/CrashpadTools
           path: tools
 
+      - name: Install Vulkan SDK
+        shell: bash
+        run: |
+          . main/.ci/vulkan_setup_env.sh
+          preset_env
+          . main/.ci/vulkan_prebuilt_helpers.sh
+          download_vulkan_installer ${VULKAN_SDK_PLATFORM}
+          unpack_vulkan_installer ${VULKAN_SDK_PLATFORM}
+
       - name: Install homebrew packages
         run: brew install cmake nasm ninja openssl && brew tap etternagame/etterna && brew update && HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1
 
@@ -420,6 +456,15 @@ jobs:
           repository: nico-abram/dxsdk
           path: dxsdk
 
+      - name: Install Vulkan SDK
+        shell: bash
+        run: |
+          . main/.ci/vulkan_setup_env.sh
+          preset_env
+          . main/.ci/vulkan_prebuilt_helpers.sh
+          download_vulkan_installer ${VULKAN_SDK_PLATFORM}
+          unpack_vulkan_installer ${VULKAN_SDK_PLATFORM}
+
       - name: Update Environment Variables
         run: |
           echo "${{github.workspace}}/tools/win/" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append

CMakeLists.txt

@@ -15,7 +15,8 @@ set(CMAKE_POLICY_DEFAULT_CMP0077 NEW) # Tell CMake to use the new policy for CMP
 ## We statically link the CRT by default. If you would like to dynamically
 ## link the CRT, you can append "DLL" to the end of the variable below.
 ## More Info: https://cmake.org/cmake/help/latest/variable/CMAKE_MSVC_RUNTIME_LIBRARY.html
-set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+
+set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
 
 # PROJECT WIDE SETUP
 project(Etterna
@@ -42,6 +43,7 @@ add_executable(Etterna)
 
 # Project Compile Options
 set(WITH_CRASHPAD TRUE CACHE BOOL "Compile with Crash Handler (Requires depot_tools installed)")
+set(WITH_VULKAN TRUE CACHE BOOL "Compile Vulkan support (Requires Vulkan SDK to be installed and VULKAN_SDK environment variable to be set to SDK root dir)")
 
 ## Setting Target Properties
 ### Set a different name for each output binary depending on what build configuration is.
@@ -115,8 +117,19 @@ target_link_libraries(Etterna PRIVATE plog::plog)
 target_link_libraries(Etterna PRIVATE nowide::nowide)
 target_link_libraries(Etterna PRIVATE ghc_filesystem)
 
-if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "arm64")
-  target_link_libraries(Etterna PRIVATE sse2neon)
+if(WITH_VULKAN)
+    add_compile_definitions(Etterna PRIVATE WITH_VULKAN)
+    target_link_libraries(Etterna PRIVATE vk-bootstrap::vk-bootstrap)
+    target_link_libraries(Etterna PRIVATE VulkanMemoryAllocator)
+
+    find_package(Vulkan REQUIRED COMPONENTS shaderc_combined)
+    target_link_libraries(Etterna PRIVATE
+        Vulkan::Vulkan
+        Vulkan::shaderc_combined) 
+
+    if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "arm64")
+        target_link_libraries(Etterna PRIVATE sse2neon)
+    endif()
 endif()
 
 # If the user wants crashpad, and the target exists (in-case

Data/Shaders/Vulkan/fragment.glsl

@@ -0,0 +1,23 @@
+#version 460
+#extension GL_EXT_nonuniform_qualifier : enable
+#extension GL_EXT_samplerless_texture_functions : enable
+
+layout(set = 0, binding = 2) uniform texture2D textures[];
+layout(set = 0, binding = 3) uniform sampler samplers[];
+
+layout(location = 0) in vec4 vertexColor;
+layout(location = 1) flat in uint textureIndex;
+layout (location = 2) flat in uint samplerIndex;
+layout(location = 3) in vec2 vertexUV;
+
+layout(location = 0) out vec4 fragmentColor;
+
+void main() {
+    if(textureIndex == 0){
+        fragmentColor = vertexColor;
+        return;
+    }
+
+    vec4 textureColor = texture(sampler2D(textures[nonuniformEXT(textureIndex)], samplers[nonuniformEXT(samplerIndex)]), vertexUV);
+    fragmentColor = vertexColor * textureColor;
+}

Data/Shaders/Vulkan/vertex.glsl

@@ -0,0 +1,70 @@
+#version 460
+#extension GL_EXT_nonuniform_qualifier : enable
+
+struct Vertex {
+    float pos[3];
+    float normal[3];
+    uint color;
+    float uv[2];
+    uint MatrixIndex;
+	uint TextureIndex;
+	uint SamplerIndex;
+};
+
+layout(std430, set = 0, binding = 0) readonly buffer VertexBuffer {
+    Vertex vertices[];
+};
+
+struct MatrixState {
+    mat4 wvp;
+    mat4 texture;
+};
+
+layout(std430, set = 0, binding = 1) readonly buffer MatrixStateBuffer {
+    MatrixState matrices[];
+};
+
+layout(location = 0) out vec4 vertexColor;
+layout(location = 1) out uint textureIndex;
+layout(location = 2) out uint samplerIndex;
+layout(location = 3) out vec2 vertexUV;
+
+vec2 unpackVec2(float array[2]){
+    return vec2(array[0], array[1]);
+}
+
+vec3 unpackVec3(float array[3]){
+    return vec3(array[0], array[1], array[2]);
+}
+
+vec4 unpackColor(uint c)
+{
+    float b = float(c & 0xFFu);
+    float g = float((c >> 8) & 0xFFu);
+    float r = float((c >> 16) & 0xFFu);
+    float a = float((c >> 24) & 0xFFu);
+
+    return vec4(r, g, b, a) / 255.0;
+}
+
+void main() {
+    Vertex currentVertex = vertices[gl_VertexIndex];
+
+    vertexColor = unpackColor(currentVertex.color);
+
+    textureIndex = currentVertex.TextureIndex;
+    samplerIndex = currentVertex.SamplerIndex;
+
+    uint matrixIndex = currentVertex.MatrixIndex;
+    mat4 wvp = matrices[matrixIndex].wvp;
+    mat4 tex = matrices[matrixIndex].texture;
+
+    vec4 pos = wvp * vec4(unpackVec3(currentVertex.pos), 1.0);
+    pos.z = 0.0; // whart?
+
+    gl_Position = pos;
+
+    vertexUV = unpackVec2(currentVertex.uv);
+    vertexUV.x += tex[3][0];
+    vertexUV.y += tex[3][1];
+}

Docs/Building.md

@@ -52,6 +52,8 @@ cmake -DOPENSSL_ROOT_DIR="/usr/local/opt/openssl" -G "Xcode" ..  # macOS
   - macOS: `brew install openssl`
   - Windows: A CMake compatible version of OpenSSL is available at [Shining Light Productions](https://slproweb.com/products/Win32OpenSSL.html) website. You will need the 32bit and 64bit installers if you plan on building both versions. It's recommended to uninstall old versions to make sure CMake can find the correct latest version. Direct links: [32bit](https://slproweb.com/download/Win32OpenSSL-1_1_1t.exe), [64bit](https://slproweb.com/download/Win64OpenSSL-1_1_1t.exe). If these links are dead, look for the OpenSSL v1.1.1 install links (EXE or MSI) on the Shining Light Productions site. Typically we use the full versions rather than the Light versions.
 - [depot_tools](https://dev.chromium.org/developers/how-tos/install-depot-tools) - Installation is platform specific. To skip installing this, follow the relevant instructions in [CLI Project Generation](CLI-Project-Generation).
+- [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) - note that you might need to set the `VULKAN_SDK` environment variable
+to the SDK's root directory [for CMake to find](https://cmake.org/cmake/help/latest/module/FindVulkan.html#hints).
 
 ### Linux Dependencies