@omnidraw/cangine

Renderer-neutral infinite-canvas engine with a retained serializable scene, WebGL2 rendering, geometry and indexed picking, normalized input, text and resources, HTML portals, SVG export, animation, optional embedded 3D, and application-owned transient overlays.

npm install @omnidraw/[email protected]

import {
  createInfiniteCanvas,
  IDENTITY_TRANSFORM_2D,
} from "@omnidraw/cangine";

const engine = await createInfiniteCanvas({
  host: document.querySelector("#canvas") as HTMLElement,
  renderProfile: {
    vector2D: "webgl2",
    threeD: "disabled",
    portals: "disabled",
  },
});

engine.scene.transaction((tx) => {
  tx.upsert({
    id: "content",
    kind: "layer",
    parentId: null,
    orderKey: "A",
    transform: IDENTITY_TRANSFORM_2D,
    role: "content",
    coordinateSpace: "world",
  });
});

Current package entrypoints are:

• @omnidraw/cangine
• @omnidraw/cangine/types
• @omnidraw/cangine/geometry
• @omnidraw/cangine/testing
• @omnidraw/cangine/backend
• @omnidraw/cangine/scene (renderer-free serialized-command reducer)
• @omnidraw/cangine/editor (optional framework-neutral editor kernel)
• @omnidraw/cangine/package.json (installed package metadata)

Deep imports are unsupported. The renderer core does not own application persistence, collaboration, history, tool policy, or widget business logic. The optional editor entrypoint provides replaceable tool, command, selection, and opt-in linear-history policy without changing that core boundary. It also accepts host-resolved concrete runtime appearance, guarded standard- creation appearance decorators, and extension-only selection-style mutation decorators. Cangine does not own themes, CSS variables, or product color semantics.

The root does not re-export /scene or /editor. The /scene entrypoint applies Cangine's serialized-command semantics to opaque immutable reduction state without constructing an engine or renderer. Reduction-state handles are not structured cloneable or transferable: send sceneReductionStateSnapshot(state) across a worker/message boundary and call createSceneReductionState() inside the destination runtime. The entrypoint itself is DOM-free and can run in a worker.

The package is standards-compliant ESM with TypeScript declarations. It supports Node 20.19.0 or newer and Bun 1.3.14 or newer.

The package follows semver. Until 1.0.0, breaking public API changes increment the minor version and compatible changes increment the patch version. The public API version and scene snapshot schema version are independent.

For complete consumer documentation, see the included library-guide.md.