[gui] Metal GGUI support & run metal ggui tests

cmake/TaichiCore.cmake

@@ -349,7 +349,6 @@ if(TI_WITH_PYTHON)
     # This requires refactoring on the python/export_*.cpp as well as better
     # error message on the Python side.
     add_subdirectory(taichi/ui)
-    target_link_libraries(taichi_ui PUBLIC ${CORE_LIBRARY_NAME})
 
     message("PYTHON_LIBRARIES: " ${PYTHON_LIBRARIES})
     set(CORE_WITH_PYBIND_LIBRARY_NAME taichi_python)
@@ -383,7 +382,6 @@ if(TI_WITH_PYTHON)
 
     if(TI_WITH_GGUI)
         target_compile_definitions(${CORE_WITH_PYBIND_LIBRARY_NAME} PRIVATE -DTI_WITH_GGUI)
-        target_link_libraries(${CORE_WITH_PYBIND_LIBRARY_NAME} PRIVATE taichi_ui_vulkan)
     endif()
 
     target_link_libraries(${CORE_WITH_PYBIND_LIBRARY_NAME} PRIVATE taichi_ui)

cpp_examples/rhi_examples/CMakeLists.txt

@@ -1,4 +1,4 @@
-macro(make_sample executable_name src_file)
+macro(make_sample executable_name src_file flags)
 add_executable(${executable_name})
 set_property(TARGET ${executable_name} PROPERTY CXX_STANDARD 17)
 set_property(TARGET ${executable_name} PROPERTY C_STANDARD 17)
@@ -32,8 +32,15 @@ target_link_libraries(${executable_name} taichi_core glfw)
 if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
   target_link_libraries(${executable_name} "-framework QuartzCore")
 endif()
+target_compile_definitions(${executable_name} PRIVATE ${flags})
 endmacro()
 
-make_sample(sample_1_window sample_1_window.cpp)
-make_sample(sample_2_triangle sample_2_triangle.cpp)
-make_sample(sample_3_textured_triangle sample_3_textured_triangle.cpp)
+if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
+  set(RHI_EXAMPLE_FLAGS "RHI_EXAMPLE_BACKEND_METAL")
+else()
+  set(RHI_EXAMPLE_FLAGS "RHI_EXAMPLE_BACKEND_VULKAN")
+endif()
+
+make_sample(sample_1_window sample_1_window.cpp ${RHI_EXAMPLE_FLAGS})
+make_sample(sample_2_triangle sample_2_triangle.cpp ${RHI_EXAMPLE_FLAGS})
+make_sample(sample_3_textured_triangle sample_3_textured_triangle.cpp ${RHI_EXAMPLE_FLAGS})

cpp_examples/rhi_examples/common_metal.h

@@ -6,29 +6,6 @@
 #import <GLFW/glfw3native.h>
 #include "glm/glm.hpp"
 
-#if defined(__APPLE__) && defined(__OBJC__)
-#import <Metal/Metal.h>
-#import <QuartzCore/QuartzCore.h>
-#define DEFINE_METAL_ID_TYPE(x) typedef id<x> x##_id;
-#else
-#define DEFINE_METAL_ID_TYPE(x) typedef struct x##_t *x##_id;
-#endif
-
-DEFINE_METAL_ID_TYPE(MTLDevice);
-DEFINE_METAL_ID_TYPE(MTLBuffer);
-DEFINE_METAL_ID_TYPE(MTLTexture);
-DEFINE_METAL_ID_TYPE(MTLSamplerState);
-DEFINE_METAL_ID_TYPE(MTLLibrary);
-DEFINE_METAL_ID_TYPE(MTLFunction);
-DEFINE_METAL_ID_TYPE(MTLComputePipelineState);
-DEFINE_METAL_ID_TYPE(MTLCommandQueue);
-DEFINE_METAL_ID_TYPE(MTLCommandBuffer);
-DEFINE_METAL_ID_TYPE(MTLBlitCommandEncoder);
-DEFINE_METAL_ID_TYPE(MTLComputeCommandEncoder);
-DEFINE_METAL_ID_TYPE(CAMetalDrawable);
-
-#undef DEFINE_METAL_ID_TYPE
-
 #include "taichi/rhi/metal/metal_api.h"
 #include "taichi/rhi/metal/metal_device.h"
 

cpp_examples/rhi_examples/common_metal.mm

@@ -1,7 +1,6 @@
 #include "common_metal.h"
 
 #include <assert.h>
