@ludicon/spark.js 0.0.1 → 0.0.3

package/LICENSE

@@ -1,21 +1,31 @@
-MIT License
-
-Copyright (c) 2024 Ludicon LLC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+This repository contains both open-source and proprietary components.
+
+The use of the *Spark* shaders is covered under the spark.js EULA:
+
+    https://ludicon.com/sparkjs/eula.html
+
+
+The JavaScript code is released under MIT license:
+
+    MIT License
+
+    Copyright (c) 2025 Ludicon LLC
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # spark.js⚡️
 
-[![npm version](https://img.shields.io/npm/v/@ludicon/spark.js.svg)](https://www.npmjs.com/package/@ludicon/spark.js) [![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE) [![WebGPU](https://img.shields.io/badge/WebGPU-supported-green.svg)](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API)
+[![npm version](https://img.shields.io/npm/v/@ludicon/spark.js.svg)](https://www.npmjs.com/package/@ludicon/spark.js) [![WebGPU](https://img.shields.io/badge/WebGPU-supported-green.svg)](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API)
 
 Real-time texture compression library for the Web.
 
@@ -21,14 +21,14 @@ npm install @ludicon/spark.js
 ## Usage Example
 
 ```js
-import { Spark } from "spark.js"
+import { Spark } from "@ludicon/spark.js"
 
 // Initialize a WebGPU device with required features
 const adapter = await navigator.gpu.requestAdapter()
 const requiredFeatures = Spark.getRequiredFeatures(adapter)
 const device = await adapter.requestDevice({ requiredFeatures })
 
-// Create Spark instance for the WebGPU device
+// Create spark instance for the WebGPU device
 const spark = await Spark.create(device)
 
 // Load and encode an image into a GPU texture
@@ -72,7 +72,7 @@ And visit `https://localhost:5174/examples/basic.html`.
 
 ### `encodeTexture(source, options)`
 
-Load an image and transcode it to a compressed GPU texture.
+Load an image and encode it to a compressed GPU texture.
 
 #### Parameters
 
@@ -93,7 +93,7 @@ Load an image and transcode it to a compressed GPU texture.
     Whether to encode the image using an as sRGB format. This also affects mipmap generation. The `srgb` mode can also be inferred from the `format`. Default: `false`. 
 
   - **`normal`** (`boolean`)
-    Whether to interpret the image as a normal map. This affects automatic format selection favoring the use of `"bc5"` and `"etc-rg"` formats. Default: `false`.
+    Whether to interpret the image as a normal map. This affects automatic format selection favoring the use of `"bc5"` and `"eac-rg"` formats. Default: `false`.
 
   - **`flipY`** (`boolean`)
     Whether to vertically flip the image before encoding. Default: `false`.

package/dist/index.esm.js

@@ -1,11 +1,10 @@
 const modules = /* @__PURE__ */ Object.assign({ "./spark_astc_rgb.wgsl": () => import("./spark_astc_rgb-ylbf30mQ.js"), "./spark_astc_rgba.wgsl": () => import("./spark_astc_rgba-C4NuyfHw.js"), "./spark_bc1_rgb.wgsl": () => import("./spark_bc1_rgb-CRQwJRCp.js"), "./spark_bc3_rgba.wgsl": () => import("./spark_bc3_rgba-CyRcvC8t.js"), "./spark_bc4_r.wgsl": () => import("./spark_bc4_r-BSB9VB_w.js"), "./spark_bc5_rg.wgsl": () => import("./spark_bc5_rg-NX_OBH9I.js"), "./spark_bc7_rgb.wgsl": () => import("./spark_bc7_rgb-CYdL55pE.js"), "./spark_bc7_rgba.wgsl": () => import("./spark_bc7_rgba-BFgOyqos.js"), "./spark_eac_r.wgsl": () => import("./spark_eac_r-BFwH430b.js"), "./spark_eac_rg.wgsl": () => import("./spark_eac_rg--Gm5Gzmk.js"), "./spark_etc2_rgb.wgsl": () => import("./spark_etc2_rgb-CWjBHhHQ.js"), "./spark_etc2_rgba.wgsl": () => import("./spark_etc2_rgba-BRX5DwNI.js"), "./utils.wgsl": () => import("./utils-BybjJ-PV.js") });
 const shaders = Object.fromEntries(
-  await Promise.all(
-    Object.entries(modules).map(async function([path, module]) {
-      const { default: shader } = await module(), name = path.replace("./", "");
-      return [name, shader];
-    })
-  )
+  Object.entries(modules).map(([path, module]) => {
+    const name = path.replace("./", "");
+    const fn = async () => (await module()).default;
+    return [name, fn];
+  })
 );
 const SparkFormat = {
   ASTC_4x4_RGB: 0,
@@ -461,11 +460,13 @@ class Spark {
   /**
    * Initialize the encoder by detecting available compression formats.
    * @param {GPUDevice} device - WebGPU device.
+   * @param {Object} options - Encoder options.
+   * @param {boolean} options.preload - Whether to preload all encoder pipelines (false by default).
    * @returns {Promise<void>} Resolves when initialization is complete.
    */
-  static async create(device) {
+  static async create(device, options = {}) {
     const instance = new Spark();
-    await instance.#init(device);
+    await instance.#init(device, options.preload ?? false);
     return instance;
   }
   /**
@@ -757,7 +758,7 @@ class Spark {
     }
     const commandEncoder = this.#device.createCommandEncoder();
     commandEncoder.resolveQuerySet(this.#querySet, 0, 2, this.#queryBuffer, 0);
-    commandEncoder.copyBufferToBuffer(this.#queryBuffer, this.#queryReadbackBuffer, 16);
+    commandEncoder.copyBufferToBuffer(this.#queryBuffer, 0, this.#queryReadbackBuffer, 0, 16);
     this.#device.queue.submit([commandEncoder.finish()]);
     await this.#device.queue.onSubmittedWorkDone();
     await this.#queryReadbackBuffer.mapAsync(GPUMapMode.READ);
@@ -770,7 +771,7 @@ class Spark {
     const elapsedMilliseconds = elapsedNanoseconds / 1e6;
     return elapsedMilliseconds;
   }
-  async #init(device) {
+  async #init(device, preload) {
     assert(device, "device is required");
     assert(isWebGPU(device), "device is not a WebGPU device");
     this.#device = device;
@@ -808,15 +809,19 @@ class Spark {
     }
     this.#supportsFloat16 = this.#device.features.has("shader-f16");
     await this.#loadUtilPipelines();
-    for (const format of this.#supportedFormats) {
-      if (!this.#pipelines[format]) {
-        await this.#loadPipeline(format);
+    if (preload) {
+      for (const format of this.#supportedFormats) {
+        if (!this.#pipelines[format]) {
+          this.#loadPipeline(format).catch((err) => {
+            console.error(`Failed to preload pipeline for format ${format}:`, err);
+          });
+        }
       }
     }
   }
   async #loadUtilPipelines() {
     const shaderModule = this.#device.createShaderModule({
-      code: shaders["utils.wgsl"],
+      code: await shaders["utils.wgsl"](),
       label: "utils"
     });
     if (typeof shaderModule.compilationInfo == "function") {
@@ -865,7 +870,7 @@ class Spark {
     const pipelinePromise = (async () => {
       const shaderFile = SparkShaderFiles[format];
       assert(shaderFile, `No shader available for format ${SparkFormatName[format]}`);
-      let shaderCode = shaders[shaderFile];
+      let shaderCode = await shaders[shaderFile]();
       if (!this.#supportsFloat16) {
         shaderCode = shaderCode.replace(/^enable f16;\s*/m, "").replace(/\bf16\b/g, "f32").replace(/\bvec([234])h\b/g, "vec$1f").replace(/\bmat([234]x[234])h/g, "mat$1f").replace(/\b(\d*\.\d+|\d+\.)h\b/g, "$1");
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludicon/spark.js",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Real-Time GPU Texture Codecs for the Web",
   "main": "dist/index.esm.js",
   "module": "dist/index.esm.js",
@@ -47,7 +47,7 @@
     "spark"
   ],
   "author": "Ignacio Castano <castano@ludicon.com> (https://ludicon.com/)",
-  "license": "MIT",
+  "license": "See LICENSE",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ludicon/spark.js.git"