@ludicon/spark.js 0.0.8 → 0.0.9

package/README.md

@@ -92,17 +92,17 @@ Load an image and encode it to a compressed GPU texture.
 
       - A channel mask indicating the number of channels in your input: `"rgba"`, `"rgb"`, `"rg"` or `"r"`, the actual format is selected based on the device capabilities.
 
-      - An explicit WebGPU BC, ETC or ASTC format name, or an abbreviated form such as `"bc7"` or `"astc"`. Note, spark.js only supports 4x4 and LDR formats. By default 
+      - An explicit WebGPU BC, ETC or ASTC format name, or an abbreviated form such as `"bc7"` or `"astc"`. Note: only 4x4 LDR formats are supported. 
 
       - If you specify `auto`, the input texture is analyzed to detect the necessary number of channels. This has some overhead, it's always recommended to specify the format through one of the other methods. 
     
     Default: `rgb`.
 
   - **`alpha`** 
-    Hint for the format selector. When an explicit channel mask is not provided, the channel mask is assumed to be `"rgb"`, providing 
+    Hint for the automatic format selector. When no explicit format is provided, the format is assumed to be `"rgb"`. Supplying `alpha: true` will default to "rgba" instead.
 
   - **`mips`** or **`generateMipmaps`** (`boolean`)
-    Whether to generate mipmaps. Currently mipmap generation uses a basic box filter in linear space. Default: `false`.
+    Whether to generate mipmaps. Mipmaps are generated with a basic box filter in linear space. Default: `false`.
 
   - **`srgb`** (`boolean`)
     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`. 
@@ -115,7 +115,8 @@ Load an image and encode it to a compressed GPU texture.
 
 #### Returns
 
-- `Promise<GPUTexture>` — the compressed GPU texture, ready for use in WebGPU.
+- `Promise<GPUTexture>` 
+  A promise resolving to the encoded WebGPU texture.
 
 
 ## Integration with three.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludicon/spark.js",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Real-Time GPU Texture Codecs for the Web",
   "main": "dist/spark.esm.js",
   "module": "dist/spark.esm.js",
@@ -67,7 +67,7 @@
     "vite": "^7.0.0"
   },
   "peerDependencies": {
-    "three": "^0.180.0"
+    "three": ">=0.180.0"
   },
   "peerDependenciesMeta": {
     "three": {

package/src/three-gltf.js

@@ -70,34 +70,58 @@ class GLTFSparkPlugin {
       assignTexture(materialDef.pbrMetallicRoughness?.metallicRoughnessTexture?.index, Channel.G | Channel.B)
 
       // KHR_materials_anisotropy - RG contains direction, B contains strength.
-      assignTexture(materialDef.anisotropyTexture?.index, Channel.RGB)
+      const anisotropyDef = materialDef.extensions?.KHR_materials_anisotropy
+      if (anisotropyDef) {
+        assignTexture(anisotropyDef.anisotropyTexture?.index, Channel.RGB)
+      }
 
       // KHR_materials_clearcoat
-      assignTexture(materialDef.clearcoatTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
-      assignTexture(materialDef.clearcoatRoughnessTexture?.index, Channel.R)
-      assignTexture(materialDef.clearcoatNormalTexture?.index, Channel.RG, THREE.NoColorSpace, true)
+      const clearcoatDef = materialDef.extensions?.KHR_materials_clearcoat
+      if (clearcoatDef) {
+        assignTexture(clearcoatDef.clearcoatTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
+        assignTexture(clearcoatDef.clearcoatRoughnessTexture?.index, Channel.R)
+        assignTexture(clearcoatDef.clearcoatNormalTexture?.index, Channel.RG, THREE.NoColorSpace, true)
+      }
 
       // KHR_materials_diffuse_transmission
-      assignTexture(materialDef.diffuseTransmissionTexture?.index, Channel.A)
-      assignTexture(materialDef.diffuseTransmissionColorTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
+      const diffuseTransmissionDef = materialDef.extensions?.KHR_materials_diffuse_transmission
+      if (diffuseTransmissionDef) {
+        assignTexture(diffuseTransmissionDef.diffuseTransmissionTexture?.index, Channel.A)
+        assignTexture(diffuseTransmissionDef.diffuseTransmissionColorTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
+      }
 
       // KHR_materials_iridescence
-      assignTexture(materialDef.iridescenceTexture?.index, Channel.R)
-      assignTexture(materialDef.iridescenceThicknessTexture?.index, Channel.G)
+      const iridescenceDef = materialDef.extensions?.KHR_materials_iridescence
+      if (iridescenceDef) {
+        assignTexture(iridescenceDef.iridescenceTexture?.index, Channel.R)
+        assignTexture(iridescenceDef.iridescenceThicknessTexture?.index, Channel.G)
+      }
 
       // KHR_materials_sheen
-      assignTexture(materialDef.sheenColorTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
-      assignTexture(materialDef.sheenRoughnessTextureIndex?.index, Channel.A)
+      const sheenDef = materialDef.extensions?.KHR_materials_sheen
+      if (sheenDef) {
+        assignTexture(sheenDef.sheenColorTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
+        assignTexture(sheenDef.sheenRoughnessTextureIndex?.index, Channel.A)
+      }
 
       // KHR_materials_specular
-      assignTexture(materialDef.specularTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
-      assignTexture(materialDef.specularColorTexture?.index, Channel.A)
+      const specularDef = materialDef.extensions?.KHR_materials_specular
+      if (specularDef) {
+        assignTexture(specularDef.specularTexture?.index, Channel.RGB, THREE.SRGBColorSpace)
+        assignTexture(specularDef.specularColorTexture?.index, Channel.A)
+      }
 
       // KHR_materials_transmission
-      assignTexture(materialDef.transmissionTexture?.index, Channel.R)
+      const transmissionDef = materialDef.extensions?.KHR_materials_transmission
+      if (transmissionDef) {
+        assignTexture(transmissionDef.transmissionTexture?.index, Channel.R)
+      }
 
       // KHR_materials_volume
-      assignTexture(materialDef.thicknessTexture?.index, Channel.G)
+      const volumeDef = materialDef.extensions?.KHR_materials_volume
+      if (volumeDef) {
+        assignTexture(volumeDef.thicknessTexture?.index, Channel.G)
+      }
     }
 
     this.textureColorSpaces = textureColorSpaces