Merge pull request #102 from SentyTek/dev

Add unit tests, improve render perf, many fixes.

Author: SentyFunBall

.github/workflows/tests.yml

@@ -0,0 +1,69 @@
+name: Syngine Tests
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["main", "dev"]
+
+jobs:
+  build-and-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        build_type: [Debug]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: false
+
+      - name: Init required submodules
+        run: >
+          git submodule update --init --recursive
+
+      - name: Install Ninja
+        uses: seanmiddleditch/gha-setup-ninja@v3
+
+      - name: Setup MSVC Developer Command Prompt
+        if: runner.os == 'Windows'
+        uses: ilammy/msvc-dev-cmd@v1
+
+      - name: Install Linux graphics deps
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang libx11-dev libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev
+
+      - name: Configure (Windows/MSVC)
+        if: runner.os == 'Windows'
+        run: >
+          cmake -B build -S .
+          -G Ninja
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+          -DCMAKE_C_COMPILER=cl
+          -DCMAKE_CXX_COMPILER=cl
+          -DSYNGINE_BUILD_TOOLS=OFF
+          -DSYN_ENABLE_TEST_MODE=ON
+
+      - name: Configure (Linux/macOS)
+        if: runner.os != 'Windows'
+        run: >
+          cmake -B build -S .
+          -G Ninja
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+          -DCMAKE_C_COMPILER=clang
+          -DCMAKE_CXX_COMPILER=clang++
+          -DSYNGINE_BUILD_TOOLS=OFF
+          -DSYN_ENABLE_TEST_MODE=ON
+          ${{ matrix.os != 'windows-latest' && '-DSDL_UNIX_CONSOLE_BUILD=ON' || '' }}
+
+      - name: Build
+        run: cmake --build build --target engine_tests
+
+      - name: Run Tests
+        run: ctest --test-dir build --output-on-failure

CMakeLists.txt

@@ -7,12 +7,14 @@
 # ╰──────────────────────────────────────╯
 # Engine main CMakeLists (root/engine/CMakeLists.txt)
 
-
 cmake_minimum_required(VERSION 3.16)
 project(Syngine)
 set(CMAKE_CXX_STANDARD 20)
 set(SYNGINE_SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR} CACHE STRING "Syngine source dir" FORCE)
 
+# Enable CTest in the engine project so standalone engine CI can discover tests.
+include(CTest)
+
 # Generate Version.h for all engine builds (including engine-only CI).
 include(${CMAKE_CURRENT_LIST_DIR}/cmake/versioning.cmake)
 define_version()
@@ -98,10 +100,18 @@ add_library(Syngine STATIC
     src/Syngine/ECS/ComponentRegistry.cpp
 )
 
+set_target_properties(Syngine PROPERTIES FOLDER "Engine")
+
+# Call the testing cmake
+option(SYN_ENABLE_TEST_MODE "Enable test mode" OFF)
+if(SYN_ENABLE_TEST_MODE)
+    add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/tests ${CMAKE_BINARY_DIR}/engine_tests EXCLUDE_FROM_ALL)
+endif()
+
 # Uncomment to enable graphics debugging.
 # This is done because programs like RenderDoc do not work if window's `dbghelp.dll` is loaded, which we use for crash handling/logging.
 # And so this macro prevents those features from being compiled in. This also disables the Syngine Profiler, which may cause compile-time errors. Use at your own risk.
-# target_compile_definitions(Syngine PUBLIC SYN_DEBUG_GRAPHICS)
+target_compile_definitions(Syngine PUBLIC SYN_DEBUG_GRAPHICS)
 
 # Apple needs OBJC++ files for Metal support
 if(APPLE)
@@ -197,6 +207,27 @@ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/third_party/JoltPhysics/Build ${CMAKE
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/lib)
 add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/third_party/sol2 ${CMAKE_BINARY_DIR}/third_party/sol2 EXCLUDE_FROM_ALL)
 
