Switch shader toolchain from GLSL to Slang

Author: semihguresci

.github/workflows/ci.yml

@@ -12,7 +12,13 @@ jobs:
       - name: Install deps
         run: |
           sudo apt-get update
-          sudo apt-get install -y cmake g++ libvulkan-dev clang-format
+          sudo apt-get install -y cmake g++ libvulkan-dev clang-format curl ca-certificates
+      - name: Install slangc
+        run: |
+          SLANG_VERSION=2024.17.2
+          curl -fsSL -o slang.tar.gz https://github.com/shader-slang/slang/releases/download/v${SLANG_VERSION}/slang-${SLANG_VERSION}-linux-x86_64.tar.gz
+          tar -xzf slang.tar.gz
+          sudo install -m 0755 slang-${SLANG_VERSION}/bin/slangc /usr/local/bin/slangc
       - name: Build
         run: |
           cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

CMakeLists.txt

@@ -6,7 +6,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
 find_package(Vulkan REQUIRED)
-find_program(GLSLANG_VALIDATOR glslangValidator REQUIRED)
+find_program(SLANGC slangc REQUIRED)
 
 set(SHADER_DIR ${CMAKE_CURRENT_SOURCE_DIR}/shaders)
 set(SPIRV_DIR ${CMAKE_CURRENT_BINARY_DIR}/shaders)
@@ -19,14 +19,14 @@ set(SHADER_OUTPUTS
 
 add_custom_command(
   OUTPUT ${SPIRV_DIR}/triangle.vert.spv
-  COMMAND ${GLSLANG_VALIDATOR} -V ${SHADER_DIR}/triangle.vert -o ${SPIRV_DIR}/triangle.vert.spv
-  DEPENDS ${SHADER_DIR}/triangle.vert
+  COMMAND ${SLANGC} -target spirv -profile glsl_460 -entry main -stage vertex ${SHADER_DIR}/triangle.vert.slang -o ${SPIRV_DIR}/triangle.vert.spv
+  DEPENDS ${SHADER_DIR}/triangle.vert.slang
 )
 
 add_custom_command(
   OUTPUT ${SPIRV_DIR}/triangle.frag.spv
-  COMMAND ${GLSLANG_VALIDATOR} -V ${SHADER_DIR}/triangle.frag -o ${SPIRV_DIR}/triangle.frag.spv
-  DEPENDS ${SHADER_DIR}/triangle.frag
+  COMMAND ${SLANGC} -target spirv -profile glsl_460 -entry main -stage fragment ${SHADER_DIR}/triangle.frag.slang -o ${SPIRV_DIR}/triangle.frag.spv
+  DEPENDS ${SHADER_DIR}/triangle.frag.slang
 )
 
 add_custom_target(vk-bench-shaders DEPENDS ${SHADER_OUTPUTS})

Dockerfile

@@ -5,17 +5,26 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     cmake \
     pkg-config \
     vulkan-tools \
-    glslang-tools \
+    curl \
+    ca-certificates \
     && rm -rf /var/lib/apt/lists/*
 
+ARG SLANG_VERSION=2024.17.2
+RUN curl -fsSL -o /tmp/slang.tar.gz https://github.com/shader-slang/slang/releases/download/v${SLANG_VERSION}/slang-${SLANG_VERSION}-linux-x86_64.tar.gz \
+    && tar -xzf /tmp/slang.tar.gz -C /tmp \
+    && install -m 0755 /tmp/slang-${SLANG_VERSION}/bin/slangc /usr/local/bin/slangc \
+    && rm -rf /tmp/slang.tar.gz /tmp/slang-${SLANG_VERSION}
+
 WORKDIR /workspace
 COPY CMakeLists.txt /workspace/CMakeLists.txt
 COPY src /workspace/src
 COPY include /workspace/include
 COPY shaders /workspace/shaders
 RUN cmake -S /workspace -B /workspace/build -DCMAKE_BUILD_TYPE=Release \
     && cmake --build /workspace/build --config Release -j"$(nproc)" \
-    && install -m 0755 /workspace/build/vk-bench /usr/local/bin/vk-bench
+    && install -m 0755 /workspace/build/vk-bench /usr/local/bin/vk-bench \
+    && install -d /usr/local/share/vk-bench/shaders \
+    && cp /workspace/build/shaders/*.spv /usr/local/share/vk-bench/shaders/
 
 COPY docker/entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -14,6 +14,8 @@ This Level 0 repo intentionally scopes to **one executable** (`vk-bench`) and **
 
 No assets, textures, or engine features are included.
 
+Shaders are authored in **Slang** and compiled to SPIR-V during build.
+
 ## How to run
 
 ```bash

docker/Dockerfile

@@ -5,17 +5,26 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     cmake \
     pkg-config \
     vulkan-tools \
-    glslang-tools \
+    curl \
+    ca-certificates \
     && rm -rf /var/lib/apt/lists/*
 
+ARG SLANG_VERSION=2024.17.2
+RUN curl -fsSL -o /tmp/slang.tar.gz https://github.com/shader-slang/slang/releases/download/v${SLANG_VERSION}/slang-${SLANG_VERSION}-linux-x86_64.tar.gz \
+    && tar -xzf /tmp/slang.tar.gz -C /tmp \
+    && install -m 0755 /tmp/slang-${SLANG_VERSION}/bin/slangc /usr/local/bin/slangc \
+    && rm -rf /tmp/slang.tar.gz /tmp/slang-${SLANG_VERSION}
+
 WORKDIR /workspace
 COPY CMakeLists.txt /workspace/CMakeLists.txt
 COPY src /workspace/src
 COPY include /workspace/include
 COPY shaders /workspace/shaders
 RUN cmake -S /workspace -B /workspace/build -DCMAKE_BUILD_TYPE=Release \
     && cmake --build /workspace/build --config Release -j"$(nproc)" \
-    && install -m 0755 /workspace/build/vk-bench /usr/local/bin/vk-bench
+    && install -m 0755 /workspace/build/vk-bench /usr/local/bin/vk-bench \
+    && install -d /usr/local/share/vk-bench/shaders \
+    && cp /workspace/build/shaders/*.spv /usr/local/share/vk-bench/shaders/
 
 COPY docker/entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

shaders/triangle.frag

@@ -0,0 +1,10 @@
+struct PSInput {
+    float4 position : SV_Position;
+    float3 color : COLOR0;
+};
+
+[shader("fragment")]
+float4 main(PSInput input) : SV_Target0
+{
+    return float4(input.color, 1.0);
+}

shaders/triangle.frag.slang

@@ -0,0 +1,25 @@
+struct VSOutput {
+    float4 position : SV_Position;
+    float3 color : COLOR0;
+};
+
+[shader("vertex")]
+VSOutput main(uint vertexID : SV_VertexID)
+{
+    float2 positions[3] = {
+        float2(0.0, -0.5),
+        float2(0.5, 0.5),
+        float2(-0.5, 0.5)
+    };
+
+    float3 colors[3] = {
+        float3(1.0, 0.1, 0.1),
+        float3(0.1, 1.0, 0.1),
+        float3(0.1, 0.2, 1.0)
+    };
+
+    VSOutput o;
+    o.position = float4(positions[vertexID], 0.0, 1.0);
+    o.color = colors[vertexID];
+    return o;
+}