@takumi-rs/wasm 0.66.5 → 0.66.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takumi-rs/wasm",
-  "version": "0.66.5",
+  "version": "0.66.7",
   "keywords": [
     "image",
     "rendering",

package/pkg/takumi_wasm.d.ts

@@ -18,7 +18,7 @@ export type RenderOptions = {
      * The format of the image.
      * @default "png"
      */
-    format?: "png" | "jpeg" | "webp",
+    format?: "png" | "jpeg" | "webp" | "raw",
     /**
      * The quality of JPEG format (0-100).
      */
@@ -82,20 +82,49 @@ export type AnimationFrameSource = {
 
 
 
+/**
+ * The main renderer for Takumi image rendering engine.
+ */
 export class Renderer {
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Clears the renderer's internal image store.
+     */
     clearImageStore(): void;
+    /**
+     * Loads a font into the renderer.
+     */
     loadFont(font: Font): void;
     /**
      * @deprecated use `loadFont` instead.
      */
     loadFontWithInfo(font: Font): void;
+    /**
+     * Measures a node tree and returns layout information.
+     */
     measure(node: AnyNode, options?: RenderOptions | null): MeasuredNode;
+    /**
+     * Creates a new Renderer instance.
+     */
     constructor();
+    /**
+     * Puts a persistent image into the renderer's internal store.
+     */
     putPersistentImage(data: ImageSource): void;
+    /**
+     * Renders a node tree into an image buffer.
+     */
     render(node: AnyNode, options?: RenderOptions | null): Uint8Array;
+    /**
+     * Renders an animation sequence into a buffer.
+     */
     renderAnimation(frames: AnimationFrameSource[], options: RenderAnimationOptions): Uint8Array;
+    /**
+     * Renders a node tree into a data URL.
+     *
+     * `raw` format is not supported for data URL.
+     */
     renderAsDataUrl(node: AnyNode, options: RenderOptions): string;
 }
 

package/pkg/takumi_wasm.js

@@ -1,5 +1,8 @@
 /* @ts-self-types="./takumi_wasm.d.ts" */
 
+/**
+ * The main renderer for Takumi image rendering engine.
+ */
 export class Renderer {
     __destroy_into_raw() {
         const ptr = this.__wbg_ptr;
@@ -11,10 +14,14 @@ export class Renderer {
         const ptr = this.__destroy_into_raw();
         wasm.__wbg_renderer_free(ptr, 0);
     }
+    /**
+     * Clears the renderer's internal image store.
+     */
     clearImageStore() {
         wasm.renderer_clearImageStore(this.__wbg_ptr);
     }
     /**
+     * Loads a font into the renderer.
      * @param {Font} font
      */
     loadFont(font) {
@@ -48,6 +55,7 @@ export class Renderer {
         }
     }
     /**
+     * Measures a node tree and returns layout information.
      * @param {AnyNode} node
      * @param {RenderOptions | null} [options]
      * @returns {MeasuredNode}
@@ -67,6 +75,9 @@ export class Renderer {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * Creates a new Renderer instance.
+     */
     constructor() {
         const ret = wasm.renderer_new();
         this.__wbg_ptr = ret >>> 0;
@@ -74,6 +85,7 @@ export class Renderer {
         return this;
     }
     /**
+     * Puts a persistent image into the renderer's internal store.
      * @param {ImageSource} data
      */
     putPersistentImage(data) {
@@ -90,6 +102,7 @@ export class Renderer {
         }
     }
     /**
+     * Renders a node tree into an image buffer.
      * @param {AnyNode} node
      * @param {RenderOptions | null} [options]
      * @returns {Uint8Array}
@@ -113,6 +126,7 @@ export class Renderer {
         }
     }
     /**
+     * Renders an animation sequence into a buffer.
      * @param {AnimationFrameSource[]} frames
      * @param {RenderAnimationOptions} options
      * @returns {Uint8Array}
@@ -138,6 +152,9 @@ export class Renderer {
         }
     }
     /**
+     * Renders a node tree into a data URL.
+     *
+     * `raw` format is not supported for data URL.
      * @param {AnyNode} node
      * @param {RenderOptions} options
      * @returns {string}