+if (MSVC AND TARGET Jolt)
+    target_compile_options(Jolt PRIVATE /wd4865 /WX-) # Disable "the underlying type of ... will change when '/Zc:enumTypes' is specified on the command line" warning and don't treat as error
+endif()
+
+# Add the third party things to respective folders
+set_target_properties(SDL_uclibc PROPERTIES FOLDER "ThirdParty/SDL")
+set_target_properties(SDL3_test PROPERTIES FOLDER "ThirdParty/SDL")
+set_target_properties(SDL3-static PROPERTIES FOLDER "ThirdParty/SDL")
+set_target_properties(bgfx PROPERTIES FOLDER "ThirdParty/bgfx")
+set_target_properties(bx PROPERTIES FOLDER "ThirdParty/bgfx")
+set_target_properties(bimg PROPERTIES FOLDER "ThirdParty/bgfx")
+set_target_properties(assimp PROPERTIES FOLDER "ThirdParty/assimp")
+set_target_properties(Jolt PROPERTIES FOLDER "ThirdParty/JoltPhysics")
+set_target_properties(lua PROPERTIES FOLDER "ThirdParty/sol2")
+if(MSVC) # these are windows only targets (i dont know man)
+    set_target_properties(zlibstatic PROPERTIES FOLDER "ThirdParty/assimp")
+    set_target_properties(UpdateAssimpLibsDebugSymbolsAndDLLs PROPERTIES FOLDER "Engine") # this sucks
+endif()
+
+set_target_properties(shaderc PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIGURATION>/tools") # shaderc is a tool, so put it in the tools folder
+
 # Allow not building SynTools if not needed
 option(SYNGINE_BUILD_TOOLS "Build Syngine Tools (Shader Compiler, Asset Packager)" ON)
 if(SYNGINE_BUILD_TOOLS)

README.md

@@ -34,7 +34,9 @@ docs/           -> Documentation on the engine
 include/        -> User-facing header files
 src/            -> Engine source files
 lib/            -> Other library files not in third_party and custom libraries
+tests/          -> Tests
 third_party/    -> Third party components like SDL and Jolt
+tools/          -> Official tools used to make Syngine Games (asset packaging mainly)
 ```
 
 ## Technologies used

cmake/GameConfig.cmake

@@ -11,10 +11,13 @@ include(${SYNGINE_SOURCE_DIR}/cmake/CompileShaders.cmake)
 include(${SYNGINE_SOURCE_DIR}/cmake/CompileMeshes.cmake)
 include(${SYNGINE_SOURCE_DIR}/cmake/FileBundle.cmake)
 
+# Keep all staged runtime assets under the executable output tree.
+set(SYNGINE_STAGED_ROM_DIR "${CMAKE_BINARY_DIR}/$<CONFIG>/bin/rom")
+
 # Function to compile all shaders in a directory
 function(compile_collect_shaders SHADER_SRC_DIR ALL_SHADERS_LIST)
     set(LOCAL_SHADER_OUTPUT_DIR "${CMAKE_BINARY_DIR}/shaders")
-    set(LOCAL_SHADER_BUNDLE_DIR "${CMAKE_BINARY_DIR}/$<CONFIG>/rom/shaders")
+    set(LOCAL_SHADER_BUNDLE_DIR "${SYNGINE_STAGED_ROM_DIR}/shaders")
     file(MAKE_DIRECTORY ${LOCAL_SHADER_OUTPUT_DIR}) # Ensure output directory exists
     set(LOCAL_BGFX_CORE_INCLUDE_DIR "${SYNGINE_SOURCE_DIR}/third_party/bgfx.cmake/bgfx/src")
 
@@ -67,7 +70,7 @@ function(compile_collect_default_gizmos GIZMO_BUNDLE_OUTPUT_VAR)
 
     create_file_bundle(
         BUNDLE_NAME "default_gizmos"
-        OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>/rom/gizmos"
+        OUTPUT_DIRECTORY "${SYNGINE_STAGED_ROM_DIR}/gizmos"
         SOURCE_DIRECTORY "${DEFAULT_GIZMO_SOURCE_DIR}"
         INPUT_FILES ${DEFAULT_GIZMO_ENTRIES}
         BUNDLE_FILE_OUTPUT_VAR GENERATED_GIZMO_BUNDLE
@@ -90,7 +93,7 @@ function(compile_collect_asset_bundle ASSET_SRC_DIR BUNDLE_NAME ASSET_BUNDLE_OUT
 
     create_file_bundle(
         BUNDLE_NAME "${BUNDLE_NAME}"
-        OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>/rom/${BUNDLE_NAME}"
+        OUTPUT_DIRECTORY "${SYNGINE_STAGED_ROM_DIR}/${BUNDLE_NAME}"
         SOURCE_DIRECTORY "${ASSET_SRC_DIR}"
         INPUT_FILES ${ASSET_ENTRIES}
         BUNDLE_FILE_OUTPUT_VAR GENERATED_ASSET_BUNDLE
@@ -101,16 +104,11 @@ endfunction()
 
 # Asset handling helpers
 function(_add_assets_win_linux target)
-    set(ROM_DIR "$<TARGET_FILE_DIR:${target}>/rom")
-
     get_target_property(COPY_ROM ${target} SYNGINE_COPY_ROM)
     if(COPY_ROM)
         add_custom_command(TARGET ${target} POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E make_directory "${ROM_DIR}"
-            COMMAND ${CMAKE_COMMAND} -E copy_directory
-                "${CMAKE_BINARY_DIR}/$<CONFIG>/rom"
-                "${ROM_DIR}"
-            COMMENT "Copying staged rom assets to executable directory"
+            COMMAND ${CMAKE_COMMAND} -E make_directory "$<TARGET_FILE_DIR:${target}>/rom"
+            COMMENT "ROM assets are staged directly into executable directory"
         )
     endif()
 endfunction()
@@ -123,7 +121,7 @@ function(_add_assets_mac target)
         add_custom_command(TARGET ${target} POST_BUILD
             COMMAND ${CMAKE_COMMAND} -E make_directory "${ROM_DIR}"
             COMMAND ${CMAKE_COMMAND} -E copy_directory
-                "${CMAKE_BINARY_DIR}/$<CONFIG>/rom"
+                "${SYNGINE_STAGED_ROM_DIR}"
                 "${ROM_DIR}"
             COMMENT "Copying staged rom assets into app Resources"
         )
@@ -197,6 +195,7 @@ function(add_assets target)
             DEPENDS "${ICON_BUNDLE_PATH}"
         )
         add_dependencies(${target} CompileMacAssets)
+        set_target_properties(CompileMacAssets PROPERTIES FOLDER "Game")
 
         # set the compiled asset bundle as a target for the app and copy it into Resources
         target_sources(${target} PRIVATE "${ASSET_PACKAGE}")
@@ -219,6 +218,7 @@ function(add_assets target)
             DEPENDS "${FINAL_PLIST_PATH}"
         )
         add_dependencies(${target} InfoPlistMerge)
+        set_target_properties(InfoPlistMerge PROPERTIES FOLDER "Game")
 
         # add the Info.plist to the target and have it depend on the icon
         set_property(
@@ -316,7 +316,7 @@ if(EXISTS "${GAME_ASSET_DIR}")
         elseif(ASSET_SUBDIR STREQUAL "meshes")
             compile_all_meshes(
                 SOURCE_DIRECTORY "${GAME_ASSET_DIR}/${ASSET_SUBDIR}"
-                OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIG>/rom/meshes"
+                OUTPUT_DIRECTORY "${SYNGINE_STAGED_ROM_DIR}/meshes"
                 BUNDLE_FILES_OUTPUT_VAR ALL_BUNDLED_MESH_FILES
             )
         else()
@@ -343,27 +343,31 @@ message(STATUS "SyngineGame: Compiled default gizmo bundles for ${name}: ${ALL_B
 if(ALL_COMPILED_SHADER_BINARIES)
     add_custom_target(GameShaders ALL DEPENDS ${ALL_COMPILED_SHADER_BINARIES})
     add_dependencies(${name} GameShaders)
+    set_target_properties(GameShaders PROPERTIES FOLDER "Game")
     message(STATUS "SyngineGame: Added GameShaders target for ${name}.")
 endif()
 
 # Add dependency on the compiled mesh bundles
 if(ALL_BUNDLED_MESH_FILES)
     add_custom_target(GameMeshes ALL DEPENDS ${ALL_BUNDLED_MESH_FILES})
     add_dependencies(${name} GameMeshes)
+    set_target_properties(GameMeshes PROPERTIES FOLDER "Game")
     message(STATUS "SyngineGame: Added GameMeshes target for ${name}.")
 endif()
 
 # Add dependency on the compiled generic asset bundles
 if(ALL_BUNDLED_OTHER_ASSET_FILES)
     add_custom_target(GameAssets ALL DEPENDS ${ALL_BUNDLED_OTHER_ASSET_FILES})
     add_dependencies(${name} GameAssets)
+    set_target_properties(GameAssets PROPERTIES FOLDER "Game")
     message(STATUS "SyngineGame: Added GameAssets target for ${name}.")
 endif()
 
 # Add dependency on the compiled gizmo bundles
 if(ALL_BUNDLED_GIZMO_FILES)
     add_custom_target(GameGizmos ALL DEPENDS ${ALL_BUNDLED_GIZMO_FILES})
     add_dependencies(${name} GameGizmos)
+    set_target_properties(GameGizmos PROPERTIES FOLDER "Game")
     message(STATUS "SyngineGame: Added GameGizmos target for ${name}.")
 endif()
 

default/shaders/default.frag.bgsl

@@ -37,7 +37,7 @@ void main() {
     float nightFactor = clamp(smoothstep(-0.05, 0.05, sunElevation), 0.2, 1.0);
     vec3 ambient = mix(col.rgb, skyColor, hemiMix) * u_materialParams1.y;
 
-    float shadowFactor = getShadowFactor(v_worldPos, vec3(0.0, 1.0, 0.0), N, u_lightDir, v_viewDepth);
+    float shadowFactor = getShadowFactor(v_worldPos, vec3(0.0, 1.0, 0.0), u_lightDir, v_viewDepth);
 
     float sunIntensity = smoothstep(-0.1, 0.1, sunElevation);
     vec3 directLight = u_sunColor.xyz * sunIntensity * NdotL * shadowFactor;

default/shaders/default_billboard.frag.bgsl

@@ -35,7 +35,7 @@ void main() {
             // Calculate view depth (distance from camera)
             float viewDepth = length(v_worldPos - u_viewPos.xyz);
             vec3 fakeNormal = vec3(0.0, 1.0, 0.0); // Assume upward facing normal
-            float shadowFactor = getShadowFactor(v_worldPos, vec3(0.0, 1.0, 0.0), fakeNormal, u_lightDir, viewDepth);
+            float shadowFactor = getShadowFactor(v_worldPos, fakeNormal, u_lightDir, viewDepth);
             lightFactor *= shadowFactor;
         }
 

default/shaders/default_texture.frag.bgsl

@@ -47,7 +47,7 @@ void main() {
     // Micro shadowing from normal map
     // Softer attenuation for grazing angles
     float microShadow = clamp(dot(Nmicro, lightDirToSun) * 2.0 + 0.3, 0.0, 1.0);
-    float shadow = getShadowFactor(v_worldPos, vN, N, u_lightDir, v_viewDepth);
+    float shadow = getShadowFactor(v_worldPos, vN, u_lightDir, v_viewDepth);
     shadow = mix(1.0, shadow, smoothstep(0.1, 0.3, sunElevation)); // Fade shadows to full light (1.0) at low sun angles
 
     float sunIntensity = smoothstep(-0.1, 0.1, sunElevation);