egui gfx backend

.github/workflows/build-doc.yml

@@ -36,6 +36,7 @@ jobs:
       - name: Run samples
         shell: msys2 {0}
         run: |
+          export GFX_BACKEND=D3D12
           cd docs/samples
           for i in $(find shards -name '*.edn');
           do
@@ -135,7 +136,7 @@ jobs:
           git config --global user.name "Fragcolor bot"
           git config --global user.email "[email protected]"
           mkdocs gh-deploy --force --message "Publish documentation from {sha}
-          
+
           Using MkDocs {version}."
       - name: Upload artifact
         uses: actions/upload-artifact@v2

.github/workflows/build-windows.yml

@@ -195,7 +195,7 @@ jobs:
         run: |
           cd build
           ninja test_gfx
-          GFX_TEST_PLATFORM_ID="github-windows" ./test_gfx
+          GFX_BACKEND=D3D12 GFX_TEST_PLATFORM_ID="github-windows" ./test_gfx
       - name: Upload artifacts
         uses: actions/upload-artifact@v2
         with:
@@ -303,6 +303,7 @@ jobs:
           RUST_BACKTRACE: 1
         shell: msys2 {0}
         run: |
+          export GFX_BACKEND=D3D12
           cd build
           echo "Running test: gfx_window"
           ./shards ../src/tests/gfx_window.edn

cmake/Rust.cmake

@@ -90,7 +90,7 @@ endmacro()
 
 # Need this custom build script to inherit the correct SDK variables from XCode
 if(IOS)
-  set(RUST_BUILD_SCRIPT "${CMAKE_SOURCE_DIR}/cmake/osx_rust_build.sh")
+  set(RUST_BUILD_SCRIPT "${CMAKE_SOURCE_DIR}/cmake/osx_rust_build.sh" ${XCODE_SDK})
 endif()
 
 # Defines a rust target
@@ -108,6 +108,7 @@ function(add_rust_library)
     FEATURES             # (Optional) List of features to pass to rust build
     ENVIRONMENT          # (Optional) Environment variables
     DEPENDS              # (Optional) Extra file-level dependencies
+    EXCLUDE_DEPENDS      # (Optional) Extra file-level dependencies to ignore
   )
   cmake_parse_arguments(RUST "${OPTS}" "${ARGS}" "${MULTI_ARGS}" ${ARGN})
 
@@ -128,6 +129,9 @@ function(add_rust_library)
   if(RUST_TEMP_SOURCES)
     list(REMOVE_ITEM RUST_SOURCES ${RUST_TEMP_SOURCES})
   endif()
+  if(RUST_EXCLUDE_DEPENDS)
+    list(REMOVE_ITEM RUST_SOURCES ${RUST_EXCLUDE_DEPENDS})
+  endif()
   message(VERBOSE "  RUST_SOURCES: ${RUST_SOURCES}")
 
   if(RUST_CARGO_TARGET)
@@ -156,9 +160,30 @@ function(add_rust_library)
 
   set(RUST_CRATE_TYPE_ARG --crate-type staticlib)
 
