@amigo-labs/pincel-wasm 1.5.0 → 1.6.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@amigo-labs/pincel-wasm",
   "type": "module",
   "description": "WebAssembly bindings for the Pincel core (wasm-bindgen / wasm-pack target)",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",

package/pincel_wasm.d.ts

@@ -1243,6 +1243,12 @@ export class Document {
      * follow-up).
      */
     undo(): boolean;
+    /**
+     * A [`Vectorizer`] over `frame` composed like
+     * [`exportPng`](Document::export_png): zoom 1, visible layers, no onion
+     * skin, no overlays.
+     */
+    vectorizer(frame: number): Vectorizer;
     /**
      * Frame the UI is currently viewing / editing (0-based). All paint
      * paths target it. See [`Document::set_current_frame`].
@@ -1380,6 +1386,46 @@ export class Event {
     readonly y: number;
 }
 
+/**
+ * The SVG of one trace and its counts.
+ */
+export class VectorizeResult {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Number of layers (one per colour).
+     */
+    readonly layers: number;
+    /**
+     * Number of outlines over all layers.
+     */
+    readonly outlines: number;
+    /**
+     * The SVG document.
+     */
+    readonly svg: string;
+    /**
+     * The monochrome threshold used, or −1 outside monochrome mode.
+     */
+    readonly threshold: number;
+}
+
+/**
+ * Traces one source image repeatedly; keeps the core's caches between
+ * traces so a preview that changes only Potrace options stays cheap.
+ */
+export class Vectorizer {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Traces with `mode` (0 colours, 1 monochrome, 2 pixel-exact) and the
+     * flat `params` vector; errors carry the core's message.
+     */
+    trace(mode: number, params: Float64Array): VectorizeResult;
+}
+
 /**
  * Snake_case names of every blend mode, in file-format order.
  */
@@ -1519,34 +1565,14 @@ export interface InitOutput {
     readonly document_undoDepth: (a: number) => number;
     readonly document_width: (a: number) => number;
     readonly palettePresetNames: () => [number, number];
-    readonly __wbg_animationinfo_free: (a: number, b: number) => void;
-    readonly __wbg_event_free: (a: number, b: number) => void;
-    readonly animationinfo_defaultLoops: (a: number) => number;
-    readonly animationinfo_frameCount: (a: number) => number;
-    readonly animationinfo_gifApproximated: (a: number) => number;
-    readonly animationinfo_semiTransparent: (a: number) => number;
-    readonly document_animationInfo: (a: number, b: number, c: number) => [number, number, number];
-    readonly document_exportAnimation: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
-    readonly event_frame: (a: number) => number;
-    readonly event_height: (a: number) => number;
-    readonly event_kind: (a: number) => [number, number];
-    readonly event_width: (a: number) => number;
-    readonly event_x: (a: number) => number;
-    readonly event_y: (a: number) => number;
-    readonly event_layer: (a: number) => number;
-    readonly __wbg_copiedimage_free: (a: number, b: number) => void;
-    readonly copiedimage_height: (a: number) => number;
-    readonly copiedimage_png: (a: number) => [number, number];
-    readonly copiedimage_width: (a: number) => number;
-    readonly copiedimage_x: (a: number) => number;
-    readonly copiedimage_y: (a: number) => number;
-    readonly document_copySelection: (a: number, b: number) => [number, number, number];
-    readonly document_cutSelection: (a: number) => [number, number, number];
-    readonly document_imageKey: (a: number, b: number) => [number, number, number, number];
-    readonly document_pasteLayer: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly document_cropToSelection: (a: number) => [number, number, number];
+    readonly document_resizeCanvas: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly document_scaleImage: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly document_transformCanvas: (a: number, b: number, c: number) => [number, number];
+    readonly document_transformLayer: (a: number, b: number, c: number) => [number, number];
     readonly blendModeNames: () => [number, number];
     readonly document_addGroup: (a: number, b: number, c: number) => [number, number, number];
-    readonly document_beginStroke: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number];
+    readonly document_applyEffect: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
     readonly document_duplicateLayer: (a: number, b: number) => [number, number, number];
     readonly document_flattenImage: (a: number) => [number, number, number];
     readonly document_layerBlendMode: (a: number, b: number) => [number, number];
