feat: add macOS (arm64) support using GLFW + OpenGL3 backend

- vcpkg.json: add imgui (opengl3-binding, glfw-binding) and glfw3 for osx platform
- grey/CMakeLists.txt: find OpenGL and GLFW3 on macOS (change UNIX AND NOT APPLE to UNIX)
- demo/desktop/CMakeLists.txt: make WIN32 flag, main.rc and dpi-aware.manifest Windows-only
- demo/pure/CMakeLists.txt: enable pure GLFW demo to build on macOS
- CMakePresets.json: add macos-debug preset
- .github/workflows/build.yml: add macOS arm64 to build-native and build-demo-apps matrices with screencapture screenshot support
- dotnet/Grey/Grey.csproj: include libxgrey.dylib for osx-arm64 in NuGet package
- docs/README.md: update platform support and add macOS build instructions

Agent-Logs-Url: https://github.com/aloneguid/grey/sessions/adfb7d00-a048-46cf-a0f3-0acead8788b0

Co-authored-by: aloneguid <3155189+aloneguid@users.noreply.github.com>

Author: Copilot

.github/workflows/build.yml

@@ -38,6 +38,12 @@ jobs:
             vcpkg_triplet: x64-linux
             vcpkg_config: MinSizeRel
             dotnet_rid: linux-x64
+          - os: macos-latest
+            name: macOS arm64
+            arch: arm64
+            vcpkg_triplet: arm64-osx
+            vcpkg_config: MinSizeRel
+            dotnet_rid: osx-arm64
 
       fail-fast: false
     name: 'build: ${{ matrix.name }}'
@@ -179,6 +185,12 @@ jobs:
             vcpkg_triplet: x64-linux
             vcpkg_config: MinSizeRel
             dotnet_rid: linux-x64
+          - os: macos-latest
+            name: macOS arm64
+            arch: arm64
+            vcpkg_triplet: arm64-osx
+            vcpkg_config: MinSizeRel
+            dotnet_rid: osx-arm64
 
       fail-fast: false
     name: 'demo app: ${{ matrix.name }}'
@@ -249,6 +261,27 @@ jobs:
           # Kill the app
           kill $APP_PID || true
           
+      - name: Run app and capture screenshot (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          # Run the app in background
+          chmod +x dotnet/ConsoleDemo/bin/Release/net10.0/${{ matrix.dotnet_rid }}/publish/ConsoleDemo
+          dotnet/ConsoleDemo/bin/Release/net10.0/${{ matrix.dotnet_rid }}/publish/ConsoleDemo 2>&1 | tee app.log &
+          APP_PID=$!
+
+          # Wait for app to render
+          sleep 5
+
+          # Capture screenshot using macOS built-in screencapture
+          mkdir -p screenshots
+          screencapture -x screenshots/demo-${{ matrix.dotnet_rid }}.png
+
+          # Show app logs
+          cat app.log || true
+
+          # Kill the app
+          kill $APP_PID || true
+
       - name: Run app and capture screenshot (Windows)
         if: runner.os == 'Windows'
         shell: pwsh

CMakePresets.json

@@ -66,6 +66,25 @@
                     "sourceDir": "$env{HOME}/.vs/$ms{projectDirName}"
                 }
             }
+        },
+        {
+            "name": "macos-debug",
+            "displayName": "macOS Debug",
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/out/build/${presetName}",
+            "installDir": "${sourceDir}/out/install/${presetName}",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug",
+                "CMAKE_TOOLCHAIN_FILE": {
+                    "value": "$env{HOME}/vcpkg/scripts/buildsystems/vcpkg.cmake",
+                    "type": "FILEPATH"
+                }
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            }
         }
     ]
 }

demo/desktop/CMakeLists.txt

@@ -2,7 +2,11 @@
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-add_executable (demo WIN32 "main.cpp" main.rc)
+if(WIN32)
+    add_executable (demo WIN32 "main.cpp" main.rc)
+else()
+    add_executable (demo "main.cpp")
+endif()
 
 if(WIN32)
     # "Transparent" demo for Windows
@@ -22,4 +26,6 @@ target_compile_definitions(demo PRIVATE GREY_INCLUDE_IMNODES)
 target_link_libraries(demo libgrey)
 target_include_directories(demo PRIVATE "../../grey")
 
