Improve shader profile extension to be more compatible with bgfx (#247)

* remove profile extension incompatible with those listed under examples/runtime/shaders; fix incorrect parameter names; enforce consistent syntax when appending to CLI.

* remove dx9

* add separate profile extension for paths vs profile extension

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install Linux dependencies
         run: |
           sudo apt-get update
-          sudo apt install -y libgl1-mesa-dev
+          sudo apt install -y libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev
       - uses: lukka/get-cmake@latest
         with:
           cmakeVersion: ${{ env.CMAKE_VERSION }}
@@ -63,7 +63,7 @@ jobs:
       - name: Install Linux dependencies
         run: |
           sudo apt-get update
-          sudo apt install -y libgl1-mesa-dev
+          sudo apt install -y libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev
         if: matrix.os == 'ubuntu-latest'
 
       # Setup the build machine with the most recent versions of CMake and Ninja. Both are cached if not already: on subsequent runs both will be quickly restored from GitHub cache service.
@@ -100,7 +100,7 @@ jobs:
       - name: Install Linux dependencies
         run: |
           sudo apt-get update
-          sudo apt install -y libgl1-mesa-dev
+          sudo apt install -y libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev
         if: matrix.os == 'ubuntu-latest'
 
       # Setup the build machine with the most recent versions of CMake and Ninja. Both are cached if not already: on subsequent runs both will be quickly restored from GitHub cache service.

.github/workflows/release.yml

@@ -57,7 +57,7 @@ jobs:
       - name: Install Linux dependencies
         run: |
           sudo apt-get update
-          sudo apt install -y libgl1-mesa-dev
+          sudo apt install -y libgl1-mesa-dev libwayland-dev libwayland-egl-backend-dev
         if: matrix.os == 'ubuntu-latest'
       # Setup the build machine with the most recent versions of CMake and Ninja. Both are cached if not already: on subsequent runs both will be quickly restored from GitHub cache service.
       - uses: lukka/get-cmake@latest

CMakeLists.txt

@@ -43,7 +43,7 @@ option(BGFX_INSTALL "Create installation target." ON)
 cmake_dependent_option(
 	BGFX_INSTALL_EXAMPLES "Install examples and their runtimes." OFF "BGFX_INSTALL;BGFX_BUILD_EXAMPLES" OFF
 )
-cmake_dependent_option(BGFX_WITH_WAYLAND "Use Wayland backend." ON "CMAKE_SYSTEM_NAME STREQUAL 'Linux'" OFF)
+cmake_dependent_option(BGFX_WITH_WAYLAND "Use Wayland backend." ON "CMAKE_SYSTEM_NAME STREQUAL Linux" OFF)
 option(BGFX_CUSTOM_TARGETS "Include convenience custom targets." ON)
 option(BGFX_CONFIG_MULTITHREADED "Build bgfx with multithreaded configuration" ON)
 option(BGFX_CONFIG_RENDERER_WEBGPU "Enable the webgpu renderer" OFF)

README.md

@@ -86,35 +86,38 @@ bgfx_compile_texture(
 )
 ```
 
-### `bgfx_compile_shader_to_header`
+### `bgfx_compile_shaders`
 Add a build rule for a `*.sc` shader to the generated build system using shaderc.
 ```cmake
-bgfx_compile_shader_to_header(
+bgfx_compile_shaders(
 	TYPE VERTEX|FRAGMENT|COMPUTE
 	SHADERS filenames
 	VARYING_DEF filename
 	OUTPUT_DIR directory
+	[AS_HEADER]
 )
 ```
-This defines a shaderc command to generate headers for a number of `TYPE` shaders with `SHADERS` files and `VARYING_DEF` file in the `OUTPUT_DIR` directory. There will be one generated shader for each supported rendering API on this current platform according to the `BGFX_EMBEDDED_SHADER` macro in `bgfx/embedded_shader.h`.
+This defines a shaderc command to generate binaries or headers for a number of `TYPE` shaders with `SHADERS` files and `VARYING_DEF` file in the `OUTPUT_DIR` directory. There will be one generated shader for each supported rendering API on this current platform according to the `BGFX_EMBEDDED_SHADER` macro in `bgfx/embedded_shader.h` for headers and in the directory expected by `load_shader` in `bgfx_utils.h`.
 
-The generated headers will have names in the format of `${SHADERS}.${RENDERING_API}.bin.h` where `RENDERING_API` can be `glsl`, `essl`, `spv`, `dx9`, `dx11` and `mtl` depending on the availability of the platform.
+The generated headers will have names in the format of `${RENDERING_API}/${SHADERS}.bin[.h]` where `RENDERING_API` can be `glsl`, `essl`, `spv`, `dx11` and `mtl` depending on the availability of the platform.
 
 Adding these `SHADERS` as source files to a target will run `shaderc` at build time and they will rebuild if either the contents of the `SHADERS` or the `VARYING_DEF` change.
 
 #### Examples: Generating shaders as headers
 ```cmake
-bgfx_compile_shader_to_header(
+bgfx_compile_shaders(
   TYPE VERTEX
   SHADERS vs.sc
   VARYING_DEF varying.def.sc
   OUTPUT_DIR ${CMAKE_BINARY_DIR}/include/generated/shaders
+  AS_HEADER
 )
 bgfx_compile_shader_to_header(
   TYPE FRAGMENT
   SHADERS fs.sc
   VARYING_DEF ${CMAKE_SOURCE_DIR}/varying.def.sc
   OUTPUT_DIR ${CMAKE_BINARY_DIR}/include/generated/shaders
+  AS_HEADER
 )
 
 add_library(myLib main.cpp vs.sc fs.sc)
@@ -123,21 +126,19 @@ target_include_directories(myLib ${CMAKE_BINARY_DIR}/include/generated/shaders)
 
 ```cpp
 // main.cpp
-#include <vs.sc.glsl.bin.h>
-#include <vs.sc.essl.bin.h>
-#include <vs.sc.spv.bin.h>
-#include <fs.sc.glsl.bin.h>
-#include <fs.sc.essl.bin.h>
-#include <fs.sc.spv.bin.h>
+#include <glsl/vs.sc.bin.h>
+#include <essl/vs.sc.bin.h>
+#include <spv/vs.sc.bin.h>
+#include <glsl/fs.sc.bin.h>
+#include <essl/fs.sc.bin.h>
+#include <spv/fs.sc.bin.h>
 #if defined(_WIN32)
-#include <vs.sc.dx9.bin.h>
-#include <vs.sc.dx11.bin.h>
-#include <fs.sc.dx9.bin.h>
-#include <fs.sc.dx11.bin.h>
+#include <dx11/vs.sc.bin.h>
+#include <dx11/fs.sc.bin.h>
 #endif //  defined(_WIN32)
 #if __APPLE__
-#include <vs.sc.mtl.bin.h>
-#include <fs.sc.mtl.bin.h>
+#include <mtl/vs.sc.bin.h>
+#include <mtl/fs.sc.bin.h>
 #endif // __APPLE__
 
 const bgfx::EmbeddedShader k_vs = BGFX_EMBEDDED_SHADER(vs);

cmake/bgfx/3rdparty/spirv-opt.cmake

@@ -74,6 +74,8 @@ file(
 	${SPIRV_TOOLS}/source/text.h
 	${SPIRV_TOOLS}/source/text_handler.cpp
 	${SPIRV_TOOLS}/source/text_handler.h
+	${SPIRV_TOOLS}/source/to_string.cpp
+	${SPIRV_TOOLS}/source/to_string.h
 	${SPIRV_TOOLS}/source/util/bit_vector.cpp
 	${SPIRV_TOOLS}/source/util/bit_vector.h
 	${SPIRV_TOOLS}/source/util/bitutils.h

cmake/bgfx/bgfx.cmake

@@ -87,6 +87,7 @@ endif()
 
 if(BGFX_WITH_WAYLAND)
 	target_compile_definitions(bgfx PRIVATE "WL_EGL_PLATFORM=1")
+	target_link_libraries(bgfx PRIVATE wayland-egl)
 endif()
 
 set(BGFX_CONFIG_OPTIONS "")

cmake/bgfx/examples.cmake

@@ -136,14 +136,19 @@ function(add_example ARG_NAME)
 		target_link_libraries(
 			example-${ARG_NAME} PUBLIC bgfx bx bimg bimg_decode ${DEAR_IMGUI_LIBRARIES} ${MESHOPTIMIZER_LIBRARIES}
 		)
+
+		if(BGFX_WITH_WAYLAND)
+			target_compile_definitions(example-${ARG_NAME} PUBLIC ENTRY_CONFIG_USE_WAYLAND=1)
+		endif()
+
 		if(BGFX_WITH_GLFW)
 			find_package(glfw3 REQUIRED)
 			target_link_libraries(example-${ARG_NAME} PUBLIC glfw)
-			target_compile_definitions(example-${ARG_NAME} PUBLIC ENTRY_CONFIG_USE_GLFW)
+			target_compile_definitions(example-${ARG_NAME} PUBLIC ENTRY_CONFIG_USE_GLFW=1)
 		elseif(BGFX_WITH_SDL)
 			find_package(SDL2 REQUIRED)
 			target_link_libraries(example-${ARG_NAME} PUBLIC ${SDL2_LIBRARIES})
-			target_compile_definitions(example-${ARG_NAME} PUBLIC ENTRY_CONFIG_USE_SDL)
+			target_compile_definitions(example-${ARG_NAME} PUBLIC ENTRY_CONFIG_USE_SDL=1)
 		elseif(UNIX AND NOT APPLE AND NOT ANDROID)
 			target_link_libraries(example-${ARG_NAME} PUBLIC X11)
 		endif()

cmake/bgfxToolUtils.cmake

@@ -215,7 +215,7 @@ if(TARGET bgfx::texturec)
 		add_custom_command(
 			OUTPUT ${ARG_OUTPUT} #
 			COMMAND bgfx::texturec ${CLI} #
-			MAIN_DEPENDENCY ${ARG_INPUT} #
+			MAIN_DEPENDENCY ${ARG_FILE} #
 		)
 	endfunction()
 endif()
@@ -279,12 +279,12 @@ if(TARGET bgfx::geometryc)
 
 		# --packnormal
 		if(ARG_PACKNORMAL)
-			list(APPEND CLI "--packnormal ${ARG_PACKNORMAL}")
+			list(APPEND CLI "--packnormal" "${ARG_PACKNORMAL}")
 		endif()
 
 		# --packuv
 		if(ARG_PACKUV)
-			list(APPEND CLI "--packuv" ${ARG_PACKUV})
+			list(APPEND CLI "--packuv" "${ARG_PACKUV}")
 		endif()
 
 		# --tangent
@@ -352,7 +352,7 @@ if(TARGET bgfx::geometryc)
 		add_custom_command(
 			OUTPUT ${ARG_OUTPUT} #
 			COMMAND bgfx::geometryc ${CLI} #
-			MAIN_DEPENDENCY ${ARG_INPUT} #
+			MAIN_DEPENDENCY ${ARG_FILE} #
 		)
 	endfunction()
 endif()
@@ -539,34 +539,43 @@ if(TARGET bgfx::shaderc)
 		set(${ARG_OUT} ${CLI} PARENT_SCOPE)
 	endfunction()
 
+	# extensions consistent with those listed under bgfx/runtime/shaders
+	function(_bgfx_get_profile_path_ext PROFILE PROFILE_PATH_EXT)
+		string(REPLACE 300_es essl PROFILE ${PROFILE})
+		string(REPLACE 120 glsl PROFILE ${PROFILE})
+		string(REPLACE s_4_0 dx10 PROFILE ${PROFILE})
+		string(REPLACE s_5_0 dx11 PROFILE ${PROFILE})
+		set(${PROFILE_PATH_EXT} ${PROFILE} PARENT_SCOPE)
+	endfunction()
+
+	# extensions consistent with embedded_shader.h
 	function(_bgfx_get_profile_ext PROFILE PROFILE_EXT)
 		string(REPLACE 300_es essl PROFILE ${PROFILE})
 		string(REPLACE 120 glsl PROFILE ${PROFILE})
 		string(REPLACE spirv spv PROFILE ${PROFILE})
 		string(REPLACE metal mtl PROFILE ${PROFILE})
-		string(REPLACE s_3_0 dx9 PROFILE ${PROFILE})
 		string(REPLACE s_4_0 dx10 PROFILE ${PROFILE})
 		string(REPLACE s_5_0 dx11 PROFILE ${PROFILE})
-
 		set(${PROFILE_EXT} ${PROFILE} PARENT_SCOPE)
 	endfunction()
 
-	# bgfx_compile_shader_to_header(
+	# bgfx_compile_shaders(
 	# 	TYPE VERTEX|FRAGMENT|COMPUTE
 	# 	SHADERS filenames
 	# 	VARYING_DEF filename
 	# 	OUTPUT_DIR directory
 	# 	OUT_FILES_VAR variable name
 	# 	INCLUDE_DIRS directories
+	# 	[AS_HEADERS]
 	# )
 	#
-	function(bgfx_compile_shader_to_header)
-		set(options "")
+	function(bgfx_compile_shaders)
+		set(options AS_HEADERS)
 		set(oneValueArgs TYPE VARYING_DEF OUTPUT_DIR OUT_FILES_VAR)
 		set(multiValueArgs SHADERS INCLUDE_DIRS)
 		cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" "${ARGN}")
 
-		set(PROFILES 120 300_es spirv) # pssl
+		set(PROFILES 120 300_es spirv)
 		if(UNIX AND NOT APPLE)
 			set(PLATFORM LINUX)
 		elseif(EMSCRIPTEN)
@@ -584,6 +593,8 @@ if(TARGET bgfx::shaderc)
 			list(APPEND PROFILES s_4_0)
 			list(APPEND PROFILES s_5_0)
 		else()
+			# pssl for Agc and Gnm renderers
+			# nvn for Nvn renderer
 			message(error "shaderc: Unsupported platform")
 		endif()
 
@@ -597,15 +608,25 @@ if(TARGET bgfx::shaderc)
 			# Build output targets and their commands
 			set(OUTPUTS "")
 			set(COMMANDS "")
+			set(MKDIR_COMMANDS "")
 			foreach(PROFILE ${PROFILES})
+				_bgfx_get_profile_path_ext(${PROFILE} PROFILE_PATH_EXT)
 				_bgfx_get_profile_ext(${PROFILE} PROFILE_EXT)
-				set(OUTPUT ${ARGS_OUTPUT_DIR}/${SHADER_FILE_BASENAME}.${PROFILE_EXT}.bin.h)
+				if(ARGS_AS_HEADERS)
+					set(HEADER_PREFIX .h)
+				endif()
+				set(OUTPUT ${ARGS_OUTPUT_DIR}/${PROFILE_PATH_EXT}/${SHADER_FILE_BASENAME}.bin${HEADER_PREFIX})
 				set(PLATFORM_I ${PLATFORM})
 				if(PROFILE STREQUAL "spirv")
 					set(PLATFORM_I LINUX)
 				endif()
+				set(BIN2C_PART "")
+				if(ARGS_AS_HEADERS)
+					set(BIN2C_PART BIN2C ${SHADER_FILE_NAME_WE}_${PROFILE_EXT})
+				endif()
 				_bgfx_shaderc_parse(
 					CLI #
+					${BIN2C_PART} #
 					${ARGS_TYPE} ${PLATFORM_I} WERROR "$<$<CONFIG:debug>:DEBUG>$<$<CONFIG:relwithdebinfo>:DEBUG>"
 					FILE ${SHADER_FILE_ABSOLUTE}
 					OUTPUT ${OUTPUT}
@@ -613,16 +634,24 @@ if(TARGET bgfx::shaderc)
 					O "$<$<CONFIG:debug>:0>$<$<CONFIG:release>:3>$<$<CONFIG:relwithdebinfo>:3>$<$<CONFIG:minsizerel>:3>"
 					VARYINGDEF ${ARGS_VARYING_DEF}
 					INCLUDES ${BGFX_SHADER_INCLUDE_PATH} ${ARGS_INCLUDE_DIRS}
-					BIN2C BIN2C ${SHADER_FILE_NAME_WE}_${PROFILE_EXT}
 				)
 				list(APPEND OUTPUTS ${OUTPUT})
 				list(APPEND ALL_OUTPUTS ${OUTPUT})
+				list(
+					APPEND
+					MKDIR_COMMANDS
+					COMMAND
+					${CMAKE_COMMAND}
+					-E
+					make_directory
+					${ARGS_OUTPUT_DIR}/${PROFILE_PATH_EXT}
+				)
 				list(APPEND COMMANDS COMMAND bgfx::shaderc ${CLI})
 			endforeach()
 
 			add_custom_command(
 				OUTPUT ${OUTPUTS}
-				COMMAND ${CMAKE_COMMAND} -E make_directory ${ARGS_OUTPUT_DIR} ${COMMANDS}
+				COMMAND ${MKDIR_COMMANDS} ${COMMANDS}
 				MAIN_DEPENDENCY ${SHADER_FILE_ABSOLUTE}
 				DEPENDS ${ARGS_VARYING_DEF}
 			)