vh/vtracer

mirror of https://github.com/visioncortex/vtracer.git synced 2026-09-14 08:05:58 -07:00

Files

T

Chris Tsang 749f0df0bd Add nodejs: WebAssembly Node package with no native dependency

New nodejs/ package: a wasm-bindgen crate (vtracer-wasm) built with wasm-pack
that wraps the vtracer framework, plus a thin JS layer for file I/O. Image
decoding (png/jpeg/gif/bmp via the image crate) runs in wasm too, so the
package has zero native dependencies — no sharp, no node-gyp.

No separate general-purpose wasm crate: the Node package directly owns and
wraps the wasm. Excluded from the cargo workspace (wasm-bindgen cdylib), built
with wasm-pack.

JS API (camelCase options): convertBuffer, convertPixels, convertFile,
convertFileSync — each taking an Options object (preset, colorMode,
hierarchical/cutout mosaic, mode, palette, maxColors, optimize, ...). Ships
index.d.ts types and a node smoke test. README updated.

Verified: builds to wasm32-unknown-unknown; `node test.js` passes; output
matches the CLI/Python bindings (253 paths on the tank sample).

2026-07-24 13:08:53 +01:00

1.6 KiB

Raw Blame History

vtracer (Node.js)

Raster → vector (SVG) for Node, a WebAssembly build of the vtracer framework. Image decoding and vectorization both happen in wasm, so there is no native dependency — just npm install.

Install

npm install vtracer

Usage

const vtracer = require('vtracer');

// file in, file out
await vtracer.convertFile('in.png', 'out.svg');
await vtracer.convertFile('in.jpg', 'out.svg', { mode: 'polygon', hierarchical: 'cutout' });

// buffers
const svg = vtracer.convertBuffer(fs.readFileSync('in.png'), { preset: 'poster' });

// raw RGBA8 pixels
const svg2 = vtracer.convertPixels(rgba, width, height, { colorMode: 'bw' });

API

convertBuffer(buffer, options?) => string — encoded image (PNG/JPEG/GIF/BMP) → SVG.
convertPixels(rgba, width, height, options?) => string — raw RGBA8 → SVG.
convertFile(input, output, options?) => Promise<void> — read, trace, write.
convertFileSync(input, output, options?) => void.

`Options` (all optional, camelCase)

preset ("bw" | "poster" | "photo", applied first), colorMode ("color" | "bw"), hierarchical ("stacked" | "cutout" for the seam-free mosaic), mode ("pixel" | "polygon" | "spline"), filterSpeckle, colorPrecision, layerDifference, cornerThreshold, lengthThreshold, maxIterations, spliceThreshold, pathPrecision, palette (list of #rrggbb), maxColors, optimize (0 | 1 | 2).

Build from source

Requires the Rust toolchain and wasm-pack:

npm run build   # wasm-pack build --target nodejs --out-dir pkg
npm test

1.6 KiB Raw Blame History