-#import <simd/simd.h>
 #include <stdio.h>
 #include <stdlib.h>
 

cpp_examples/rhi_examples/sample_1_window.cpp

@@ -1,5 +1,10 @@
+#ifdef RHI_EXAMPLE_BACKEND_VULKAN
 #include "common_vulkan.h"
-// #include "common_metal.h"
+#endif  // RHI_EXAMPLE_BACKEND_VULKAN
+
+#ifdef RHI_EXAMPLE_BACKEND_METAL
+#include "common_metal.h"
+#endif
 
 class SampleApp : public App {
  public:

cpp_examples/rhi_examples/sample_2_triangle.cpp

@@ -1,5 +1,10 @@
-// #include "common_vulkan.h"
+#ifdef RHI_EXAMPLE_BACKEND_VULKAN
+#include "common_vulkan.h"
+#endif  // RHI_EXAMPLE_BACKEND_VULKAN
+
+#ifdef RHI_EXAMPLE_BACKEND_METAL
 #include "common_metal.h"
+#endif
 
 std::vector<uint32_t> frag_spv =
 #include "shaders/2_triangle.frag.spv.h"

cpp_examples/rhi_examples/sample_3_textured_triangle.cpp

@@ -1,5 +1,10 @@
-// #include "common_vulkan.h"
+#ifdef RHI_EXAMPLE_BACKEND_VULKAN
+#include "common_vulkan.h"
+#endif  // RHI_EXAMPLE_BACKEND_VULKAN
+
+#ifdef RHI_EXAMPLE_BACKEND_METAL
 #include "common_metal.h"
+#endif
 
 std::vector<uint32_t> frag_spv =
 #include "shaders/3_triangle.frag.spv.h"
@@ -104,7 +109,7 @@ class SampleApp : public App {
     {
       constexpr uint32_t tex_size = 256;
 
-      // Just a little 8 bit, 256x256 voronoi texture
+      // Just a little 8 bit, 256x256 worley texture
       std::vector<std::pair<double, double>> random_points;
       for (int i = 0; i < 100; i++) {
         double x = tex_size * static_cast<double>(std::rand()) / RAND_MAX;

python/taichi/examples/ggui_examples/mass_spring_game_ggui.py

@@ -1,7 +1,7 @@
 import taichi as ti
 
-arch = ti.vulkan if ti._lib.core.with_vulkan() else ti.cuda
-ti.init(arch=arch)
+# arch = ti.vulkan if ti._lib.core.with_vulkan() else ti.cuda
+ti.init(arch=ti.metal)
 
 spring_Y = ti.field(dtype=ti.f32, shape=())  # Young's modulus
 paused = ti.field(dtype=ti.i32, shape=())

python/taichi/examples/ggui_examples/mpm3d_ggui.py

@@ -2,8 +2,7 @@
 
 import taichi as ti
 
-arch = ti.vulkan if ti._lib.core.with_vulkan() else ti.cuda
-ti.init(arch=arch)
+ti.init(arch=ti.gpu)
 
 # dim, n_grid, steps, dt = 2, 128, 20, 2e-4
 # dim, n_grid, steps, dt = 2, 256, 32, 1e-4

python/taichi/shaders/SetImage_vk.frag

@@ -7,12 +7,15 @@ layout(location = 0) in vec2 frag_texcoord;
 layout(location = 0) out vec4 out_color;
 
 layout(binding = 1) uniform UBO {
+  vec2 lower_bound;
+  vec2 upper_bound;
   float x_factor;
   float y_factor;
   int is_transposed;
 } ubo;
 
 void main() {
   vec2 coord = frag_texcoord * vec2(ubo.x_factor,ubo.y_factor);
-  out_color = texture(texSampler, ubo.is_transposed != 0 ? coord.yx : coord);
+  coord = clamp(coord, ubo.lower_bound, ubo.upper_bound);
+  out_color = textureLod(texSampler, ubo.is_transposed != 0 ? coord.yx : coord, 0);
 }

python/taichi/tools/image.py

@@ -3,6 +3,8 @@
 
 import taichi as ti
 
+import ctypes
+
 
 def cook_image_to_bytes(img):
     """
@@ -16,7 +18,7 @@ def cook_image_to_bytes(img):
     if img.dtype in [np.uint16, np.uint32, np.uint64]:
         img = (img // (np.iinfo(img.dtype).max // 256)).astype(np.uint8)
     elif img.dtype in [np.float32, np.float64]:
-        img = (np.clip(img, 0, 1) * 255.0 + 0.5).astype(np.uint8)
+        img = (np.clip(img, 0, 1) * 255.0).astype(np.uint8)
     elif img.dtype != np.uint8:
         raise ValueError(f"Data type {img.dtype} not supported in ti.tools.imwrite")
 
@@ -81,11 +83,10 @@ def imread(filename, channels=0):
         np.ndarray : An output image loaded from given filename.
     """
     ptr, resx, resy, comp = _ti_core.imread(filename, channels)
-    img = np.ndarray(shape=(resy, resx, comp), dtype=np.uint8)
-    img = np.ascontiguousarray(img)
-    # TODO(archibate): Figure out how np.ndarray constructor works and replace:
-    _ti_core.C_memcpy(img.ctypes.data, ptr, resx * resy * comp)
-    # Discussion: https://github.com/taichi-dev/taichi/issues/802
+    img = np.copy(np.ctypeslib.as_array((ctypes.c_uint8 * resx * resy * comp).from_address(ptr))).reshape(
+        resy, resx, comp
+    )
+    _ti_core.imfree(ptr)
     return img.swapaxes(0, 1)[:, ::-1, :]
 
 

taichi/python/export_ggui.cpp

@@ -13,11 +13,11 @@ namespace py = pybind11;
 
 #include "taichi/ui/utils/utils.h"
 #include "taichi/ui/common/window_base.h"
-#include "taichi/ui/backends/vulkan/window.h"
+#include "taichi/ui/ggui/window.h"
 #include "taichi/ui/common/canvas_base.h"
 #include "taichi/ui/common/camera.h"
-#include "taichi/ui/backends/vulkan/canvas.h"
-#include "taichi/ui/backends/vulkan/scene.h"
+#include "taichi/ui/ggui/canvas.h"
+#include "taichi/ui/ggui/scene.h"
 #include "taichi/rhi/vulkan/vulkan_loader.h"
 #include "taichi/rhi/arch.h"
 #include "taichi/program/field_info.h"
@@ -521,6 +521,19 @@ struct PyWindow {
            double fps_limit,
            std::string package_path,
            Arch ti_arch) {
+    Arch ggui_arch = Arch::vulkan;
+
+    if (ti_arch == Arch::metal) {
+      ggui_arch = Arch::metal;
+    }
+
+    if (ggui_arch == Arch::vulkan) {
+      // Verify vulkan available
+      if (!lang::vulkan::is_vulkan_api_available()) {
+        throw std::runtime_error("Vulkan must be available for GGUI");
+      }
+    }
+
     AppConfig config = {name,
                         res[0].cast<int>(),
                         res[1].cast<int>(),
@@ -530,10 +543,9 @@ struct PyWindow {
                         show_window,
                         fps_limit,
                         package_path,
-                        ti_arch};
-    if (!lang::vulkan::is_vulkan_api_available()) {
-      throw std::runtime_error("Vulkan must be available for GGUI");
-    }
+                        ti_arch,
+                        ggui_arch};
+
     window = std::make_unique<vulkan::Window>(prog, config);
   }
 

taichi/python/export_visual.cpp

@@ -110,10 +110,7 @@ void export_visual(py::module &m) {
            py::return_value_policy::reference);
   m.def("imwrite", &imwrite);
   m.def("imread", &imread);
-  // TODO(archibate): See misc/image.py
-  m.def("C_memcpy", [](size_t dst, size_t src, size_t size) {
-    std::memcpy((void *)dst, (void *)src, size);
-  });
+  m.def("imfree", &imfree);
 }
 
 }  // namespace taichi

taichi/rhi/common/window_system.h

@@ -2,6 +2,10 @@
 
 #ifdef TI_WITH_GLFW
 #include "GLFW/glfw3.h"
+#ifdef TI_WITH_METAL
+#define GLFW_EXPOSE_NATIVE_COCOA
+#import <GLFW/glfw3native.h>
+#endif
 #endif  // TI_WITH_GLFW
 
 namespace taichi::lang::window_system {

taichi/rhi/impl_support.h

@@ -179,5 +179,16 @@ inline void hash_combine(std::size_t &seed, const T &v) {
   seed ^= hasher(v) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
 }
 
+// A helper to remove copy constructor
+class NonAssignable {
+ private:
+  NonAssignable(NonAssignable const &);
+  NonAssignable &operator=(NonAssignable const &);
+
+ public:
+  NonAssignable() {
+  }
+};
+
 }  // namespace rhi_impl
 }  // namespace taichi::lang