babylonjs-loaders 9.6.2 → 9.7.0

package/babylonjs.loaders.module.d.ts

@@ -707,6 +707,7 @@ import { IMaterialLoadingAdapter } from "babylonjs-loaders/glTF/2.0/materialLoad
  */
 export class PBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
     private _material;
+    private _specWorkflow;
     /**
      * Creates a new instance of the PBRMaterialLoadingAdapter.
      * @param material - The PBR material to adapt.
@@ -848,6 +849,10 @@ export class PBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param enableEdgeColor Whether to enable OpenPBR BRDF models for edge color support
      */
     enableSpecularEdgeColor(enableEdgeColor?: boolean): void;
+    /**
+     * Enable the specular/glossiness workflow and disable metallic/roughness.
+     */
+    configureSpecularGlossiness(): void;
     /**
      * Sets the specular weight (mapped to PBR metallicF0Factor).
      * @param value The specular weight value
@@ -921,6 +926,16 @@ export class PBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @returns The IOR value
      */
     get specularIor(): number;
+    /**
+     * Sets/gets the glossiness (inverted roughness)
+     * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+     */
+    get glossiness(): number;
+    /**
+     * Sets/gets the glossiness (inverted roughness)
+     * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+     */
+    set glossiness(value: number);
     /**
      * Sets the emission color (mapped to PBR emissiveColor).
      * @param value The emission color as a Color3
@@ -1154,6 +1169,9 @@ export class PBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * Sets up the material for proper thin-surface transmission behavior.
      */
     configureTransmission(): void;
+    /**
+     * Configures volume properties for PBR material. Nothing to do for PBRMaterial.
+     */
     configureVolume(): void;
     /**
      * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -1419,6 +1437,7 @@ import { IMaterialLoadingAdapter } from "babylonjs-loaders/glTF/2.0/materialLoad
  */
 export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
     private _material;
+    private _specWorkflow;
     /**
      * Creates a new instance of the OpenPBRMaterialLoadingAdapter.
      * @param material - The OpenPBR material to adapt.
@@ -1561,6 +1580,7 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param _enableEdgeColor Whether to enable edge color support (ignored for OpenPBR)
      */
     enableSpecularEdgeColor(_enableEdgeColor?: boolean): void;
+    configureSpecularGlossiness(): void;
     /**
      * Sets the specular weight of the OpenPBR material.
      * @param value The specular weight value (0-1)
@@ -1633,6 +1653,11 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @returns The IOR value
      */
     get specularIor(): number;
+    /**
+     * Sets the glossiness (inverted roughness) of the OpenPBR material.
+     */
+    set glossiness(value: number);
+    get glossiness(): number;
     /**
      * Sets the emission color of the OpenPBR material.
      * @param value The emission color as a Color3
@@ -1713,6 +1738,10 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param value The coat color as a Color3
      */
     set coatColor(value: Color3);
+    /**
+     * Gets the coat color of the OpenPBR material.
+     */
+    get coatColor(): Color3;
     /**
      * Sets the coat color texture of the OpenPBR material.
      * @param value The coat color texture or null
@@ -1742,11 +1771,13 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * Sets the coat index of refraction (IOR) of the OpenPBR material.
      */
     set coatIor(value: number);
+    get coatIor(): number;
     /**
      * Sets the coat darkening value of the OpenPBR material.
      * @param value The coat darkening value
      */
     set coatDarkening(value: number);
+    get coatDarkening(): number;
     /**
      * Sets the coat darkening texture (OpenPBR: coatDarkeningTexture, no PBR equivalent)
      */
@@ -1795,6 +1826,7 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param value The transmission weight texture or null
      */
     set transmissionWeightTexture(value: Nullable<BaseTexture>);
+    get transmissionWeightTexture(): Nullable<BaseTexture>;
     /**
      * Gets the transmission weight.
      * @returns Currently returns 0 as transmission is not yet available
@@ -1863,6 +1895,9 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param value The refraction background texture or null
      */
     set refractionBackgroundTexture(value: Nullable<BaseTexture>);
