Open Plant WSI
WebGL Runtime

Minimal Features, Maximum Throughput for Pathology WSI

Open Plant WSI is a React-first viewer runtime for large pathology slides, designed for tile rendering, immediate point overlays from binary buffers, and deterministic interaction behavior.

M1 Prototype Scope

Current Capabilities

Tile Renderer

WebGL2 tile pipeline with zoom/pan, cache/inflight management, and fallback rendering.

Point Renderer

Accepts pre-parsed typed arrays, term-color palette texture rendering, and ROI clipping.

Draw Layer

`freehand`, `rectangle`, `circular` + `stamp-rectangle-4096px`, persisted outlines, labels, and overlay shapes.

React Surface

`WsiViewerCanvas` unifies tiles, points, drawing, ROI filtering/stats, pointer world callbacks, and rotation state.

Design Principles

1. Visual continuity: keep old tiles visible until next tier is ready.
2. Binary-first data: use typed arrays for immediate GPU upload.
3. Interaction isolation: drawing mode locks pan events deterministically.
4. Compute-ready path: reserve WebGPU for heavy compute stages.

Open-Source Priorities

1. Stable runtime default: production-safe path stays on deterministic worker-based ROI clipping.
2. Experimental lanes: WebGPU features are opt-in until dataset benchmarks prove gains.
3. Documentation first: behavior, defaults, and fallback rules are specified before broader feature expansion.

Recommended Reading Order

  1. Quick Start
  2. ROI Draw
  3. API Reference
  4. Migration Guide
  5. Contributing
  6. Architecture
  7. Deployment