@grida/canvas-wasm 0.0.10 → 0.0.12

package/dist/index.d.mts

@@ -51,7 +51,11 @@ declare namespace createGridaCanvas {
     // ====================================================================================================
     // INITIALIZATION
     // ====================================================================================================
-    _init(width: number, height: number): GridaCanvasWebGlApplicationPtr;
+    _init(
+      width: number,
+      height: number,
+      cfg_font_fallback: boolean
+    ): GridaCanvasWebGlApplicationPtr;
 
     // ====================================================================================================
     // APPLICATION METHODS
@@ -154,21 +158,20 @@ declare namespace createGridaCanvas {
 
 type GridaCanvasWebGlApplicationPtr = number;
 
-interface GridaCanvasInitOptions {
-  /**
-   * This callback will be invoked when the loader needs to fetch a file (e.g.
-   * the blob of WASM code). The correct url prefix should be applied.
-   * @param file - the name of the file that is about to be loaded.
-   *
-   * @example
-   * ```ts
-   * locateFile: (file) => `https://unpkg.com/@grida/canvas-wasm@$latest/bin/${file}`,
-   * locateFile: (file) => `custom-binary-path/${file}`,
-   * ```
-   */
-  locateFile(file: string): string;
+interface GridaCanvasModuleInitOptions {
+    /**
+     * This callback will be invoked when the loader needs to fetch a file (e.g.
+     * the blob of WASM code). The correct url prefix should be applied.
+     * @param file - the name of the file that is about to be loaded.
+     *
+     * @example
+     * ```ts
+     * locateFile: (file) => `https://unpkg.com/@grida/canvas-wasm@$latest/bin/${file}`,
+     * locateFile: (file) => `custom-binary-path/${file}`,
+     * ```
+     */
+    locateFile(file: string, version: string): string;
 }
-
 type Transform2D = [[number, number, number], [number, number, number]];
 type Rectangle = {
     x: number;
@@ -191,11 +194,18 @@ type ExportAsImage = {
     format: "PNG" | "JPEG" | "WEBP" | "BMP";
     constraints: ExportConstraints;
 };
-declare function init(opts?: GridaCanvasInitOptions): Promise<ApplicationFactory>;
+declare function init(opts?: GridaCanvasModuleInitOptions): Promise<ApplicationFactory>;
+interface CreateWebGLCanvasSurfaceOptions {
+    /**
+     * when true, built-in fonts will be used for text rendering, even if the font family and style does not match.
+     * @default true
+     */
+    fontFallback?: boolean;
+}
 declare class ApplicationFactory {
     private readonly module;
     constructor(module: createGridaCanvas.GridaCanvasWasmBindings);
-    createWebGLCanvasSurface(canvas: HTMLCanvasElement): Grida2D;
+    createWebGLCanvasSurface(canvas: HTMLCanvasElement, options?: CreateWebGLCanvasSurfaceOptions): Grida2D;
     createWebGLCanvasSurfaceById(htmlcanvasid: string): Grida2D;
 }
 declare class Grida2D {
@@ -273,4 +283,4 @@ declare class Grida2D {
     devtools_rendering_set_show_ruler(show: boolean): void;
 }
 
-export { Grida2D, init as default };
+export { Grida2D, type GridaCanvasModuleInitOptions, init as default };

package/dist/index.d.ts

@@ -51,7 +51,11 @@ declare namespace createGridaCanvas {
     // ====================================================================================================
     // INITIALIZATION
     // ====================================================================================================
-    _init(width: number, height: number): GridaCanvasWebGlApplicationPtr;
+    _init(
+      width: number,
+      height: number,
+      cfg_font_fallback: boolean
+    ): GridaCanvasWebGlApplicationPtr;
 
     // ====================================================================================================
     // APPLICATION METHODS
@@ -154,21 +158,20 @@ declare namespace createGridaCanvas {
 
 type GridaCanvasWebGlApplicationPtr = number;
 
-interface GridaCanvasInitOptions {
-  /**
-   * This callback will be invoked when the loader needs to fetch a file (e.g.
-   * the blob of WASM code). The correct url prefix should be applied.
-   * @param file - the name of the file that is about to be loaded.
-   *
-   * @example
-   * ```ts
-   * locateFile: (file) => `https://unpkg.com/@grida/canvas-wasm@$latest/bin/${file}`,
-   * locateFile: (file) => `custom-binary-path/${file}`,
-   * ```
-   */
-  locateFile(file: string): string;
+interface GridaCanvasModuleInitOptions {
+    /**
+     * This callback will be invoked when the loader needs to fetch a file (e.g.
+     * the blob of WASM code). The correct url prefix should be applied.
+     * @param file - the name of the file that is about to be loaded.
+     *
+     * @example
+     * ```ts
+     * locateFile: (file) => `https://unpkg.com/@grida/canvas-wasm@$latest/bin/${file}`,
+     * locateFile: (file) => `custom-binary-path/${file}`,
+     * ```
+     */
+    locateFile(file: string, version: string): string;
 }
-
 type Transform2D = [[number, number, number], [number, number, number]];
 type Rectangle = {
     x: number;
@@ -191,11 +194,18 @@ type ExportAsImage = {
     format: "PNG" | "JPEG" | "WEBP" | "BMP";
     constraints: ExportConstraints;
 };
-declare function init(opts?: GridaCanvasInitOptions): Promise<ApplicationFactory>;
+declare function init(opts?: GridaCanvasModuleInitOptions): Promise<ApplicationFactory>;
+interface CreateWebGLCanvasSurfaceOptions {
+    /**
+     * when true, built-in fonts will be used for text rendering, even if the font family and style does not match.
+     * @default true
+     */
+    fontFallback?: boolean;
+}
 declare class ApplicationFactory {
     private readonly module;
     constructor(module: createGridaCanvas.GridaCanvasWasmBindings);
-    createWebGLCanvasSurface(canvas: HTMLCanvasElement): Grida2D;
+    createWebGLCanvasSurface(canvas: HTMLCanvasElement, options?: CreateWebGLCanvasSurfaceOptions): Grida2D;
     createWebGLCanvasSurfaceById(htmlcanvasid: string): Grida2D;
 }
 declare class Grida2D {
@@ -273,4 +283,4 @@ declare class Grida2D {
     devtools_rendering_set_show_ruler(show: boolean): void;
 }
 
-export { Grida2D, init as default };
+export { Grida2D, type GridaCanvasModuleInitOptions, init as default };