@needle-tools/gltf-build-pipeline 2.9.2 → 2.9.4

package/CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.9.1] - 2024-05-23
+- change: `product` usecase uses `UASTC` compression for 'normalTexture'
+
 ## [2.9.0] - 2024-05-22
 - add: initial texture compression mode support for `world` and `product`
 

package/dist/transforms/needle_texture_transform.js

@@ -97,7 +97,7 @@ async function processTexture(texture, index, document, logger, context) {
     const compressionSettings = ext?.model;
     // is a user has configured a texture explictly to NOT be compressed
     // we should respect that
-    if (ext?.model?.mode === "none") {
+    if (compressionSettings?.mode === "none") {
         logger.info(`→ Skipping texture compression for ${texture.getName()} [${index}] as configured in the texture extension`);
         return;
     }
@@ -113,7 +113,8 @@ async function processTexture(texture, index, document, logger, context) {
             logger.info(`→ Using cached texture ${texture.getName()} [${index}] – ${(cached.length / 1024).toFixed(0)} KB`);
         }
     }
-    let successFullyProcessed = false;
+    let successfullyProcessed = false;
+    let useDefaultCompression = true;
     const canRunToktx = context.noToktx !== true;
     const originalUri = texture.getURI();
     if (compressionSettings && compressionSettings.mode !== "auto") {
@@ -124,12 +125,17 @@ async function processTexture(texture, index, document, logger, context) {
                 break;
             case "product":
                 switch (compressionSettings.slot) {
-                    case "baseColorTexture":
+                    default:
+                        compressionSettings.mode = "ETC1S";
+                        break;
                     case "normalTexture":
+                        compressionSettings.mode = "UASTC";
+                        break;
+                    case "baseColorTexture":
                     case "metallicRoughnessTexture":
                     case "lightmapTexture":
                         compressionSettings.mode = "webp";
-                        compressionSettings.quality = 0.95;
+                        compressionSettings.quality = 0.8;
                         break;
                 }
                 break;
@@ -141,7 +147,8 @@ async function processTexture(texture, index, document, logger, context) {
                     return;
                 }
                 await resizeTextureIfNecessary(texture);
-                successFullyProcessed = await context.webPContext.process(index, texture, compressionSettings, context);
+                useDefaultCompression = false;
+                successfullyProcessed = await context.webPContext.process(index, texture, compressionSettings, context);
                 break;
             case "ETC1S":
                 if (cached) {
@@ -149,7 +156,8 @@ async function processTexture(texture, index, document, logger, context) {
                     return;
                 }
                 await resizeTextureIfNecessary(texture);
-                successFullyProcessed = await context.toktxContext.process(index, texture, compressionSettings, context);
+                useDefaultCompression = false;
+                successfullyProcessed = await context.toktxContext.process(index, texture, compressionSettings, context);
                 break;
             case "UASTC":
                 if (cached) {
@@ -157,11 +165,12 @@ async function processTexture(texture, index, document, logger, context) {
                     return;
                 }
                 await resizeTextureIfNecessary(texture);
-                successFullyProcessed = await context.toktxContext.process(index, texture, compressionSettings, context);
+                useDefaultCompression = false;
+                successfullyProcessed = await context.toktxContext.process(index, texture, compressionSettings, context);
                 break;
         }
     }
-    else {
+    if (useDefaultCompression) {
         let mimeType = "image/ktx2";
         let ktx2Format = undefined;
         const slots = listTextureSlots(texture);
@@ -204,9 +213,10 @@ async function processTexture(texture, index, document, logger, context) {
         }
         await resizeTextureIfNecessary(texture);
         if (mimeType === "image/webp") {
-            successFullyProcessed = await context.webPContext.process(index, texture, {
+            successfullyProcessed = await context.webPContext.process(index, texture, {
                 ...webpOptions,
                 quality: .95,
+                slot: slots.join(","),
             }, context);
         }
         else if (canRunToktx) {
@@ -217,18 +227,18 @@ async function processTexture(texture, index, document, logger, context) {
             if (ktx2Format || isVRM) {
                 options = { mode: ktx2Format || "ETC1S" };
             }
-            successFullyProcessed = await context.toktxContext.process(index, texture, options, context);
+            successfullyProcessed = await context.toktxContext.process(index, texture, options, context);
         }
         else {
             console.log("Toktx not found: Skipping texture compression: " + originalMimeType);
         }
     }
-    if (context.useCache && successFullyProcessed && key) {
+    if (context.useCache && successfullyProcessed && key) {
         const data = texture.getImage();
         if (data)
             addToCache(key, data);
     }
-    if (successFullyProcessed) {
+    if (successfullyProcessed) {
         const newUri = texture.getURI();
         if (originalUri && originalUri != newUri) {
             const inDirectory = dirname(context.file);

package/dist/transforms/needle_webp.d.ts

@@ -10,6 +10,6 @@ export declare class NeedleWebPContext implements INeedleTextureTransformContext
     private compressed;
     constructor(options: NeedleWebPOptions);
     prepare(document: Document): Promise<void>;
-    process(index: number, texture: Texture, settings: Pick<NEEDLE_compression_texture_schema, "quality"> & Partial<sharp.WebpOptions>, context: NeedleTransformContext): Promise<boolean>;
+    process(index: number, texture: Texture, settings: Pick<NEEDLE_compression_texture_schema, "quality" | "slot"> & Partial<sharp.WebpOptions>, context: NeedleTransformContext): Promise<boolean>;
     finalize(document: Document): Promise<void>;
 }

package/dist/transforms/needle_webp.js

@@ -35,7 +35,7 @@ export class NeedleWebPContext {
             options.quality = undefined; // If quality is 0 we use the default value
         }
         // console.log(options);
-        this.logger.info(`→ Will compress texture ${texture.getName()} to webp with quality '${options.quality === undefined ? 'default' : options.quality}'`);
+        this.logger.info(`webp:texture[${index}] ${texture.getName()}: Slots → [${settings.slot}] with quality '${options.quality === undefined ? 'default' : options.quality}'`);
         const buffer = await sharp(texture.getImage()).toFormat('webp', options).toBuffer();
         texture
             .setMimeType('image/webp')

package/dist/utils/version.gen.d.ts

@@ -1 +1 @@
-export declare const version = "2.9.2";
+export declare const version = "2.9.4";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.9.2";
+export const version = "2.9.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.9.2",
+  "version": "2.9.4",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "dist/index.js",
   "type": "module",