@@ -1557,51 +1583,79 @@ export interface InitOutput {
     readonly document_layerThumbnail: (a: number, b: number, c: number, d: number) => [number, number, number];
     readonly document_mergeDown: (a: number, b: number) => [number, number];
     readonly document_moveLayerTo: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly document_previewEffect: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
     readonly document_reorderLayer: (a: number, b: number, c: number) => [number, number];
     readonly document_setLayerBlendMode: (a: number, b: number, c: number, d: number) => [number, number];
     readonly document_setLayerEditable: (a: number, b: number, c: number) => [number, number];
     readonly document_setLayerOpacity: (a: number, b: number, c: number) => [number, number];
-    readonly document_strokeTo: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly effectNames: () => [number, number];
+    readonly document_contractSelection: (a: number, b: number) => void;
+    readonly document_drawText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => [number, number, number];
+    readonly document_expandSelection: (a: number, b: number) => void;
+    readonly document_invertSelection: (a: number) => void;
+    readonly document_previewText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number) => [number, number, number];
+    readonly document_selectAll: (a: number) => void;
+    readonly document_selectEllipse: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly document_selectPolygon: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly document_selectRect: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly document_selectWand: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number];
+    readonly document_selectionIsRect: (a: number) => number;
+    readonly document_selectionMask: (a: number) => [number, number];
+    readonly registerFont: (a: number, b: number) => number;
+    readonly __wbg_vectorizer_free: (a: number, b: number) => void;
+    readonly __wbg_vectorizeresult_free: (a: number, b: number) => void;
+    readonly document_vectorizer: (a: number, b: number) => [number, number, number];
+    readonly vectorizer_trace: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly vectorizeresult_layers: (a: number) => number;
+    readonly vectorizeresult_outlines: (a: number) => number;
+    readonly vectorizeresult_svg: (a: number) => [number, number];
+    readonly vectorizeresult_threshold: (a: number) => number;
+    readonly __wbg_copiedimage_free: (a: number, b: number) => void;
+    readonly copiedimage_height: (a: number) => number;
+    readonly copiedimage_png: (a: number) => [number, number];
+    readonly copiedimage_width: (a: number) => number;
+    readonly copiedimage_x: (a: number) => number;
+    readonly copiedimage_y: (a: number) => number;
+    readonly document_copySelection: (a: number, b: number) => [number, number, number];
+    readonly document_cutSelection: (a: number) => [number, number, number];
+    readonly document_imageKey: (a: number, b: number) => [number, number, number, number];
+    readonly document_importPngAsLayer: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly document_openPng: (a: number, b: number) => [number, number, number];
+    readonly document_pasteLayer: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly __wbg_animationinfo_free: (a: number, b: number) => void;
+    readonly __wbg_event_free: (a: number, b: number) => void;
+    readonly animationinfo_defaultLoops: (a: number) => number;
+    readonly animationinfo_frameCount: (a: number) => number;
+    readonly animationinfo_gifApproximated: (a: number) => number;
+    readonly animationinfo_semiTransparent: (a: number) => number;
     readonly document_addTag: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
-    readonly document_cropToSelection: (a: number) => [number, number, number];
+    readonly document_animationInfo: (a: number, b: number, c: number) => [number, number, number];
+    readonly document_applyShape: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => [number, number];
+    readonly document_beginStroke: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number];
+    readonly document_exportAnimation: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number, number];
     readonly document_frameDuration: (a: number, b: number) => [number, number, number];
     readonly document_onionSkinEnabled: (a: number) => number;
     readonly document_removeFrame: (a: number, b: number) => [number, number];
     readonly document_removeTag: (a: number, b: number) => [number, number];
-    readonly document_resizeCanvas: (a: number, b: number, c: number, d: number, e: number) => [number, number];
-    readonly document_scaleImage: (a: number, b: number, c: number, d: number, e: number) => [number, number];
     readonly document_setFrameDuration: (a: number, b: number, c: number) => [number, number];
     readonly document_setOnionSkin: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
     readonly document_setTagDirection: (a: number, b: number, c: number, d: number) => [number, number];
     readonly document_setTagName: (a: number, b: number, c: number, d: number) => [number, number];
     readonly document_setTagRange: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly document_strokeTo: (a: number, b: number, c: number, d: number) => [number, number];
     readonly document_tagColor: (a: number, b: number) => [number, number, number];
     readonly document_tagCount: (a: number) => number;
     readonly document_tagDirection: (a: number, b: number) => [number, number, number, number];
     readonly document_tagFrom: (a: number, b: number) => [number, number, number];
     readonly document_tagName: (a: number, b: number) => [number, number, number, number];
     readonly document_tagTo: (a: number, b: number) => [number, number, number];
