@tscircuit/pcb-viewer 1.11.397 → 1.11.399

package/README.md

@@ -86,3 +86,40 @@ The PCBViewer component accepts these props:
 - Trace routing
 - DRC (Design Rule Check) visualization
 - Measurement tools
+
+### WebGPU rendering
+
+`PCBViewer` defaults to `renderer="webgpu"`. It uses
+[`circuit-json-webgpu`](https://github.com/tscircuit/circuit-json-webgpu) inside a
+Web Worker with an OffscreenCanvas. Circuit geometry is compiled and uploaded
+once per scene; pan and zoom update the camera and draw retained GPU buffers
+continuously. The main thread handles React, interaction, and view messages.
+There is no bitmap zoom-settle delay or pool of raster workers.
+
+Pass `renderer="canvas"` to explicitly use the existing Canvas renderer. WebGPU
+also falls back to Canvas when WebGPU/OffscreenCanvas is unavailable, initialization
+fails, the GPU device is lost, or the scene includes unsupported geometry (such
+as dimension annotations or interpolated trace routes). The initial GPU geometry compile
+still takes time on large boards, but runs in the worker. Curves use fixed
+triangle tessellation and can show facets at extreme zoom.
+
+Right-click the board and choose **Rendering Engine → Canvas** or
+**WebGPU (experimental)** to switch without resetting pan, zoom, or layer visibility.
+The `renderer` prop sets the initial selection; changing that prop updates the selection.
+Selecting WebGPU still permits automatic Canvas fallback on unsupported devices or scenes.
+
+Run `bun run test:webgpu` after `bunx playwright install chromium` to test the built
+viewer bundle, AM3352 wheel zoom, resize, StrictMode cleanup, context-menu switching,
+and fallbacks. The Cosmos `WebGpuAm3352` fixture also switches between backends.
+
+The WebGPU integration is still experimental. The complete imported Canvas suite
+currently exposes substantial non-text parity gaps, including soldermask, trace
+clipping, and keepouts. See the renderer's
+[full parity report](https://github.com/tscircuit/circuit-json-webgpu/blob/main/tests/parity/latest-report.json).
+The integration PR remains draft until these are resolved; existing diagnostics
+and Canvas fallback do not yet detect every visual mismatch.
+
+The WebGPU renderer is installed as a bundled devDependency from
+`https://jscdn.tscircuit.com/@tscircuit/circuit-json-webgpu/0.0.3.tgz`.
+The renderer repository includes a TypeScript local render command and 597
+SVG-left/WebGPU-right feature snapshot tests.

package/dist/index.d.ts

@@ -74,6 +74,9 @@ interface BoundsSelection {
 type Props = {
     circuitJson?: AnyCircuitElement[];
     height?: number;
+    /** Initial engine; users can switch via the context menu. Prop changes reset it.
+     * WebGPU runs in a worker and falls back to Canvas when unavailable. */
+    renderer?: "webgpu" | "canvas";
     allowEditing?: boolean;
     editEvents?: ManualEditEvent[];
     initialState?: Partial<StateProps>;
@@ -84,7 +87,7 @@ type Props = {
     debugGraphics?: GraphicsObject | null;
     disablePcbGroups?: boolean;
 };
-declare const PCBViewer: ({ circuitJson, debugGraphics, height, initialState, allowEditing, editEvents: editEventsProp, onEditEventsChanged, onBoundsSelected, focusOnHover, clickToInteractEnabled, disablePcbGroups, }: Props) => react_jsx_runtime.JSX.Element;
+declare const PCBViewer: ({ circuitJson, debugGraphics, height, renderer, initialState, allowEditing, editEvents: editEventsProp, onEditEventsChanged, onBoundsSelected, focusOnHover, clickToInteractEnabled, disablePcbGroups, }: Props) => react_jsx_runtime.JSX.Element;
 
 interface CanvasElementsRendererProps {
     elements: AnyCircuitElement[];
@@ -93,10 +96,12 @@ interface CanvasElementsRendererProps {
     setTransform?: (transform: Matrix) => void;
     width?: number;
     height?: number;
+    renderer?: "webgpu" | "canvas";
     grid?: GridConfig;
     allowEditing: boolean;
     focusOnHover?: boolean;
     onBoundsSelected?: (bounds: BoundsSelection) => void;
+    onContextMenuOpenChange?: (open: boolean) => void;
     cancelPanDrag: () => void;
     onCreateEditEvent: (event: ManualEditEvent) => void;
     onModifyEditEvent: (event: Partial<ManualEditEvent>) => void;