+  # When the compiler can't automatically provide include paths (emscripten):
+  #  pass the sysroot to the bindgen clang arguments
+  if(EMSCRIPTEN_SYSROOT)
+    file(TO_CMAKE_PATH "${EMSCRIPTEN_SYSROOT}" TMP_SYSROOT)
+    list(APPEND EXTRA_CLANG_ARGS "--sysroot=${TMP_SYSROOT}")
+  endif()
+
+  if(EMSCRIPTEN)
+    # Required to have some symbols be exported
+    # https://github.com/rust-lang/rust-bindgen/issues/751
+    list(APPEND EXTRA_CLANG_ARGS "-fvisibility=default")
+  endif()
+
+  if(EXTRA_CLANG_ARGS)
+    set(BINDGEN_EXTRA_CLANG_ARGS BINDGEN_EXTRA_CLANG_ARGS="${EXTRA_CLANG_ARGS}")
+  endif()
+
+  if(RUST_TARGET_PATH)
+    list(APPEND RUST_ENVIRONMENT "CARGO_TARGET_DIR=${RUST_TARGET_PATH}")
+  endif()
+
   add_custom_command(
     OUTPUT ${GENERATED_LIB_PATH}
-    COMMAND ${CMAKE_COMMAND} -E env RUSTFLAGS="${RUST_FLAGS}" ${RUST_ENVIRONMENT} ${RUST_BUILD_SCRIPT} ${CARGO_EXE} ${RUST_CARGO_TOOLCHAIN} rustc ${RUST_CARGO_UNSTABLE_FLAGS} ${RUST_FEATURES_ARG} ${RUST_CRATE_TYPE_ARG} ${RUST_TARGET_ARG} ${RUST_CARGO_FLAGS}
+    COMMAND ${CMAKE_COMMAND} -E env RUSTFLAGS="${RUST_FLAGS}" ${BINDGEN_EXTRA_CLANG_ARGS} ${RUST_ENVIRONMENT} ${RUST_BUILD_SCRIPT} ${CARGO_EXE} ${RUST_CARGO_TOOLCHAIN} rustc ${RUST_CARGO_UNSTABLE_FLAGS} ${RUST_FEATURES_ARG} ${RUST_CRATE_TYPE_ARG} ${RUST_TARGET_ARG} ${RUST_CARGO_FLAGS}
     WORKING_DIRECTORY ${RUST_PROJECT_PATH}
     DEPENDS ${RUST_SOURCES} ${RUST_DEPENDS}
     USES_TERMINAL
@@ -176,4 +201,4 @@ function(add_rust_library)
   set_target_properties(${RUST_TARGET_NAME} PROPERTIES
     IMPORTED_LOCATION ${GENERATED_LIB_PATH}
   )
-endfunction()
+endfunction()

cmake/osx_rust_build.sh

@@ -1,3 +1,14 @@
 #!/bin/bash
+# Script to work around some issues when calling `cargo build`/`cargo rustc` from Xcode for iOS
+#
+# The SDKROOT needs to be set to the HOST SDKROOT so that build scripts are able to build
+#  if not, it results in linker errors similar to this issue https://github.com/TimNN/cargo-lipo/issues/41
+#
+# Additionally, bindgen needs to be passed the sysroot for the target platform to be able to find the system headers
+
 set -ex
-SDKROOT=`xcrun --sdk macosx --show-sdk-path` $@
+TARGET_SDKROOT=`xcrun --sdk $1 --show-sdk-path`
+shift
+export SDKROOT=`xcrun --sdk macosx --show-sdk-path`
+export BINDGEN_EXTRA_CLANG_ARGS="-isysroot $TARGET_SDKROOT -isystem $TARGET_SDKROOT/usr/include/c++/v1 $BINDGEN_EXTRA_CLANG_ARGS"
+$@

rust/CMakeLists.txt

@@ -1,11 +1,14 @@
-set(FEATURES shards run_bindgen)
+set(FEATURES shards)
 
 if(RUST_SHLISP)
   list(APPEND FEATURES scripting)
 endif()
 
 # Bindgen dependency
-list(APPEND EXTRA_SOURCES ${SHARDS_DIR}/include/shards.h)
+list(APPEND EXTRA_SOURCES ${SHARDS_DIR}/src/extra/rust_interop.hpp ${SHARDS_DIR}/include/shards.h)
+
+# egui integration sources
+file(GLOB_RECURSE EXTRA_SOURCES "${SHARDS_DIR}/src/gfx/egui/src/*.rs")
 
 if(ANDROID OR LINUX)
   set(NEED_OPENSSL_SYS ON)

rust/Cargo.toml

@@ -36,6 +36,7 @@ parity-scale-codec = { version = "2.3.1", default-features = false, optional = t
 chacha20poly1305 = { version = "0.9.0", optional = true }
 egui = { version = "0.18.1", optional = true }
 half = { version = "1.8.2" }
+egui-gfx = { path = "../src/gfx/egui"}
 
 [target.'cfg(not(target_arch="wasm32"))'.dependencies]
 dlopen = { version = "0.1.8", optional = true }
@@ -48,7 +49,8 @@ webbrowser = { version = "0.5.5", optional = true }
 ctor = "0.1.16"
 
 [build-dependencies]
-bindgen = { version = "0.59.1", optional = true }
+bindgen = { version = "0.60.1" }
+gfx-build = { path = "../src/gfx/rust/build" }
 
 [features]
 default = []
@@ -75,8 +77,7 @@ shards = ["reqwest",
           "chacha20poly1305",
           "egui"]
 dllshard = ["dlopen"]
-run_bindgen = ["bindgen"]
 scripting = []
 
 [profile.release]
-panic = "abort"
+panic = "abort"

rust/build.rs

@@ -1,40 +1,48 @@
 /* SPDX-License-Identifier: BSD-3-Clause */
 /* Copyright © 2020 Fragcolor Pte. Ltd. */
 
-#[cfg(feature = "run_bindgen")]
 extern crate bindgen;
+extern crate gfx_build;
+use std::env;
+use std::path::PathBuf;
 
-#[cfg(feature = "run_bindgen")]
-fn bindgen_it() {
+fn generate_shardsc() {
   use std::env::var;
 
-  let shards_dir = var("SHARDS_DIR").unwrap_or("../".to_string());
+  let shards_dir = var("SHARDS_DIR").unwrap_or("..".to_string());
+  let shards_include_dir = format!("{}/include", shards_dir);
+  let src_extra_dir = format!("{}/src/extra", shards_dir);
+  let gfx_path = format!("{}/src/gfx", shards_dir);
 
-  println!("cargo:rustc-link-search={}/build", shards_dir);
-  // Tell cargo to invalidate the built crate whenever the wrapper changes
-  println!("cargo:rerun-if-changed={}/include/shards.h", shards_dir);
+  let main_header_path = format!("{}/rust_interop.hpp", src_extra_dir);
 
-  let header_path = shards_dir + "/include/shards.h";
+  // Tell cargo to regenerate the bindings whenever the headers change
+  println!("cargo:rerun-if-changed={}/shards.h", shards_include_dir);
+  println!("cargo:rerun-if-changed={}", main_header_path);
 
-  let bindings = bindgen::Builder::default()
-    .header(header_path)
+  let builder = gfx_build::setup_bindgen_for_gfx(gfx_path.as_str(), bindgen::Builder::default());
+  let bindings = builder
+    .header(main_header_path)
     .clang_arg("-DSH_NO_ANON")
     .clang_arg("-DSH_USE_ENUMS")
+    .allowlist_type("SH.*")
+    .allowlist_var("SH.*")
+    .allowlist_function("SH.*")
+    .clang_arg(format!("-I{}", shards_include_dir))
+    .clang_arg(format!("-I{}/src", shards_dir))
     .derive_default(true)
     .use_core()
     .generate()
     .expect("Unable to generate bindings");
 
+  let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
   bindings
-    .write_to_file("src/shardsc.rs")
+    .write_to_file(out_path.join("shardsc.rs"))
     .expect("Couldn't write bindings!");
 
   println!("Done processing shards.h");
 }
 
-#[cfg(not(feature = "run_bindgen"))]
-fn bindgen_it() {}
-
 fn main() {
-  bindgen_it();
+  generate_shardsc();
 }

rust/src/lib.rs

@@ -1,6 +1,7 @@
 /* SPDX-License-Identifier: BSD-3-Clause */
 /* Copyright © 2020 Fragcolor Pte. Ltd. */
 
+#![cfg_attr(all(target_os = "windows", target_arch = "x86"), feature(abi_thiscall))]
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]