Integrated shaders into the build system

Author: Carmelo Fernandez Aguera

CMakeLists.txt

@@ -12,12 +12,18 @@ option(REV_BUILD_TEST "Build engine unit tests" ON)
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 set(CMAKE_CXX_STANDARD 20)
 
+# Find GLSL compiler
+find_package(Vulkan REQUIRED)
+set(VULKAN_BIN_DIR ${Vulkan_INCLUDE_DIR}/../bin/)
+set(GLSLANGVALIDATOR ${VULKAN_BIN_DIR}glslc.exe)
+
 add_subdirectory(engine)
 
 if(REV_BUILD_TOOLS)
 	add_subdirectory(tools)
 endif()
 
+# Compile sample projects
 add_subdirectory(samples/ShaderToy)
 add_subdirectory(samples/GltfViewer)
 

cmake/common.cmake

@@ -21,4 +21,58 @@ macro(GroupSources curdir dirLabel)
 				${PROJECT_SOURCE_DIR}/${curdir}/${child})
 		endif()
 	endforeach()
+endmacro()
+
+#####################################################################################
+# Macro to add custom build for SPIR-V, with additional arbitrary glslangvalidator
+# flags (run glslangvalidator --help for a list of possible flags).
+# Inputs:
+# _SOURCE can be more than one file (.vert + .frag)
+# _OUTPUT is the .spv file, resulting from the linkage
+# _FLAGS are the flags to add to the command line
+# Outputs:
+# SOURCE_LIST has _SOURCE appended to it
+# OUTPUT_LIST has _OUTPUT appended to it
+#
+macro(_compile_GLSL_flags _SOURCE _OUTPUT _FLAGS SOURCE_LIST OUTPUT_LIST)
+  LIST(APPEND ${SOURCE_LIST} ${_SOURCE})
+  LIST(APPEND ${OUTPUT_LIST} ${_OUTPUT})
+  if(GLSLANGVALIDATOR)
+    set(_COMMAND ${GLSLANGVALIDATOR} ${_SOURCE} -o ${_OUTPUT} ${_FLAGS})
+    add_custom_command(
+      OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/${_OUTPUT}
+      COMMAND echo ${_COMMAND}
+      COMMAND ${_COMMAND}
+      MAIN_DEPENDENCY ${_SOURCE}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+      )
+  else(GLSLANGVALIDATOR)
+    MESSAGE(WARNING "could not find GLSLANGVALIDATOR to compile shaders")
+  endif(GLSLANGVALIDATOR)
+endmacro()
+
+#####################################################################################
+# Macro to add custom build for SPIR-V, with debug information (glslangvalidator's -g flag)
+# Inputs:
+# _SOURCE can be more than one file (.vert + .frag)
+# _OUTPUT is the .spv file, resulting from the linkage
+# Outputs:
+# SOURCE_LIST has _SOURCE appended to it
+# OUTPUT_LIST has _OUTPUT appended to it
+#
+macro(_compile_GLSL _SOURCE _OUTPUT SOURCE_LIST OUTPUT_LIST)
+  _compile_GLSL_flags(${_SOURCE} ${_OUTPUT} "-g" ${SOURCE_LIST} ${OUTPUT_LIST})
+endmacro()
+
+#####################################################################################
+# Macro to add custom build for SPIR-V, without debug information
+# Inputs:
+# _SOURCE can be more than one file (.vert + .frag)
+# _OUTPUT is the .spv file, resulting from the linkage
+# Outputs:
+# SOURCE_LIST has _SOURCE appended to it
+# OUTPUT_LIST has _OUTPUT appended to it
+#
+macro(_compile_GLSL_no_debug_info _SOURCE _OUTPUT SOURCE_LIST OUTPUT_LIST)
+  _compile_GLSL_flags(${_SOURCE} ${_OUTPUT} "" ${SOURCE_LIST} ${OUTPUT_LIST})
 endmacro()

engine/CMakeLists.txt

@@ -6,8 +6,6 @@ project(engine)
 
 include(../cmake/common.cmake)
 
-find_package(Vulkan REQUIRED)
-
 #######################################################################
 ####### Create separate libraries for each module of the engine #######
 # Core

