English

简体中文

English

简体中文

Appearance

Quick Start ​

This page only covers how to run the sample that ships with this repository.

For integration, see Integration Overview.

1. Publish the Avalonia Sample ​

Make sure .NET 10 SDK is installed, then run this from the repository root:

Windows win-x64:

bash
dotnet publish ./src/BlenderAvaloniaBridge.Sample/BlenderAvaloniaBridge.Sample.csproj -c Release /p:PublishProfile=aot-win-x64 --configfile ./NuGet.Config

macOS osx-arm64:

bash
dotnet publish ./src/BlenderAvaloniaBridge.Sample/BlenderAvaloniaBridge.Sample.csproj -c Release /p:PublishProfile=aot-osx-arm64 --configfile ./NuGet.Config

The generated bridge folder is created at:

text
artifacts/publish/aot/win-x64/
artifacts/publish/aot/osx-arm64/

Available AOT publish profiles in this repository:

  • aot-win-x64
  • aot-osx-arm64

2. Add the local Blender extension repository ​

Open Blender's extension preferences and use Add Local Repository with this directory:

text
src\blender_extension

Then enable the avalonia_bridge extension from that repository.

3. Point the panel to the bridge program and start it ​

After enabling the extension:

  1. Open View3D > Sidebar > AvaloniaBridgeDemo
  2. Set Avalonia Executable to the executable file of the bridge program you just published
  3. Adjust Display Size, Render Scaling, and Target FPS if needed. Display Size is the logical Avalonia size; Render Scaling controls render density and the Blender overlay display scale; Target FPS defaults to 120.
  4. Click Start UI Bridge

If everything works correctly, the sample UI should appear in the Blender overlay.

After changing size, scaling, or target FPS, restart the bridge. The diagnostics panel shows frame cadence and per-stage timings for capture, transport, GPU upload, and overlay draw.