Fix bgfx_compile_shaders section of README.md

* 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

@@ -94,7 +94,7 @@ bgfx_compile_shaders(
 	SHADERS filenames
 	VARYING_DEF filename
 	OUTPUT_DIR directory
-	[AS_HEADER]
+	[AS_HEADERS]
 )
 ```
 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`.
@@ -110,14 +110,14 @@ bgfx_compile_shaders(
   SHADERS vs.sc
   VARYING_DEF varying.def.sc
   OUTPUT_DIR ${CMAKE_BINARY_DIR}/include/generated/shaders
-  AS_HEADER
+  AS_HEADERS
 )
-bgfx_compile_shader_to_header(
+bgfx_compile_shaders(
   TYPE FRAGMENT
   SHADERS fs.sc
   VARYING_DEF ${CMAKE_SOURCE_DIR}/varying.def.sc
   OUTPUT_DIR ${CMAKE_BINARY_DIR}/include/generated/shaders
-  AS_HEADER
+  AS_HEADERS
 )
 
 add_library(myLib main.cpp vs.sc fs.sc)

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,15 +539,23 @@ 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()
 
@@ -602,8 +610,12 @@ if(TARGET bgfx::shaderc)
 			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}/${PROFILE_EXT}/${SHADER_FILE_BASENAME}.bin$<$<BOOL:ARGS_AS_HEADERS>:.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)
@@ -632,7 +644,7 @@ if(TARGET bgfx::shaderc)
 					${CMAKE_COMMAND}
 					-E
 					make_directory
-					${ARGS_OUTPUT_DIR}/${PROFILE_EXT}
+					${ARGS_OUTPUT_DIR}/${PROFILE_PATH_EXT}
 				)
 				list(APPEND COMMANDS COMMAND bgfx::shaderc ${CLI})
 			endforeach()