samples/gltfViewer/CMakeLists.txt

@@ -7,10 +7,31 @@ project(GltfViewer)
 
 include(../../cmake/common.cmake)
 
+UNSET(GLSL_SOURCES)
+UNSET(SPV_OUTPUT)
+file(GLOB_RECURSE GLSL_HEADER_FILES "shaders/*.h" "shaders/*.glsl")
+file(GLOB_RECURSE GLSL_SOURCE_FILES
+    "shaders/*.comp"
+    "shaders/*.frag"
+    "shaders/*.vert"
+    "shaders/*.rchit"
+    "shaders/*.rahit"
+    "shaders/*.rmiss"
+    "shaders/*.rgen"
+    )
+foreach(GLSL ${GLSL_SOURCE_FILES})
+    get_filename_component(FILE_NAME ${GLSL} NAME)
+    _compile_GLSL(${GLSL} "./bin/${FILE_NAME}.spv" GLSL_SOURCES SPV_OUTPUT)
+endforeach(GLSL)
+
+list(APPEND GLSL_SOURCES ${GLSL_HEADER_FILES})
+source_group(shaders FILES ${GLSL_SOURCES})
+
 file(GLOB_RECURSE SOURCE_FILES "src/*.cpp" "src/*.h" "src/*.inl")
-GroupSources(src GltfViewer)
-add_executable(GltfViewer ${SOURCE_FILES})
-# Visual studio specifics
+GroupSources(src src)
+add_executable(GltfViewer ${SOURCE_FILES} ${GLSL_SOURCES})
+set_target_properties( GltfViewer PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
+target_link_libraries (GltfViewer LINK_PUBLIC revCore revMath revGfx revGame revInput)
 
-set_target_properties(GltfViewer PROPERTIES FOLDER "samples")
-target_link_libraries (GltfViewer LINK_PUBLIC revCore revMath revGfx revGame revInput)
+# Visual studio specifics
+set_target_properties(GltfViewer PROPERTIES FOLDER "samples")

samples/gltfViewer/bin/shaders/ui.frag

@@ -19,8 +19,9 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #version 450
 
+layout(location = 0) in vec3 vVtxColor;
 layout(location = 0) out vec4 outColor;
 
 void main() {
-    outColor = vec4(1.0, 0.0, 0.0, 1.0);
+    outColor = vec4(vVtxColor, 1.0);
 }

samples/gltfViewer/bin/shaders/ui.vert

@@ -19,12 +19,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #version 450
 
-vec2 positions[3] = vec2[](
-    vec2(0.0, -0.5),
-    vec2(-0.5, 0.5),
-    vec2(0.5, 0.5)
-);
+layout(location = 0) in vec2 position;
+layout(location = 1) in vec3 color;
+
+layout(location = 0) out vec3 vVtxColor;
 
 void main() {
-    gl_Position = vec4(positions[gl_VertexIndex], 0.0, 1.0);
+    gl_Position = vec4(position, 0.0, 1.0);
+    vVtxColor = color;
 }

samples/gltfViewer/bin/ui.frag.spv

@@ -0,0 +1,27 @@
+//--------------------------------------------------------------------------------------------------
+// Revolution Engine
+//--------------------------------------------------------------------------------------------------
+// Copyright 2021 Carmelo J Fdez-Aguera
+// 
+// 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.
+#version 450
+
+layout(location = 0) in vec3 vVtxColor;
+layout(location = 0) out vec4 outColor;
+
+void main() {
+    outColor = vec4(vVtxColor, 1.0);
+}

samples/gltfViewer/bin/ui.vert.spv

@@ -0,0 +1,30 @@
+//--------------------------------------------------------------------------------------------------
+// Revolution Engine
+//--------------------------------------------------------------------------------------------------
+// Copyright 2021 Carmelo J Fdez-Aguera
+// 
+// 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.
+#version 450
+
+layout(location = 0) in vec2 position;
+layout(location = 1) in vec3 color;
+
+layout(location = 0) out vec3 vVtxColor;
+
+void main() {
+    gl_Position = vec4(position, 0.0, 1.0);
+    vVtxColor = color;
+}