@needle-tools/gltf-build-pipeline 2.8.1 → 2.9.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.9.0] - 2024-05-22
+- add: initial texture compression mode support for `world` and `product`
+
 ## [2.8.1] - 2024-04-17
 - bump version
 

package/dist/extensions/NEEDLE_compression_texture/NEEDLE_compression_texture.d.ts

@@ -1,7 +1,7 @@
 import { Extension, ExtensionProperty, PropertyType, ReaderContext, WriterContext } from "@gltf-transform/core";
 export declare const EXTENSION_NAME = "NEEDLE_compression_texture";
 export declare interface NEEDLE_compression_texture_schema {
-    mode: "none" | "auto" | "webp" | "UASTC" | "ETC1S";
+    mode: "none" | "auto" | "webp" | "UASTC" | "ETC1S" | "world" | "product";
     slot: string;
     /** quality in range of 0 - 1 */
     quality: number;

package/dist/transforms/needle_texture_transform.js

@@ -117,6 +117,23 @@ async function processTexture(texture, index, document, logger, context) {
     const canRunToktx = context.noToktx !== true;
     const originalUri = texture.getURI();
     if (compressionSettings && compressionSettings.mode !== "auto") {
+        // Handle highlevel modes
+        switch (compressionSettings.mode) {
+            case "world":
+                compressionSettings.mode = "ETC1S";
+                break;
+            case "product":
+                switch (compressionSettings.slot) {
+                    case "baseColorTexture":
+                    case "normalTexture":
+                    case "metallicRoughnessTexture":
+                    case "lightmapTexture":
+                        compressionSettings.mode = "webp";
+                        compressionSettings.quality = 0.95;
+                        break;
+                }
+                break;
+        }
         switch (compressionSettings.mode) {
             case "webp":
                 if (cached) {
@@ -147,7 +164,6 @@ async function processTexture(texture, index, document, logger, context) {
     else {
         let mimeType = "image/ktx2";
         let ktx2Format = undefined;
-        let webpOptions = {};
         const slots = listTextureSlots(texture);
         const size = texture.getSize();
         const isVRM = context.file?.toLowerCase().endsWith(".vrm");
@@ -162,6 +178,7 @@ async function processTexture(texture, index, document, logger, context) {
         //         mimetype = "image/webp";
         //     }
         // }
+        const webpOptions = {};
         if (slots.includes("lightmapTexture") || isLightmap(texture)) {
             mimeType = "image/webp";
         }
@@ -172,6 +189,7 @@ async function processTexture(texture, index, document, logger, context) {
         }
         // For product compression we automatically select webP if the texture is used in a PBR material
         // https://linear.app/needle/issue/NE-6458
+        // TODO: this should probably moved to the top and we should create a compression settings object
         else if (context.config.usecase === "product") {
             const shouldUseWebp = slots.includes("normalTexture") || slots.includes("metallicRoughnessTexture");
             if (shouldUseWebp) {

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

@@ -1 +1 @@
-export declare const version = "2.8.1";
+export declare const version = "2.9.1";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.8.1";
+export const version = "2.9.1";

package/package.json

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