+    /**
+     * Configures volume properties for OpenPBR material.
+     */
     configureVolume(): void;
     /**
      * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -1895,6 +1930,7 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * Sets the subsurface weight texture
      */
     set subsurfaceWeightTexture(value: Nullable<BaseTexture>);
+    get subsurfaceWeightTexture(): Nullable<BaseTexture>;
     /**
      * Sets the subsurface color.
      * @param value The subsurface tint color as a Color3
@@ -2094,7 +2130,13 @@ export class OpenPBRMaterialLoadingAdapter implements IMaterialLoadingAdapter {
      * @param value The scale value for the coat normal texture
      */
     set geometryCoatNormalTextureScale(value: number);
-    finalize(): void;
+    /**
+     * Finalizes material properties after all loading is complete.
+     * @param signal An AbortSignal that fires when the loader is disposed. Intermediate
+     *   textures are disposed and the method returns early when aborted.
+     */
+    finalizeAsync(signal: AbortSignal): Promise<void>;
+    private copySurfaceToCoatAsync;
 }
 
 }
@@ -2112,10 +2154,20 @@ export interface IMaterialLoadingAdapter {
      * Gets the underlying material
      */
     readonly material: Material;
+    /** @deprecated Use finalizeAsync instead. */
+    finalize?(): void;
     /**
-     * Finalizes material properties after loading is complete.
+     * Finalizes material properties after all loading is complete.
+     * May return a Promise for async work (e.g. GPU texture processing). Any returned
+     * Promise is tracked by the loader and awaited before the COMPLETE state is reached,
+     * so callers can rely on onCompleteObservable for fully processed materials.
+     *
+     * The loader passes an AbortSignal that is aborted when the loader is disposed.
+     * Implementations should check `signal.aborted` after each await point and, if
+     * aborted, release any intermediate resources and return early.
+     * @param signal An AbortSignal that fires when the loader is disposed mid-flight.
      */
-    finalize?(): void;
+    finalizeAsync?(signal: AbortSignal): Promise<void> | void;
     /**
      * Whether the material should be treated as unlit
      */
@@ -2177,6 +2229,10 @@ export interface IMaterialLoadingAdapter {
      * @param enableEdgeColor - Whether to enable edge color support
      */
     enableSpecularEdgeColor(enableEdgeColor?: boolean): void;
+    /**
+     * Enable the specular/glossiness workflow and disable metallic/roughness.
+     */
+    configureSpecularGlossiness(): void;
     /**
      * Sets/gets the specular weight
      */
@@ -2205,6 +2261,11 @@ export interface IMaterialLoadingAdapter {
      * Sets/gets the specular IOR
      */
     specularIor: number;
+    /**
+     * Sets/gets the glossiness (inverted roughness)
+     * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+     */
+    glossiness: number;
     /**
      * Sets/gets the emissive color
      */
@@ -2321,6 +2382,9 @@ export interface IMaterialLoadingAdapter {
      * Configures transmission for thin-surface transmission (KHR_materials_transmission)
      */
     configureTransmission(): void;
+    /**
+     * Configures volume properties for volumetric transmission (KHR_materials_volume)
+     */
     configureVolume(): void;
     /**
      * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -3068,6 +3132,8 @@ type PBRMaterialImplementation = {
 export class GLTFLoader implements IGLTFLoader {
     /** @internal */
     readonly _completePromises: Promise<unknown>[];
+    /** AbortController used to cancel in-flight finalizeAsync() calls when dispose() is called. */
+    private _finalizeController;
     /** @internal */
     _assetContainer: Nullable<AssetContainer>;
     /** Storage */
@@ -8543,6 +8609,7 @@ declare namespace BABYLON.GLTF2 {
      */
     export class PBRMaterialLoadingAdapter implements BABYLON.GLTF2.IMaterialLoadingAdapter {
         private _material;
+        private _specWorkflow;
         /**
          * Creates a new instance of the PBRMaterialLoadingAdapter.
          * @param material - The PBR material to adapt.
@@ -8684,6 +8751,10 @@ declare namespace BABYLON.GLTF2 {
          * @param enableEdgeColor Whether to enable OpenPBR BRDF models for edge color support
          */
         enableSpecularEdgeColor(enableEdgeColor?: boolean): void;
+        /**
+         * Enable the specular/glossiness workflow and disable metallic/roughness.
+         */
+        configureSpecularGlossiness(): void;
         /**
          * Sets the specular weight (mapped to PBR metallicF0Factor).
          * @param value The specular weight value
@@ -8757,6 +8828,16 @@ declare namespace BABYLON.GLTF2 {
          * @returns The IOR value
          */
         get specularIor(): number;
+        /**
+         * Sets/gets the glossiness (inverted roughness)
+         * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+         */
+        get glossiness(): number;
+        /**
+         * Sets/gets the glossiness (inverted roughness)
+         * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+         */
+        set glossiness(value: number);
         /**
          * Sets the emission color (mapped to PBR emissiveColor).
          * @param value The emission color as a Color3
@@ -8990,6 +9071,9 @@ declare namespace BABYLON.GLTF2 {
          * Sets up the material for proper thin-surface transmission behavior.
          */
         configureTransmission(): void;
+        /**
+         * Configures volume properties for PBR material. Nothing to do for PBRMaterial.
+         */
         configureVolume(): void;
         /**
          * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -9255,6 +9339,7 @@ declare namespace BABYLON.GLTF2 {
      */
     export class OpenPBRMaterialLoadingAdapter implements BABYLON.GLTF2.IMaterialLoadingAdapter {
         private _material;
+        private _specWorkflow;
         /**
          * Creates a new instance of the OpenPBRMaterialLoadingAdapter.
          * @param material - The OpenPBR material to adapt.
@@ -9397,6 +9482,7 @@ declare namespace BABYLON.GLTF2 {
          * @param _enableEdgeColor Whether to enable edge color support (ignored for OpenPBR)
          */
         enableSpecularEdgeColor(_enableEdgeColor?: boolean): void;
+        configureSpecularGlossiness(): void;
         /**
          * Sets the specular weight of the OpenPBR material.
          * @param value The specular weight value (0-1)
@@ -9469,6 +9555,11 @@ declare namespace BABYLON.GLTF2 {
          * @returns The IOR value
          */
         get specularIor(): number;
+        /**
+         * Sets the glossiness (inverted roughness) of the OpenPBR material.
+         */
+        set glossiness(value: number);
+        get glossiness(): number;
         /**
          * Sets the emission color of the OpenPBR material.
          * @param value The emission color as a Color3
@@ -9549,6 +9640,10 @@ declare namespace BABYLON.GLTF2 {
          * @param value The coat color as a Color3
          */
         set coatColor(value: Color3);
+        /**
+         * Gets the coat color of the OpenPBR material.
+         */
+        get coatColor(): Color3;
         /**
          * Sets the coat color texture of the OpenPBR material.
          * @param value The coat color texture or null
@@ -9578,11 +9673,13 @@ declare namespace BABYLON.GLTF2 {
          * Sets the coat index of refraction (IOR) of the OpenPBR material.
          */
         set coatIor(value: number);
+        get coatIor(): number;
         /**
          * Sets the coat darkening value of the OpenPBR material.
          * @param value The coat darkening value
          */
         set coatDarkening(value: number);
+        get coatDarkening(): number;
         /**
          * Sets the coat darkening texture (OpenPBR: coatDarkeningTexture, no PBR equivalent)
          */
@@ -9631,6 +9728,7 @@ declare namespace BABYLON.GLTF2 {
          * @param value The transmission weight texture or null
          */
         set transmissionWeightTexture(value: Nullable<BaseTexture>);
+        get transmissionWeightTexture(): Nullable<BaseTexture>;
         /**
          * Gets the transmission weight.
          * @returns Currently returns 0 as transmission is not yet available
@@ -9699,6 +9797,9 @@ declare namespace BABYLON.GLTF2 {
          * @param value The refraction background texture or null
          */
         set refractionBackgroundTexture(value: Nullable<BaseTexture>);
+        /**
+         * Configures volume properties for OpenPBR material.
+         */
         configureVolume(): void;
         /**
          * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -9731,6 +9832,7 @@ declare namespace BABYLON.GLTF2 {
          * Sets the subsurface weight texture
          */
         set subsurfaceWeightTexture(value: Nullable<BaseTexture>);
+        get subsurfaceWeightTexture(): Nullable<BaseTexture>;
         /**
          * Sets the subsurface color.
          * @param value The subsurface tint color as a Color3
@@ -9930,7 +10032,13 @@ declare namespace BABYLON.GLTF2 {
          * @param value The scale value for the coat normal texture
          */
         set geometryCoatNormalTextureScale(value: number);
-        finalize(): void;
+        /**
+         * Finalizes material properties after all loading is complete.
+         * @param signal An AbortSignal that fires when the loader is disposed. Intermediate
+         *   textures are disposed and the method returns early when aborted.
+         */
+        finalizeAsync(signal: AbortSignal): Promise<void>;
+        private copySurfaceToCoatAsync;
     }
 
 
@@ -9950,10 +10058,20 @@ declare namespace BABYLON.GLTF2 {
          * Gets the underlying material
          */
         readonly material: Material;
+        /** @deprecated Use finalizeAsync instead. */
+        finalize?(): void;
         /**
-         * Finalizes material properties after loading is complete.
+         * Finalizes material properties after all loading is complete.
+         * May return a Promise for async work (e.g. GPU texture processing). Any returned
+         * Promise is tracked by the loader and awaited before the COMPLETE state is reached,
+         * so callers can rely on onCompleteObservable for fully processed materials.
+         *
+         * The loader passes an AbortSignal that is aborted when the loader is disposed.
+         * Implementations should check `signal.aborted` after each await point and, if
+         * aborted, release any intermediate resources and return early.
+         * @param signal An AbortSignal that fires when the loader is disposed mid-flight.
          */
-        finalize?(): void;
+        finalizeAsync?(signal: AbortSignal): Promise<void> | void;
         /**
          * Whether the material should be treated as unlit
          */
@@ -10015,6 +10133,10 @@ declare namespace BABYLON.GLTF2 {
          * @param enableEdgeColor - Whether to enable edge color support
          */
         enableSpecularEdgeColor(enableEdgeColor?: boolean): void;
+        /**
+         * Enable the specular/glossiness workflow and disable metallic/roughness.
+         */
+        configureSpecularGlossiness(): void;
         /**
          * Sets/gets the specular weight
          */
@@ -10043,6 +10165,11 @@ declare namespace BABYLON.GLTF2 {
          * Sets/gets the specular IOR
          */
         specularIor: number;
+        /**
+         * Sets/gets the glossiness (inverted roughness)
+         * ONLY used for specular/glossiness workflow; has no effect when metallic/roughness workflow is active
+         */
+        glossiness: number;
         /**
          * Sets/gets the emissive color
          */
@@ -10159,6 +10286,9 @@ declare namespace BABYLON.GLTF2 {
          * Configures transmission for thin-surface transmission (KHR_materials_transmission)
          */
         configureTransmission(): void;
+        /**
+         * Configures volume properties for volumetric transmission (KHR_materials_volume)
+         */
         configureVolume(): void;
         /**
          * Sets whether the material is thin-walled (i.e. non-volumetric) or not.
@@ -10876,6 +11006,8 @@ declare namespace BABYLON.GLTF2 {
     export class GLTFLoader implements IGLTFLoader {
         /** @internal */
         readonly _completePromises: Promise<unknown>[];
+        /** AbortController used to cancel in-flight finalizeAsync() calls when dispose() is called. */
+        private _finalizeController;
         /** @internal */
         _assetContainer: Nullable<AssetContainer>;
         /** Storage */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-loaders",
-    "version": "9.6.2",
+    "version": "9.7.0",
     "main": "babylonjs.loaders.min.js",
     "types": "babylonjs.loaders.module.d.ts",
     "files": [
@@ -16,8 +16,8 @@
         "test:escheck": "es-check es6 ./babylonjs.loaders.js"
     },
     "dependencies": {
-        "babylonjs": "9.6.2",
-        "babylonjs-gltf2interface": "9.6.2"
+        "babylonjs": "9.7.0",
+        "babylonjs-gltf2interface": "9.7.0"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",