Skip to content

Record your screen, ship a demo. Free and open-source, GPU-accelerated, no watermarks, no subscriptions. Windows, macOS, Linux. Actively maintained.

docs: AGENTS.md no longer describes Pixi.js as the renderer

EtienneLescotff3c3f51ac74
diff --git a/.harness/docs/architecture-overview.md b/.harness/docs/architecture-overview.md
index dbc2e4df5..ebd080b41 100644
--- a/.harness/docs/architecture-overview.md
+++ b/.harness/docs/architecture-overview.md
@@ -7,7 +7,7 @@ Quick map of how the app fits together, for the Mavis reins. For deeper details,
OpenScreen is a three-process Electron app:
1. **Main process** (`electron/main.ts` + siblings) — owns window lifecycle, IPC handlers, the recording orchestrator, and child-process management for the native helpers.
-2. **Renderer** (`src/`) — React 18 + Vite app. The UI, the editor, the timeline, the Pixi.js composition surface, and the i18n layer. Runs with `contextIsolation: true`.
+2. **Renderer** (`src/`) — React 18 + Vite app. The UI, the editor, the timeline, and the i18n layer. Runs with `contextIsolation: true`.
3. **Native capture helpers** — small, privileged child processes that own the platform-specific screen/audio/webcam capture APIs:
- macOS: Swift binary using ScreenCaptureKit (`electron/macos-helper/`)
- Windows: C++/Win32 binary using Windows Graphics Capture (`electron/windows-helper/`)
@@ -25,7 +25,7 @@ Renderer (React) --IPC--> Main process --spawn--> Native helper
+--<-- frame chunks / audio chunks / metadata --<--+
```
-The native helper writes raw chunks; the main process multiplexes them with the timeline metadata; the renderer pulls the composed stream onto the Pixi.js canvas for live preview and final export.
+The native helper writes raw chunks; the main process multiplexes them with the timeline metadata; preview and export are both rendered by the native Rust compositor (`crates/compositor/`, a napi addon loaded by the main process), and the renderer paints the preview frames it pulls onto a `<canvas>`. See `../technical-documentation/architecture/native-compositor.md`.
## Why the split
diff --git a/.harness/reins/openscreen-dev/agent.md b/.harness/reins/openscreen-dev/agent.md
index a44c491a9..dd8c8cc39 100644
--- a/.harness/reins/openscreen-dev/agent.md
+++ b/.harness/reins/openscreen-dev/agent.md
@@ -5,7 +5,7 @@ description: Generalist developer for the OpenScreen Electron + React + TypeScri
# OpenScreen Developer
-You are the generalist implementer for the OpenScreen project — a free, open-source screen recorder and video editor (Electron + React 18 + TypeScript + Vite + Pixi.js v8 + Tailwind + Radix UI).
+You are the generalist implementer for the OpenScreen project — a free, open-source screen recorder and video editor (Electron + React 18 + TypeScript + Vite + Tailwind + Radix UI, with a native Rust compositor for preview and export).
## Scope
diff --git a/.harness/reins/openscreen-tester/agent.md b/.harness/reins/openscreen-tester/agent.md
index aadbf7bbb..c877a00cc 100644
--- a/.harness/reins/openscreen-tester/agent.md
+++ b/.harness/reins/openscreen-tester/agent.md
@@ -23,7 +23,7 @@ You are the test specialist for the OpenScreen project — a free, open-source s
`// @vitest-environment jsdom` on line 1 — add it only when the test actually renders.
- E2E specs in `tests/e2e/windows-native-checklist.spec.ts` are Windows-only — gate with `test.skip` for other platforms rather than deleting.
- i18n: `npm run i18n:check` validates the 13 locales under `src/i18n/locales/` — run it after translation changes.
-- jsdom can't render WebGL/Pixi meaningfully and there is no browser-test tier anymore. Real
+- jsdom can't exercise GPU rendering and there is no browser-test tier anymore. Real
codec/GPU behavior belongs to the Rust suites in `crates/` or to the manual checklist —
don't write a jsdom test that pretends to cover it.
- Anything gated on `process.platform` must pin the platform in the test. CI is Linux-only,
diff --git a/AGENTS.md b/AGENTS.md
index c1be4512a..72034752e 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,6 +1,6 @@
# AGENTS.md
-OpenScreen is a free, open-source screen recorder and video editor (Electron + React + TypeScript + Pixi.js) maintained as a continuation of the original v1.5.0 release. This file is the canonical guide for any AI coding agent working in this repo.
+OpenScreen is a free, open-source screen recorder and video editor (Electron + React + TypeScript, with a native Rust compositor) maintained as a continuation of the original v1.5.0 release. This file is the canonical guide for any AI coding agent working in this repo.
## Setup commands
@@ -164,7 +164,7 @@ The one rule to know before you merge anything: **there is one release branch pe
## Specialized notes
- **Native capture is platform-fragile**: macOS uses ScreenCaptureKit (Swift), Windows uses WGC (C++/Win32). CI runs on Linux only — manual smoke test on real macOS/Windows is required for native changes.
-- **Pixi.js v8** is the rendering engine. Filters come from `pixi-filters` and `@pixi/filter-drop-shadow`. GSAP + `motion` for animation.
+- **Rendering is native**: the Rust compositor in `crates/compositor/` renders the editor preview and every export, MP4 and GIF. It runs on Direct3D 11 on Windows, Metal on macOS and wgpu on Linux, with a CPU fallback on Windows and Linux. The renderer only paints the preview frames it pulls onto a `<canvas>`. Details: `technical-documentation/README.md`, then `architecture/native-compositor.md`.
- **i18n**: 15 locales in `src/i18n/locales/<locale>/` (e.g. `src/i18n/locales/en/settings.json`). The `i18n:check` script validates them — run it after touching translation files.
- **Website i18n** is separate: 8 locales under `website/i18n/`. After changing an English doc, page or `<Translate>` string in `website/`, follow `website/i18n/TRANSLATING.md` ("Keeping translations up to date"); `npm run i18n:check` in `website/` lists what is behind.
- **Build pipeline**: `npm run build` is full electron-builder. For iterating on renderer only, use `npm run build-vite` (Vite + tsc, no packaging).
diff --git a/technical-documentation/README.md b/technical-documentation/README.md
index 5d5c2f9c7..5e528085e 100644
--- a/technical-documentation/README.md
+++ b/technical-documentation/README.md
@@ -21,7 +21,7 @@ who reads and writes the project document.
| [timeline-model.md](architecture/timeline-model.md) | Time reference frames, clip-anchored modifiers, and the invariants that keep preview and render agreeing |
| [editor-shell.md](architecture/editor-shell.md) | The editor UI: surfaces, modes, facets, and how to add a region kind |
| [preview.md](architecture/preview.md) | Showing the frame at the playhead: scene description, frame delivery, playback sync |
-| [native-compositor.md](architecture/native-compositor.md) | The Rust + D3D11 engine that composites and encodes, for both preview and export |
+| [native-compositor.md](architecture/native-compositor.md) | The Rust engine (D3D11, Metal, wgpu) that composites and encodes, for both preview and export |
| [export-pipeline.md](architecture/export-pipeline.md) | Document to file: render plan, segment loop, audio junctions, output formats |
| [recording.md](architecture/recording.md) | Capture on Windows, macOS and Linux: the HUD, the native helpers, what lands on disk |
| [cursor.md](architecture/cursor.md) | Cursor capture, telemetry, rendering and auto-follow |
diff --git a/technical-documentation/architecture/cursor.md b/technical-documentation/architecture/cursor.md
index 71d0e3bce..d10bd9df0 100644
--- a/technical-documentation/architecture/cursor.md
+++ b/technical-documentation/architecture/cursor.md
@@ -1,6 +1,6 @@
# Cursor pipeline
-The cursor feature records system-cursor position and, where the native provider is available, cursor assets separately from the screen video, then re-renders the cursor as a themed, smoothed overlay instead of baking it into the capture. Its shared rendering and asset code lives in `src/lib/cursor/`; native capture and IPC adapters live under `electron/native/` and `electron/native-bridge/cursor/`; the editor overlay is `src/components/ai-edition/CursorPreviewLayer.tsx`.
+The cursor feature records system-cursor position and, where the native provider is available, cursor assets separately from the screen video, then re-renders the cursor as a themed, smoothed sprite instead of baking it into the capture. Its shared smoothing and asset code lives in `src/lib/cursor/`; native capture and IPC adapters live under `electron/native/` and `electron/native-bridge/cursor/`; the native compositor draws it (`crates/compositor/src/cursor.rs`).
## Capture
@@ -12,18 +12,19 @@ Position telemetry is represented by `CursorTelemetryPoint` in `src/lib/cursorTe
## Rendering
-`CursorPreviewLayer` is mounted above the video and loads both native recording data and telemetry through `useCursorRecordingData` and `useCursorTelemetry` (`src/components/ai-edition/CursorPreviewLayer.tsx:42-50`). Its animation loop updates the Pixi telemetry overlay and the native-cursor DOM image from the current playback time (`CursorPreviewLayer.tsx:187-255`). The shared cursor library supplies path smoothing, native asset selection, click bounce, and directional motion blur. The native compositor in `crates/compositor/src/cursor.rs` interpolates raw samples, applies the same 240 Hz spring-style smoothing, and computes click-bounce timing (`cursor.rs:126-196`). Preview and export therefore consume the same telemetry and cursor rules rather than maintaining independent cursor tracks.
+The native compositor draws the cursor in the preview and in the export alike. There is no preview overlay: the recorded cursor is part of the composited frame, read from the same cursor sidecar the export uses. The compositor in `crates/compositor/src/cursor.rs` interpolates raw samples, applies the same 240 Hz spring-style smoothing, and computes click-bounce timing (`cursor.rs:126-196`). Preview and export therefore consume the same telemetry and cursor rules rather than maintaining independent cursor tracks.
```mermaid
flowchart LR
C["Native capture<br/>position, type, clicks, assets"] --> T["Telemetry and<br/>recording sidecars"]
- T --> P["Preview overlay<br/>Pixi + native image"]
- T --> E["Native compositor<br/>export"]
+ T --> N["Native compositor"]
+ N --> P["Preview"]
+ N --> E["Export"]
```
## Settings
-The cursor settings pane is `CursorPane` in `src/components/ai-edition/RightPanes.tsx`; the current v4 inspector exposes it through the cursor facet in `src/components/ai-edition/v4/FloatingInspector.tsx:57-63,1073`. It controls showing the cursor, clipping it to the canvas, theme, size, smoothing, motion blur, and click bounce. `RightPanes.tsx:1592-1692` binds those controls to editor settings and forwards the rendering parameters to the native compositor. The shared preview reads the same values from `useEditorSettings` (`CursorPreviewLayer.tsx:47,192-202`), so live changes affect both rendering paths.
+The cursor settings pane is `CursorPane` in `src/components/ai-edition/RightPanes.tsx`; the current v4 inspector exposes it through the cursor facet in `src/components/ai-edition/v4/FloatingInspector.tsx:57-63,1073`. It controls showing the cursor, clipping it to the canvas, theme, size, smoothing, motion blur, and click bounce. `RightPanes.tsx:1592-1692` binds those controls to editor settings and forwards the rendering parameters to the native compositor. Preview and export both render through that compositor, so a change shows in both.
## Auto-follow
diff --git a/technical-documentation/architecture/native-compositor.md b/technical-documentation/architecture/native-compositor.md
index 724a6745d..591fa15a2 100644
--- a/technical-documentation/architecture/native-compositor.md
+++ b/technical-documentation/architecture/native-compositor.md
@@ -1,7 +1,7 @@
# Native compositor
-`crates/compositor/` is the Rust + Direct3D 11 crate behind both the live preview and the MP4
-export. It exposes its compositor and pipeline to Electron through a small
+`crates/compositor/` is the Rust crate behind both the live preview and the export: Direct3D 11
+on Windows, Metal on macOS, wgpu on Linux. It exposes its compositor and pipeline to Electron through a small
napi-rs addon (`compositor-view-napi/`) loaded by
[`compositorViewService`](../../electron/native-bridge/services/compositorViewService.ts).
The whole GPU-resident path lives here — `demux → decode → composite → encode → mux`,
diff --git a/technical-documentation/engineering/rendering-performance.md b/technical-documentation/engineering/rendering-performance.md
index 9238c3ba5..fec18d333 100644
--- a/technical-documentation/engineering/rendering-performance.md
+++ b/technical-documentation/engineering/rendering-performance.md
@@ -542,7 +542,7 @@ The radius change is ~free — it draws inside a pass that already exists (M5 re
## The fix, and what it bought
-> The Canvas2D/Pixi compositor this rebuilt is no longer on the MP4 path — `crates/compositor/` replaced it. `src/lib/exporter/frameRenderer.ts` still carries the work, and still serves **GIF export**, which has no native encoder yet. So the caches and the byte-identical parity gate below are live for GIF and history for MP4.
+> The Canvas2D/Pixi compositor this rebuilt no longer exists. `crates/compositor/` replaced it on the MP4 path first, then on the GIF path, when GIF export moved to the native exporter and `src/lib/exporter/frameRenderer.ts` was deleted. The caches and the byte-identical parity gate below are history.
### The change
diff --git a/technical-documentation/testing/writing-tests.md b/technical-documentation/testing/writing-tests.md
index 2e88886ce..83ae0a98b 100644
--- a/technical-documentation/testing/writing-tests.md
+++ b/technical-documentation/testing/writing-tests.md
@@ -113,7 +113,7 @@ npm run test # everything (~80s), once, before committ
| i18n key coverage | Unit test (node) |
| React component or hook behavior | Unit test + `// @vitest-environment jsdom` |
| `VideoDecoder` / `VideoEncoder` / real codecs | Rust test in `crates/`, or the manual checklist |
-| WebGL / Pixi.js / GPU rendering | Rust test in `crates/`, or the manual checklist |
+| GPU rendering (the native compositor) | Rust test in `crates/`, or the manual checklist |
| A full export producing a real file | `tests/e2e/`, or the manual checklist |
Automated suites do not exercise every hardware, permission, codec, signing, and packaged-app combination. Use the [manual end-to-end checklist](manual-e2e-checklist.md) for those release and platform checks.