English

简体中文

English

简体中文

Appearance

Integration Overview ​

If you only want to run the sample included in this repository, start with Quick Start.

Integration boundary ​

A complete integration has two parts:

  • The Avalonia app owns the UI, state, and business logic and runs as the bridge process
  • The Blender addon starts the bridge, draws the overlay, forwards input, and hosts the business channel

Typical integration flow:

  1. Configure BridgeConfig on the Blender side
  2. Update the Avalonia app entry point to support bridge startup
  3. Assemble BridgeController with an optional View3DOverlayHost on the Blender side
  4. Drive tick_once() and handle_event(context, event) from a modal operator

Shared configuration ​

The following values are provided on the Blender-side Python runtime when creating BridgeConfig.

  • executable_path: path to the Avalonia app executable. The Blender side starts the bridge process from this path.
  • window_mode: runtime mode. headless is the compatibility value for offscreen UI and enables frames + input + business; desktop establishes business only.
  • width and height: logical Avalonia window size.
  • render_scaling: render density and Blender overlay display scale used in offscreen UI mode.
  • target_fps: target frame cadence for the bridge process. The default is 120.

executable_path can point to a Debug or Release executable during development. For published builds, use an AOT executable. The path should be visible to the Blender process and match the current platform, such as a Windows .exe or the executable inside a macOS app bundle.

window_mode, width, height, render_scaling, and target_fps affect the Avalonia side through bridge startup parameters.

In offscreen UI mode, width and height remain the logical UI size. render_scaling increases the rendered frame size and the Blender overlay display size, while input coordinates are mapped back to the logical size.

The frame producer runs in the bridge process at target_fps. Blender uses the same target cadence in its modal timer and consumes the latest received frame instead of requesting frames faster from the bridge.

Core vs Sample / Addon ​

  • BlenderAvaloniaBridge.Core and Blender-side avalonia_bridge/core handle bridge infrastructure: process, transport, frame, input, and business
  • BlenderAvaloniaBridge.Sample and the Blender addon shell handle sample UI, configuration assembly, and business code
  • Integration usually does not require changes to either core layer and mainly happens in the Avalonia app layer and Blender addon layer

By side ​