@needle-tools/gltf-build-pipeline 2.8.0-alpha.0 → 2.8.0-alpha.2

package/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.2] - 2024-03-04
+- change: use webp compression for textures smaller than 32x32
+- fix: webp compression for small textures (64x64)
+
 ## [2.8.0-alpha.0] - 2024-02-27
 - change: `product` usecase now uses webp compression for 'normalTexture' and 'metallicRoughnessTexture' textures
 

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -954,7 +954,7 @@ class MeshIndexResolver extends PointerResolver {
                 if (parent instanceof Node) {
                     obj = parent.getMesh();
                     if (obj) {
-                        console.log(`INFO: resolved mesh \"${this.inputObject.getName()}\" from parent node \"${parent.getName()}\"`);
+                        this.document.getLogger().info(`INFO: resolved mesh \"${this.inputObject.getName()}\" from parent node \"${parent.getName()}\"`);
                         break;
                     }
                 }

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,11 @@ async function processTexture(texture, index, document, logger, context) {
     }
     else {
         let mimeType = "image/ktx2";
+        let ktx2Format = undefined;
+        let webpOptions = {};
         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,9 +162,17 @@ 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) {
+            // can not use UASTC because it's ALSO shitty, see issue above
+            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
-        if (context.config.usecase === "product") {
+        else if (context.config.usecase === "product") {
             const shouldUseWebp = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
             if (shouldUseWebp) {
                 mimeType = "image/webp";
@@ -178,6 +187,7 @@ async function processTexture(texture, index, document, logger, context) {
         await resizeTextureIfNecessary(texture);
         if (mimeType === "image/webp") {
             successFullyProcessed = await context.webPContext.process(index, texture, {
+                ...webpOptions,
                 quality: .9,
             }, context);
         }
@@ -186,8 +196,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/transforms/needle_webp.d.ts

@@ -1,6 +1,7 @@
 import { Document, ILogger, Texture } from '@gltf-transform/core';
 import { NEEDLE_compression_texture_schema } from '../extensions/index.js';
 import { INeedleTextureTransformContext, NeedleTransformContext } from './needle_common.js';
+import sharp from 'sharp';
 export interface NeedleWebPOptions {
 }
 export declare class NeedleWebPContext implements INeedleTextureTransformContext {
@@ -9,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">, context: NeedleTransformContext): Promise<boolean>;
+    process(index: number, texture: Texture, settings: Pick<NEEDLE_compression_texture_schema, "quality"> & Partial<sharp.WebpOptions>, context: NeedleTransformContext): Promise<boolean>;
     finalize(document: Document): Promise<void>;
 }

package/dist/transforms/needle_webp.js

@@ -13,7 +13,15 @@ export class NeedleWebPContext {
         this.logger = document.getLogger();
     }
     async process(index, texture, settings, context) {
+        const size = texture.getSize();
+        // if the texture is too small we will use lossless compression
+        let lossless = false;
+        if (size[0] < 64 || size[1] < 64) {
+            lossless = true;
+        }
         const options = {
+            lossless,
+            ...settings,
             quality: settings.quality,
             // effort: remap(options.effort, 100, 6),
             // lossless: options.lossless,

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

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

package/dist/utils/version.gen.js

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

package/package.json

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