Ship shaders with binaries

Author: Atraxus

CHANGELOG.md

@@ -1,26 +1,3 @@
 # Changes
 
-- rayx-core:
-  - Added optical elements
-    - Paraboloid 
-  - Added light sources
-    - Simple Undulator
-    - Pixel Source
-    - Dipole Source
-  - Improved code consistency for optical elements and light sources
-  - Improved test suite
-  - Fixes for RZP tracing
-- rayx:
-  - Added more options to customize the export of rays and speed up the tracing
-  - Added option to choose GPU
-  - Improved runtime by optimizing data handling
-- rayx-ui:
-  - Added orthographic camera
-  - Added footprints/heatmaps/histograms for simple optical elements
-  - Changed default camera position and orientation
-  - Jump to light source is possible now
-  - Correctly render slits
-  - Fixed positioning of light sources
-  - Fixed triangulation bugs
-  - Fixed general rendering bugs
-- General bugfixes and documentation updates
+- Fixing shader distribution with binaries

Intern/rayx-core/CMakeLists.txt

@@ -123,7 +123,7 @@ if(Vulkan_FOUND)
     # This is most likely not an optimal solution, but it will work
     # until we find a better one.
     add_dependencies(${PROJECT_NAME} RAYX_CORE_COMPILE_SHADER)
-    set(RAYX_CORE_SHADER ${CMAKE_BINARY_DIR}/bin/comp.spv)
+    set(RAYX_CORE_SHADER ${CMAKE_BINARY_DIR}/bin/shaders/comp.spv)
     set(RAYX_CORE_SHADER_FAKE ${CMAKE_BINARY_DIR}/bin/___comp.spv) # this exists so file cannot be found -> always execute command
 
     add_custom_command(

Intern/rayx-core/src/Tracer/VulkanTracer.cpp

@@ -100,7 +100,7 @@ void VulkanTracer::initEngine() {
 #ifdef RAYX_DEBUG_MODE
     m_engine.declareBuffer("debug-buffer", {.binding = 6, .isInput = false, .isOutput = true});
 #endif
-    m_engine.init({.shaderFileName = "build/bin/comp.spv", .deviceID = m_deviceID});
+    m_engine.init({.shaderFileName = "build/bin/shaders/comp.spv", .deviceID = m_deviceID});
 }
 }  // namespace RAYX
 

Intern/rayx-ui/CMakeLists.txt

@@ -32,21 +32,19 @@ if(Vulkan_FOUND)
     target_compile_definitions(${PROJECT_NAME} PRIVATE
         GLM_FORCE_RADIANS
         GLM_FORCE_DEPTH_ZERO_TO_ONE)
+    # -----------------
 
-            # ---- Install ----
-
-    install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin)
 
     # ---- CPack ----
-
+    install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin)
+    install(DIRECTORY ${CMAKE_BINARY_DIR}/bin/shaders
+            DESTINATION ./
+            FILES_MATCHING PATTERN "*_*.spv")
     include(InstallRequiredSystemLibraries)
-
     set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/../../LICENSE")
     set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
     set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "rayx-ui - RAYX GUI Application")
-
     include(CPack)
-
     # -----------------
 
     # ---- GLFW Options ----
@@ -55,7 +53,6 @@ if(Vulkan_FOUND)
     option(GLFW_BUILD_DOCS "Build the GLFW documentation" OFF)
     option(GLFW_INSTALL "Generate installation target" OFF)
     option(GLFW_DOCUMENT_INTERNALS "Include internals in documentation" OFF)
-
     # ----------------------
 
     # ---- Dependencies ----
@@ -69,7 +66,6 @@ if(Vulkan_FOUND)
         ${STB_DIR}
         ..
     )
-
     # ----------------------
 
     # ---- Compile Shaders ----
@@ -87,7 +83,7 @@ if(Vulkan_FOUND)
             string(SUBSTRING ${SHADER_EXT} 1 -1 SHADER_STAGE) # Remove the leading '.' from the extension
 
             # Set output file name
-            set(OUTPUT_FILE "${CMAKE_BINARY_DIR}/bin/${SHADER_NAME}_${SHADER_STAGE}.spv")
+            set(OUTPUT_FILE "${CMAKE_BINARY_DIR}/bin/shaders/${SHADER_NAME}_${SHADER_STAGE}.spv")
 
             # Create a custom command for each shader file
             add_custom_command(
@@ -108,6 +104,5 @@ if(Vulkan_FOUND)
 
     # Call the function to compile all shaders in the specified directory
     compile_shaders(RAYX_UI_COMPILE_SHADER "${PROJECT_SOURCE_DIR}/src/Shaders")
-
     # ------------------------
 endif() # Vulkan_FOUND

Intern/rayx-ui/src/RenderSystem/GridRenderSystem.cpp

@@ -49,7 +49,7 @@ void GridRenderSystem::createPipeline(VkRenderPass renderPass) {
     pipelineConfig.depthStencilInfo.depthCompareOp = VK_COMPARE_OP_LESS_OR_EQUAL;
 
     // Use the grid-specific shaders
-    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/grid_shader_vert.spv").string();
-    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/grid_shader_frag.spv").string();
+    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/grid_shader_vert.spv").string();
+    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/grid_shader_frag.spv").string();
     m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, vertexShader, fragmentShader, pipelineConfig);
 }

Intern/rayx-ui/src/RenderSystem/ObjectRenderSystem.cpp

@@ -47,8 +47,8 @@ void ObjectRenderSystem::createPipeline(VkRenderPass renderPass) {
     GraphicsPipeline::defaultPipelineConfigInfo(pipelineConfig, GraphicsPipeline::VertexMode::TEXTURED);
     pipelineConfig.renderPass = renderPass;
     pipelineConfig.pipelineLayout = m_PipelineLayout;
-    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/shader_vert.spv").string();
-    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/shader_frag.spv").string();
+    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/shader_vert.spv").string();
+    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/shader_frag.spv").string();
     m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, vertexShader, fragmentShader, pipelineConfig);
 }
 

Intern/rayx-ui/src/RenderSystem/RayRenderSystem.cpp

@@ -46,7 +46,7 @@ void RayRenderSystem::createPipeline(VkRenderPass renderPass) {
     pipelineConfig.renderPass = renderPass;
     pipelineConfig.pipelineLayout = m_PipelineLayout;
 
-    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/ray_shader_vert.spv").string();
-    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/ray_shader_frag.spv").string();
+    const std::string vertexShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/ray_shader_vert.spv").string();
+    const std::string fragmentShader = RAYX::canonicalizeRepositoryPath("build/bin/shaders/ray_shader_frag.spv").string();
     m_Pipeline = std::make_unique<GraphicsPipeline>(m_Device, vertexShader, fragmentShader, pipelineConfig);
 }

Intern/rayx/CMakeLists.txt

@@ -41,6 +41,9 @@ target_include_directories(${PROJECT_NAME} PRIVATE ${PROJECT_BINARY_DIR})
 # ----------------------
 
 # ---- CPack ----
+install(DIRECTORY ${CMAKE_BINARY_DIR}/bin/shaders
+        DESTINATION ./
+        FILES_MATCHING PATTERN "comp.spv")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "rayx - A RAYX Beamline Simulation Tool")
 set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
 set(CPACK_PACKAGE_INSTALL_DIRECTORY "rayx")