-target_sources(demo PRIVATE dpi-aware.manifest)
+if(WIN32)
+    target_sources(demo PRIVATE dpi-aware.manifest)
+endif()

demo/pure/CMakeLists.txt

@@ -15,8 +15,8 @@ if (WIN32)
     target_link_libraries(${APP_NAME} PRIVATE D3D11.lib imgui::imgui)
 endif()
 
-# Check if we are building on Linux
-if (UNIX AND NOT APPLE)
+# Check if we are building on Linux or macOS
+if (UNIX)
     # sudo apt install libxinerama-dev libxcursor-dev xorg-dev libglu1-mesa-dev pkg-config
 
     find_package(OpenGL REQUIRED)

docs/README.md

@@ -10,15 +10,15 @@ It's based on the awesome [ImGui](https://github.com/ocornut/imgui) framework an
 
 ## Features
 
-- Cross-platform - currently supports **Windows x64** and **Linux x64**.
+- Cross-platform - currently supports **Windows x64**, **Linux x64**, and **macOS arm64**.
 - Completely stateless i.e., no widgets, state synchronization and so on.
 - Looks beautiful by default i.e., renders in high DPI, using system fonts and colours, supports themes and material icons.
 
 ## Getting started
 
 To get started in C++, simply include this repository as a git submodule and follow the examples. For a real-life, production sample, check out [bt](https://github.com/aloneguid/bt).
 
-To get started in C#, reference [GreyMatter](https://www.nuget.org/packages/GreyMatter/) package, which includes C# interface and pre-built binaries for Windows and Linux.
+To get started in C#, reference [GreyMatter](https://www.nuget.org/packages/GreyMatter/) package, which includes C# interface and pre-built binaries for Windows, Linux, and macOS.
 
 # Roadmap
 - Markdown component support.
@@ -40,4 +40,21 @@ To build native part on Linux or WSL2, you need:
 
 ### MacOSX
 
-I currently do not pay Apple tax, but instructions should be similar to Linux. If you want to help with MacOSX support, please open an issue. Supporting MacOSX should resort to testing Metal rendering backend and some native OS integrations around windowing.
+To build native part on macOS, you need:
+- [vcpkg](https://learn.microsoft.com/en-gb/vcpkg/get_started/get-started?pivots=shell-bash).
+- CMake. `brew install cmake`.
+- Build tools (Xcode Command Line Tools). `xcode-select --install`.
+- Ninja build system. `brew install ninja`.
+
+Once the prerequisites are installed, clone the repository and build:
+
+```bash
+git clone --recursive https://github.com/aloneguid/grey
+cd grey
+cmake -B build -S . -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_TOOLCHAIN_FILE=$HOME/vcpkg/scripts/buildsystems/vcpkg.cmake \
+  -DVCPKG_TARGET_TRIPLET=arm64-osx
+cmake --build build --config Release
+```
+
+The library uses the **GLFW + OpenGL3** backend on macOS (the same as Linux), which is fully supported and requires no extra runtime dependencies. All required libraries are statically linked via vcpkg.

dotnet/Grey/Grey.csproj

@@ -46,6 +46,11 @@
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
         </Content>
 
+        <!-- macOS arm64 -->
+        <Content Include="..\..\xbin\runtimes\osx-arm64\native\libxgrey.dylib" Link="libxgrey.dylib" PackagePath="runtimes/osx-arm64/native">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </Content>
+
     </ItemGroup>
 
     <ItemGroup>

grey/CMakeLists.txt

@@ -6,10 +6,10 @@ set (DYNAMIC_NAME xgrey)
 find_package(imgui CONFIG REQUIRED)
 find_package(implot CONFIG REQUIRED)
 
-if(UNIX AND NOT APPLE)
+if(UNIX)
     find_package(OpenGL REQUIRED)
     find_package(glfw3 CONFIG REQUIRED)
- endif()
+endif()
 
 find_path(STB_INCLUDE_DIRS "stb.h")
 

vcpkg.json

@@ -20,10 +20,23 @@
             ],
             "platform": "linux"
         },
+        {
+            "name": "imgui",
+            "features": [
+                "opengl3-binding",
+                "glfw-binding",
+                "docking-experimental"
+            ],
+            "platform": "osx"
+        },
         {
             "name": "glfw3",
             "platform": "linux"
         },
+        {
+            "name": "glfw3",
+            "platform": "osx"
+        },
         "implot"
     ]
 }