testing shadercross and workflows (closes #28)

Author: jsoulier

.github/workflows/build.yml

@@ -0,0 +1,64 @@
+name: Build
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-2025
+          - macos-latest
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Dependencies
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            build-essential \
+            git \
+            make \
+            pkg-config \
+            cmake \
+            ninja-build \
+            gnome-desktop-testing \
+            libasound2-dev \
+            libpulse-dev \
+            libaudio-dev \
+            libfribidi-dev \
+            libjack-dev \
+            libsndio-dev \
+            libx11-dev \
+            libxext-dev \
+            libxrandr-dev \
+            libxcursor-dev \
+            libxfixes-dev \
+            libxi-dev \
+            libxss-dev \
+            libxtst-dev \
+            libxkbcommon-dev \
+            libdrm-dev \
+            libgbm-dev \
+            libgl1-mesa-dev \
+            libgles2-mesa-dev \
+            libegl1-mesa-dev \
+            libdbus-1-dev \
+            libibus-1.0-dev \
+            libudev-dev \
+            libthai-dev
+
+      - name: Configure
+        run: cmake -S . -B build
+
+      - name: Build
+        run: cmake --build build

.gitignore

@@ -1 +1,2 @@
+*.sqlite3
 build

.vscode/launch.json

@@ -6,15 +6,15 @@
             "type": "cppvsdbg",
             "request": "launch",
             "program": "${workspaceFolder}/build/bin/blocks.exe",
-            "cwd": "${workspaceFolder}/build/bin",
+            "cwd": "${workspaceFolder}",
             "preLaunchTask": "CMake: build",
         },
         {
             "name": "linux",
             "type": "cppdbg",
             "request": "launch",
             "program": "${workspaceFolder}/build/bin/blocks",
-            "cwd": "${workspaceFolder}/build/bin",
+            "cwd": "${workspaceFolder}",
             "preLaunchTask": "CMake: build",
         },
     ]

CMakeLists.txt

@@ -27,26 +27,59 @@ add_executable(blocks WIN32
     src/world.c
 )
 target_link_libraries(blocks PUBLIC SDL3::SDL3)
-if(UNIX)
-    target_link_libraries(blocks PUBLIC m)
-endif()
 target_include_directories(blocks PUBLIC lib/sqlite3)
 target_include_directories(blocks PUBLIC lib/stb)
 set_target_properties(blocks PROPERTIES C_STANDARD 11)
 
+find_program(GLSLC glslc)
+find_program(SHADERCROSS shadercross)
 function(shader FILE)
-    set(SOURCE shaders/${FILE})
-    set(OUTPUT ${BINARY_DIR}/${FILE})
-    add_custom_command(
-        OUTPUT ${OUTPUT}
-        COMMAND glslc ${SOURCE} -o ${OUTPUT} -I src
-        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-        DEPENDS ${SOURCE} shaders/helpers.glsl src/config.h
-        COMMENT ${SOURCE}
-    )
-    string(REPLACE . _ NAME ${FILE})
-    add_custom_target(${NAME} DEPENDS ${OUTPUT})
-    add_dependencies(blocks ${NAME})
+    set(GLSL ${CMAKE_SOURCE_DIR}/shaders/${FILE})
+    set(SPV ${CMAKE_SOURCE_DIR}/shaders/bin/${FILE}.spv)
+    set(DXIL ${CMAKE_SOURCE_DIR}/shaders/bin/${FILE}.dxil)
+    set(MSL ${CMAKE_SOURCE_DIR}/shaders/bin/${FILE}.msl)
+    set(JSON ${CMAKE_SOURCE_DIR}/shaders/bin/${FILE}.json)
+    function(compile PROGRAM SOURCE OUTPUT)
+        add_custom_command(
+            OUTPUT ${OUTPUT}
+            COMMAND ${PROGRAM} ${SOURCE} -o ${OUTPUT} -I src
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+            DEPENDS ${SOURCE} shaders/helpers.glsl src/config.h
+            COMMENT "${SOURCE} -> ${OUTPUT}"
+        )
+        get_filename_component(NAME ${OUTPUT} NAME)
+        string(REPLACE . _ NAME ${NAME})
+        set(NAME compile_${NAME})
+        add_custom_target(${NAME} DEPENDS ${OUTPUT})
+        add_dependencies(blocks ${NAME})
+    endfunction()
+    if(EXISTS ${GLSLC} AND EXISTS ${SHADERCROSS})
+        compile(${GLSLC} ${GLSL} ${SPV})
+        compile(${SHADERCROSS} ${SPV} ${MSL})
+        compile(${SHADERCROSS} ${SPV} ${JSON})
+    else()
+        message("Skipping build since dependencies are missing")
+    endif()
+    function(package OUTPUT)
+        get_filename_component(NAME ${OUTPUT} NAME)
+        set(BINARY ${BINARY_DIR}/${NAME})
+        add_custom_command(
+            OUTPUT ${BINARY}
+            COMMAND ${CMAKE_COMMAND} -E copy ${OUTPUT} ${BINARY}
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+            DEPENDS ${OUTPUT}
+            COMMENT "${OUTPUT} -> ${BINARY}"
+        )
+        string(REPLACE . _ NAME ${NAME})
+        set(NAME package_${NAME})
+        add_custom_target(${NAME} DEPENDS ${BINARY})
+        add_dependencies(blocks ${NAME})
+    endfunction()
+    if(NOT APPLE)
+        package(${SPV})
+    else()
+        package(${MSL})
+    endif()
 endfunction()
 shader(composite.frag)
 shader(fullscreen.vert)

README.md

@@ -12,16 +12,14 @@ Tiny Minecraft clone in C and GLSL using the new SDL3 GPU API
 - Transparency (limited)
 - Deferred rendering
 - Directional shadows
-- SSAO (ish)
+- SSAO
 - Water depth shading
 - Persistent worlds
 
 ### Building
 
 #### Windows
 
-Install the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) for glslc
-
 ```bash
 git clone https://github.com/jsoulier/blocks --recurse-submodules
 cd blocks
@@ -35,10 +33,6 @@ cd bin
 
 #### Linux
 
-```bash
-sudo apt install glslc
-```
-
 ```bash
 git clone https://github.com/jsoulier/blocks --recurse-submodules
 cd blocks
@@ -50,6 +44,14 @@ cd bin
 ./blocks
 ```
 
+#### Shaders
+
+Shaders have a few dependencies and are prebuilt for your convenience.
+To build locally, install [glslc](https://github.com/google/shaderc) and
+[SDL_shadercross](https://github.com/libsdl-org/SDL_shadercross) to your path
+environment variable. The CMake build process should automatically use them
+if they're available
+
 ### Controls
 
 - `WASDEQ` to move

lib/stb/stb_perlin.h

@@ -89,7 +89,10 @@ extern float stb_perlin_noise3_wrap_nonpow2(float x, float y, float z, int x_wra
 
 #ifdef STB_PERLIN_IMPLEMENTATION
 
-#include <math.h> // fabs()
+// Modified by jsoulier:
+// #include <math.h> // fabs()
+#include <SDL3/SDL.h>
+#define fabs(x) SDL_fabs(x)
 
 // not same permutation table as Perlin's reference to avoid copyright issues;
 // Perlin's table can be found at http://mrl.nyu.edu/~perlin/noise/

shaders/bin/composite.frag.json

@@ -0,0 +1 @@
+{ "samplers": 6, "storage_textures": 0, "storage_buffers": 0, "uniform_buffers": 3 }