ew option to allow "example-common" project to not be included in build. (#225)

* Added a new option to allow "example-common" project to not be included in build.

* Set BGFX_BUILD_EXAMPLE_COMMON as a dependent option, it will be set ON if either tools or examples are included in the build, OFF otherwise.

* cmake format

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: Sandy <bwrsandman@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @bwrsandman

.github/dependabot.yml

@@ -4,3 +4,8 @@ updates:
     directory: "/"
     schedule:
       interval: "monthly"
+    groups:
+      # Name of the group
+      submodules:
+        patterns:
+          - "*"

.github/workflows/release.yml

@@ -97,79 +97,82 @@ jobs:
         with:
           submodules: recursive
           fetch-depth: 0
+          path: src/bgfx.cmake
+      - run: |
+          find src/bgfx.cmake -name ".git*" -exec rm -rf {} +
+          find src/bgfx.cmake -name ".editorconfig" -delete
+          rm src/bgfx.cmake/.cmake-format.py
       - uses: actions/download-artifact@v3
         with:
           name: windows-latest
-          path: ${{ github.workspace }}/install/windows
+          path: ${{ github.workspace }}/install/windows/bgfx.cmake
       - uses: actions/download-artifact@v3
         with:
           name: ubuntu-latest
-          path: ${{ github.workspace }}/install/linux
+          path: ${{ github.workspace }}/install/linux/bgfx.cmake
       - uses: actions/download-artifact@v3
         with:
           name: macos-latest
-          path: ${{ github.workspace }}/install/macos
+          path: ${{ github.workspace }}/install/macos/bgfx.cmake
       - name: Create Source Zip
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'zip'
-          filename: 'release.${{ needs.version.outputs.tag }}.zip'
-          directory: '..'
+          filename: 'bgfx.cmake.${{ needs.version.outputs.tag }}.zip'
+          directory: 'src'
           path: 'bgfx.cmake'
-          exclusions: '.git* .cmake-format.py .editorconfig install'
       - name: Create Source Tar
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'tar'
-          filename: 'release.${{ needs.version.outputs.tag }}.tar.gz'
-          directory: '..'
+          filename: 'bgfx.cmake.${{ needs.version.outputs.tag }}.tar.gz'
+          directory: 'src'
           path: 'bgfx.cmake'
-          exclusions: '.git* .cmake-format.py .editorconfig install'
       - name: Create Windows Zip
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'zip'
-          filename: 'windows.${{ needs.version.outputs.tag }}.zip'
-          directory: 'install'
-          path: 'windows'
+          filename: 'bgfx.cmake.binary.windows.${{ needs.version.outputs.tag }}.zip'
+          directory: 'install/windows'
+          path: 'bgfx.cmake'
       - name: Create Windows Tar
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'tar'
-          filename: 'windows.${{ needs.version.outputs.tag }}.tar.gz'
-          directory: 'install'
-          path: 'windows'
+          filename: 'bgfx.cmake.binary.windows.${{ needs.version.outputs.tag }}.tar.gz'
+          directory: 'install/windows'
+          path: 'bgfx.cmake'
       - name: Create Linux Zip
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'zip'
-          filename: 'linux.${{ needs.version.outputs.tag }}.zip'
-          directory: 'install'
-          path: 'linux'
+          filename: 'bgfx.cmake.binary.linux.${{ needs.version.outputs.tag }}.zip'
+          directory: 'install/linux'
+          path: 'bgfx.cmake'
       - name: Create Linux Tar
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'tar'
-          filename: 'linux.${{ needs.version.outputs.tag }}.tar.gz'
-          directory: 'install'
-          path: 'linux'
+          filename: 'bgfx.cmake.binary.linux.${{ needs.version.outputs.tag }}.tar.gz'
+          directory: 'install/linux'
+          path: 'bgfx.cmake'
       - name: Create MacOS Zip
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'zip'
-          filename: 'macos.${{ needs.version.outputs.tag }}.zip'
-          directory: 'install'
-          path: 'macos'
+          filename: 'bgfx.cmake.binary.macos.${{ needs.version.outputs.tag }}.zip'
+          directory: 'install/macos'
+          path: 'bgfx.cmake'
       - name: Create MacOS Tar
         uses: thedoctor0/zip-release@0.7.1
         with:
           type: 'tar'
-          filename: 'macos.${{ needs.version.outputs.tag }}.tar.gz'
-          directory: 'install'
-          path: 'macos'
+          filename: 'bgfx.cmake.binary.macos.${{ needs.version.outputs.tag }}.tar.gz'
+          directory: 'install/macos'
+          path: 'bgfx.cmake'
       - name: Create Release
         uses: ncipollo/release-action@v1
         with:
           tag: ${{ needs.version.outputs.tag }}
-          artifacts: "../release.${{ needs.version.outputs.tag }}.zip ../release.${{ needs.version.outputs.tag }}.tar.gz install/*.${{ needs.version.outputs.tag }}.zip install/*.${{ needs.version.outputs.tag }}.tar.gz"
+          artifacts: "src/bgfx.cmake.${{ needs.version.outputs.tag }}.zip,src/bgfx.cmake.${{ needs.version.outputs.tag }}.tar.gz,install/*/*.${{ needs.version.outputs.tag }}.zip,install/*/*.${{ needs.version.outputs.tag }}.tar.gz"
           generateReleaseNotes: true

CMakeLists.txt

@@ -13,7 +13,7 @@ project(bgfx)
 cmake_policy(SET CMP0054 NEW)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
-set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
@@ -38,6 +38,10 @@ cmake_dependent_option(BGFX_BUILD_TOOLS_GEOMETRY "Build bgfx geometry tools." ON
 cmake_dependent_option(BGFX_BUILD_TOOLS_TEXTURE "Build bgfx texture tools." ON BGFX_BUILD_TOOLS OFF)
 set(BGFX_TOOLS_PREFIX "" CACHE STRING "Prefix name to add to name of tools (to avoid clashes)")
 option(BGFX_BUILD_EXAMPLES "Build bgfx examples." ON)
+cmake_dependent_option(
+	BGFX_BUILD_EXAMPLE_COMMON "Build bgfx example-common project." OFF "NOT BGFX_BUILD_EXAMPLES;NOT BGFX_BUILD_TOOLS"
+	ON
+)
 option(BGFX_BUILD_TESTS "Build bgfx tests." OFF)
 option(BGFX_INSTALL "Create installation target." ON)
 cmake_dependent_option(
@@ -160,18 +164,6 @@ if(BGFX_INSTALL)
 
 	install(FILES ${BGFX_DIR}/LICENSE DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/licences/${PROJECT_NAME})
 
-	# install headers (this should be done as a target probably... ^)
-	install(DIRECTORY ${BX_DIR}/include/bx ${BX_DIR}/include/compat ${BX_DIR}/include/tinystl
-			DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-	)
-	install(DIRECTORY ${BIMG_DIR}/include/bimg DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
-	install(DIRECTORY ${BGFX_DIR}/include/bgfx DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
-
-	# header required for shader compilation
-	install(FILES ${BGFX_DIR}/src/bgfx_shader.sh ${BGFX_DIR}/src/bgfx_compute.sh
-			DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/bgfx"
-	)
-
 	# install tools
 	if(BGFX_CMAKE_USER_SCRIPT)
 		install(FILES ${BGFX_CMAKE_USER_SCRIPT} DESTINATION "${config_install_dir}")

README.md

@@ -48,8 +48,9 @@ Adding these `INPUT_FILE` as source files to a target will run `bin2c` at build
 #### Examples: Generating an image as a header
 ```cmake
 bgfx_compile_binary_to_header(
-  INPUT_FILE image.png
+  INPUT_FILE ${CMAKE_CURRENT_SOURCE_DIR}/image.png
   OUTPUT_FILE ${CMAKE_BINARY_DIR}/include/generated/images/image.png.h
+  ARRAY_NAME image_bytes
 )
 add_library(myLib image.png)
 target_include_directories(myLib ${CMAKE_BINARY_DIR}/include/generated/images)
@@ -58,6 +59,7 @@ target_include_directories(myLib ${CMAKE_BINARY_DIR}/include/generated/images)
 ```cpp
 // main.cpp
 #include <image.png.h>
+// You now have access to a static const uint8_t or char array named image_bytes
 ```
 
 ### `bgfx_compile_texture`

cmake/Config.cmake.in

@@ -9,28 +9,26 @@ list(GET BGFX_INCLUDE_PATH 0 BGFX_INCLUDE_PATH_1) # bgfx::bgfx exports include d
 set(BGFX_SHADER_INCLUDE_PATH ${BGFX_INCLUDE_PATH_1}/bgfx)
 
 # If cross compiling, we need a host-compatible version of shaderc to compile shaders
-if(@CMAKE_CROSSCOMPILING@)
-	macro(_bgfx_crosscompile_use_host_tool TOOL_NAME)
-		if(NOT TARGET bgfx::${TOOL_NAME})
-			find_program(
-				${TOOL_NAME}_EXECUTABLE REQUIRED
-				NAMES bgfx-${TOOL_NAME} ${TOOL_NAME}
-				PATHS /usr/bin #
-					  ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-linux/tools/bgfx
-					  ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-windows/tools/bgfx
-					  ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-osx/tools/bgfx
-			)
-			add_executable(bgfx::${TOOL_NAME} IMPORTED)
-			set_target_properties(bgfx::${TOOL_NAME} PROPERTIES IMPORTED_LOCATION "${${TOOL_NAME}_EXECUTABLE}")
-		endif()
-	endmacro()
+macro(_bgfx_crosscompile_use_host_tool TOOL_NAME)
+	if(NOT TARGET bgfx::${TOOL_NAME})
+		find_program(
+			${TOOL_NAME}_EXECUTABLE
+			NAMES bgfx-${TOOL_NAME} ${TOOL_NAME}
+			PATHS /usr/bin #
+					${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-linux/tools/bgfx
+					${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-windows/tools/bgfx
+					${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/packages/bgfx_x64-osx/tools/bgfx
+		)
+		add_executable(bgfx::${TOOL_NAME} IMPORTED)
+		set_target_properties(bgfx::${TOOL_NAME} PROPERTIES IMPORTED_LOCATION "${${TOOL_NAME}_EXECUTABLE}")
+	endif()
+endmacro()
 
-	_bgfx_crosscompile_use_host_tool(bin2c)
-	_bgfx_crosscompile_use_host_tool(texturec)
-	_bgfx_crosscompile_use_host_tool(shaderc)
-	_bgfx_crosscompile_use_host_tool(texturev)
-	_bgfx_crosscompile_use_host_tool(geometryv)
-endif()
+_bgfx_crosscompile_use_host_tool(bin2c)
+_bgfx_crosscompile_use_host_tool(texturec)
+_bgfx_crosscompile_use_host_tool(shaderc)
+_bgfx_crosscompile_use_host_tool(texturev)
+_bgfx_crosscompile_use_host_tool(geometryv)
 
 include("${CMAKE_CURRENT_LIST_DIR}/bgfxToolUtils.cmake")
 check_required_components("@PROJECT_NAME@")

cmake/bgfx/CMakeLists.txt

@@ -12,9 +12,6 @@ include(bgfx.cmake)
 include(3rdparty/meshoptimizer.cmake)
 include(3rdparty/dear-imgui.cmake)
 
-include(shared.cmake)
-include(examples.cmake)
-
 if(BGFX_BUILD_TOOLS_TEXTURE)
 	include(texturev.cmake)
 endif()
@@ -31,3 +28,6 @@ if(BGFX_BUILD_TOOLS_SHADER)
 	include(3rdparty/webgpu.cmake)
 	include(shaderc.cmake)
 endif()
+
+include(shared.cmake)
+include(examples.cmake)

cmake/bgfx/bgfx.cmake

@@ -217,4 +217,11 @@ if(BGFX_INSTALL)
 		INCLUDES
 		DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 	)
+
+	install(DIRECTORY ${BGFX_DIR}/include/bgfx DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+
+	# header required for shader compilation
+	install(FILES ${BGFX_DIR}/src/bgfx_shader.sh ${BGFX_DIR}/src/bgfx_compute.sh
+			DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/bgfx"
+	)
 endif()

cmake/bgfx/examples.cmake

@@ -33,19 +33,6 @@ function(add_bgfx_shader FILE FOLDER)
 		set(OUTPUTS_PRETTY "")
 
 		if(WIN32)
-			# dx9
-			if(NOT "${TYPE}" STREQUAL "COMPUTE")
-				set(DX9_OUTPUT ${BGFX_DIR}/examples/runtime/shaders/dx9/${FILENAME}.bin)
-				_bgfx_shaderc_parse(
-					DX9 ${COMMON} WINDOWS
-					PROFILE s_3_0
-					O 3
-					OUTPUT ${DX9_OUTPUT}
-				)
-				list(APPEND OUTPUTS "DX9")
-				set(OUTPUTS_PRETTY "${OUTPUTS_PRETTY}DX9, ")
-			endif()
-
 			# dx11
 			set(DX11_OUTPUT ${BGFX_DIR}/examples/runtime/shaders/dx11/${FILENAME}.bin)
 			if(NOT "${TYPE}" STREQUAL "COMPUTE")
@@ -78,7 +65,7 @@ function(add_bgfx_shader FILE FOLDER)
 		# essl
 		if(NOT "${TYPE}" STREQUAL "COMPUTE")
 			set(ESSL_OUTPUT ${BGFX_DIR}/examples/runtime/shaders/essl/${FILENAME}.bin)
-			_bgfx_shaderc_parse(ESSL ${COMMON} ANDROID OUTPUT ${ESSL_OUTPUT})
+			_bgfx_shaderc_parse(ESSL ${COMMON} ANDROID PROFILE 100_es OUTPUT ${ESSL_OUTPUT})
 			list(APPEND OUTPUTS "ESSL")
 			set(OUTPUTS_PRETTY "${OUTPUTS_PRETTY}ESSL, ")
 		endif()
@@ -276,17 +263,19 @@ if(BGFX_CUSTOM_TARGETS)
 endif()
 
 # Add common library for examples
-add_example(
-	common
-	COMMON
-	DIRECTORIES
-	${BGFX_DIR}/examples/common/debugdraw
-	${BGFX_DIR}/examples/common/entry
-	${BGFX_DIR}/examples/common/font
-	${BGFX_DIR}/examples/common/imgui
-	${BGFX_DIR}/examples/common/nanovg
-	${BGFX_DIR}/examples/common/ps
-)
+if(BGFX_BUILD_EXAMPLE_COMMON)
+	add_example(
+		common
+		COMMON
+		DIRECTORIES
+		${BGFX_DIR}/examples/common/debugdraw
+		${BGFX_DIR}/examples/common/entry
+		${BGFX_DIR}/examples/common/font
+		${BGFX_DIR}/examples/common/imgui
+		${BGFX_DIR}/examples/common/nanovg
+		${BGFX_DIR}/examples/common/ps
+	)
+endif()
 
 # Only add examples if set, otherwise we still need exmaples common for tools
 if(BGFX_BUILD_EXAMPLES)

cmake/bgfx/generated/shader.cpp.in

@@ -1,4 +1,3 @@
 #include "@BGFX_DIR@/src/shader.cpp"
-#include "@BGFX_DIR@/src/shader_dx9bc.cpp"
 #include "@BGFX_DIR@/src/shader_dxbc.cpp"
-#include "@BGFX_DIR@/src/shader_spirv.cpp"
+#include "@BGFX_DIR@/src/shader_spirv.cpp"

cmake/bimg/bimg.cmake

@@ -43,7 +43,7 @@ target_link_libraries(
 		   ${MINIZ_LIBRARIES} #
 )
 
-if(BGFX_INSTALL AND NOT BGFX_LIBRARY_TYPE MATCHES "SHARED")
+if(BGFX_INSTALL)
 	install(
 		TARGETS bimg
 		EXPORT "${TARGETS_EXPORT_NAME}"
@@ -53,4 +53,5 @@ if(BGFX_INSTALL AND NOT BGFX_LIBRARY_TYPE MATCHES "SHARED")
 		INCLUDES
 		DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 	)
+	install(DIRECTORY ${BIMG_DIR}/include/bimg DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
 endif()

cmake/bx/bx.cmake

@@ -81,7 +81,7 @@ target_include_directories(
 		   $<BUILD_INTERFACE:${BX_DIR}/3rdparty> #
 		   $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}> #
 		   $<BUILD_INTERFACE:${BX_DIR}/include/compat/${BX_COMPAT_PLATFORM}> #
-		   $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/compat/${BX_COMPAT_PLATFORM}> #
+		   $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/bx/compat/${BX_COMPAT_PLATFORM}> #
 )
 
 # All configurations
@@ -121,14 +121,18 @@ endif()
 # Put in a "bgfx" folder in Visual Studio
 set_target_properties(bx PROPERTIES FOLDER "bgfx")
 
-if(NOT BGFX_LIBRARY_TYPE MATCHES "SHARED")
+if(BGFX_INSTALL)
 	install(
 		TARGETS bx
 		EXPORT "${TARGETS_EXPORT_NAME}"
 		LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
 		ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
 		RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
-		INCLUDES
-		DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 	)
+	# We will make sure tinystl and compat are not installed in /usr/include
+	install(DIRECTORY "${BX_DIR}/include/bx" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
+	install(DIRECTORY "${BX_DIR}/include/compat/${BX_COMPAT_PLATFORM}"
+			DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/bx/compat"
+	)
+	install(DIRECTORY "${BX_DIR}/include/tinystl" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/bx")
 endif()