-    readonly document_transformCanvas: (a: number, b: number, c: number) => [number, number];
-    readonly document_transformLayer: (a: number, b: number, c: number) => [number, number];
-    readonly document_contractSelection: (a: number, b: number) => void;
-    readonly document_drawText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => [number, number, number];
-    readonly document_expandSelection: (a: number, b: number) => void;
-    readonly document_invertSelection: (a: number) => void;
-    readonly document_previewText: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number) => [number, number, number];
-    readonly document_selectAll: (a: number) => void;
-    readonly document_selectEllipse: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
-    readonly document_selectPolygon: (a: number, b: number, c: number, d: number, e: number) => [number, number];
-    readonly document_selectRect: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
-    readonly document_selectWand: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number];
-    readonly document_selectionIsRect: (a: number) => number;
-    readonly document_selectionMask: (a: number) => [number, number];
-    readonly registerFont: (a: number, b: number) => number;
-    readonly document_applyEffect: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
-    readonly document_applyShape: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => [number, number];
-    readonly document_previewEffect: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
-    readonly effectNames: () => [number, number];
-    readonly document_importPngAsLayer: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
-    readonly document_openPng: (a: number, b: number) => [number, number, number];
+    readonly event_frame: (a: number) => number;
+    readonly event_height: (a: number) => number;
+    readonly event_kind: (a: number) => [number, number];
+    readonly event_width: (a: number) => number;
+    readonly event_x: (a: number) => number;
+    readonly event_y: (a: number) => number;
+    readonly event_layer: (a: number) => number;
     readonly __wbindgen_externrefs: WebAssembly.Table;
     readonly __wbindgen_free: (a: number, b: number, c: number) => void;
     readonly __externref_drop_slice: (a: number, b: number) => void;

package/pincel_wasm.js

@@ -2779,6 +2779,20 @@ export class Document {
         const ret = wasm.document_undoDepth(this.__wbg_ptr);
         return ret >>> 0;
     }
+    /**
+     * A [`Vectorizer`] over `frame` composed like
+     * [`exportPng`](Document::export_png): zoom 1, visible layers, no onion
+     * skin, no overlays.
+     * @param {number} frame
+     * @returns {Vectorizer}
+     */
+    vectorizer(frame) {
+        const ret = wasm.document_vectorizer(this.__wbg_ptr, frame);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return Vectorizer.__wrap(ret[0]);
+    }
     /**
      * Canvas width in pixels.
      * @returns {number}
@@ -2893,6 +2907,109 @@ export class Event {
 }
 if (Symbol.dispose) Event.prototype[Symbol.dispose] = Event.prototype.free;
 
+/**
+ * The SVG of one trace and its counts.
+ */
+export class VectorizeResult {
+    static __wrap(ptr) {
+        const obj = Object.create(VectorizeResult.prototype);
+        obj.__wbg_ptr = ptr;
+        VectorizeResultFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        VectorizeResultFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_vectorizeresult_free(ptr, 0);
+    }
+    /**
+     * Number of layers (one per colour).
+     * @returns {number}
+     */
+    get layers() {
+        const ret = wasm.vectorizeresult_layers(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * Number of outlines over all layers.
+     * @returns {number}
+     */
+    get outlines() {
+        const ret = wasm.vectorizeresult_outlines(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * The SVG document.
+     * @returns {string}
+     */
+    get svg() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.vectorizeresult_svg(this.__wbg_ptr);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * The monochrome threshold used, or −1 outside monochrome mode.
+     * @returns {number}
+     */
+    get threshold() {
+        const ret = wasm.vectorizeresult_threshold(this.__wbg_ptr);
+        return ret;
+    }
+}
+if (Symbol.dispose) VectorizeResult.prototype[Symbol.dispose] = VectorizeResult.prototype.free;
+
+/**
+ * Traces one source image repeatedly; keeps the core's caches between
+ * traces so a preview that changes only Potrace options stays cheap.
+ */
+export class Vectorizer {
+    static __wrap(ptr) {
+        const obj = Object.create(Vectorizer.prototype);
+        obj.__wbg_ptr = ptr;
+        VectorizerFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        VectorizerFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_vectorizer_free(ptr, 0);
+    }
+    /**
+     * Traces with `mode` (0 colours, 1 monochrome, 2 pixel-exact) and the
+     * flat `params` vector; errors carry the core's message.
+     * @param {number} mode
+     * @param {Float64Array} params
+     * @returns {VectorizeResult}
+     */
+    trace(mode, params) {
+        const ptr0 = passArrayF64ToWasm0(params, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.vectorizer_trace(this.__wbg_ptr, mode, ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return VectorizeResult.__wrap(ret[0]);
+    }
+}
+if (Symbol.dispose) Vectorizer.prototype[Symbol.dispose] = Vectorizer.prototype.free;
+
 /**
  * Snake_case names of every blend mode, in file-format order.
  * @returns {string[]}
@@ -2997,6 +3114,12 @@ const DocumentFinalization = (typeof FinalizationRegistry === 'undefined')
 const EventFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_event_free(ptr, 1));
+const VectorizeResultFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_vectorizeresult_free(ptr, 1));
+const VectorizerFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_vectorizer_free(ptr, 1));
 
 function getArrayJsValueFromWasm0(ptr, len) {
     ptr = ptr >>> 0;