@needle-tools/gltf-build-pipeline 2.7.1 → 2.8.0-alpha.1

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.8.0-alpha.0] - 2024-02-27
+- change: `product` usecase now uses webp compression for 'normalTexture' and 'metallicRoughnessTexture' textures
+
 ## [2.7.1] - 2024-02-14
 - fix: bug in caching path due to change in 2.7.0-alpha.2
 

package/dist/transforms/needle_texture_transform.js

@@ -97,8 +97,11 @@ 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 (ext?.model?.mode === "none") {
+        logger.info(`→ Skipping texture compression for ${texture.getName()} [${index}] as configured in the texture extension`);
         return;
+    }
+    // generate the cache key from the file data and settings
     const key = context.useCache ? (getKey(texture) + getHash(context.config)) : undefined;
     let cached = context.useCache && key ? tryGetFromCache(key) : undefined;
     if (cached) {
@@ -143,13 +146,10 @@ async function processTexture(texture, index, document, logger, context) {
     }
     else {
         let mimeType = "image/ktx2";
+        let ktx2Format = undefined;
         const slots = listTextureSlots(texture);
-        // if (slots.includes("metallicRoughnessTexture"))
-        //     mimeType = "image/webp";
+        const size = texture.getSize();
         const isVRM = context.file?.toLowerCase().endsWith(".vrm");
-        if (slots.includes("lightmapTexture") || isLightmap(texture)) {
-            mimeType = "image/webp";
-        }
         // TODO: need to make this into a function
         // const webpThreshold = 256; // this is the default threshold in progressive textures (needle_progressive.ts)
         // console.log(context.file, isVRM);
@@ -161,6 +161,27 @@ async function processTexture(texture, index, document, logger, context) {
         //         mimetype = "image/webp";
         //     }
         // }
+        if (slots.includes("lightmapTexture") || isLightmap(texture)) {
+            mimeType = "image/webp";
+        }
+        // for https://linear.app/needle/issue/NE-6464
+        else if (size[0] <= 32 || size[1] <= 32) {
+            if (canRunToktx) {
+                mimeType = "image/ktx2";
+                ktx2Format = "UASTC";
+            }
+            else {
+                mimeType = "image/webp";
+            }
+        }
+        // For product compression we automatically select webP if the texture is used in a PBR material
+        // https://linear.app/needle/issue/NE-6458
+        else if (context.config.usecase === "product") {
+            const shouldUseWebp = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
+            if (shouldUseWebp) {
+                mimeType = "image/webp";
+            }
+        }
         // If we have a texture cached we can use it
         // the default compression is toktx so we can safely use that for now
         if (cached) {
@@ -178,8 +199,8 @@ async function processTexture(texture, index, document, logger, context) {
             // if we ever change what is used for default compression we need to teach the cache to save the mime type
             // For VRMs we use ETC1S always
             let options = null;
-            if (isVRM) {
-                options = { mode: "ETC1S" };
+            if (ktx2Format || isVRM) {
+                options = { mode: ktx2Format || "ETC1S" };
             }
             successFullyProcessed = await context.toktxContext.process(index, texture, options, context);
         }

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

@@ -1 +1 @@
-export declare const version = "2.7.1";
+export declare const version = "2.8.0-alpha.1";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.7.1";
+export const version = "2.8.0-alpha.1";

package/package.json

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