@onerjs/core 8.28.2 → 8.28.4

package/Materials/PBR/openPbrMaterial.d.ts

@@ -85,6 +85,7 @@ export declare class OpenPBRMaterialDefines extends OpenPBRMaterialDefines_base
     THIN_FILM_THICKNESS_FROM_THIN_FILM_TEXTURE: boolean;
     ENVIRONMENTBRDF: boolean;
     ENVIRONMENTBRDF_RGBD: boolean;
+    FUZZENVIRONMENTBRDF: boolean;
     NORMAL: boolean;
     TANGENT: boolean;
     OBJECTSPACE_NORMALMAP: boolean;
@@ -92,10 +93,26 @@ export declare class OpenPBRMaterialDefines extends OpenPBRMaterialDefines_base
     PARALLAX_RHS: boolean;
     PARALLAXOCCLUSION: boolean;
     NORMALXYSCALE: boolean;
+    /**
+     * Enables anisotropic logic. Still needed because it's used in pbrHelperFunctions
+     */
     ANISOTROPIC: boolean;
+    /**
+     * Tells the shader to use OpenPBR's anisotropic roughness remapping
+     */
     ANISOTROPIC_OPENPBR: boolean;
+    /**
+     * Tells the shader to apply anisotropy to the base layer
+     */
     ANISOTROPIC_BASE: boolean;
+    /**
+     * Tells the shader to apply anisotropy to the coat layer
+     */
     ANISOTROPIC_COAT: boolean;
+    /**
+     * Tells the shader to enable the fuzz layer
+     */
+    FUZZ: boolean;
     THIN_FILM: boolean;
     IRIDESCENCE: boolean;
     REFLECTION: boolean;
@@ -424,6 +441,42 @@ export declare class OpenPBRMaterial extends OpenPBRMaterialBase {
      * same texture as the coat_weight.
      */
     useCoatRoughnessFromWeightTexture: boolean;
+    /**
+     * Defines the weight of the fuzz layer on the surface.
+     * See OpenPBR's specs for fuzz_weight
+     */
+    fuzzWeight: number;
+    private _fuzzWeight;
+    /**
+     * Weight texture of the fuzz layer.
+     * See OpenPBR's specs for fuzz_weight
+     */
+    fuzzWeightTexture: Nullable<BaseTexture>;
+    private _fuzzWeightTexture;
+    /**
+     * Defines the color of the fuzz layer on the surface.
+     * See OpenPBR's specs for fuzz_color
+     */
+    fuzzColor: Color3;
+    private _fuzzColor;
+    /**
+     * Color texture of the fuzz layer.
+     * See OpenPBR's specs for fuzz_color
+     */
+    fuzzColorTexture: Nullable<BaseTexture>;
+    private _fuzzColorTexture;
+    /**
+     * Defines the roughness of the fuzz layer on the surface.
+     * See OpenPBR's specs for fuzz_roughness
+     */
+    fuzzRoughness: number;
+    private _fuzzRoughness;
+    /**
+     * Roughness texture of the fuzz layer.
+     * See OpenPBR's specs for fuzz_roughness
+     */
+    fuzzRoughnessTexture: Nullable<BaseTexture>;
+    private _fuzzRoughnessTexture;
     /**
      * Defines the normal of the material's geometry.
      * See OpenPBR's specs for geometry_normal
@@ -844,6 +897,13 @@ export declare class OpenPBRMaterial extends OpenPBRMaterialBase {
      * @internal
      */
     _environmentBRDFTexture: Nullable<BaseTexture>;
+    /**
+     * Specifies the environment BRDF texture used to compute the scale and offset roughness values
+     * from cos theta and roughness for the fuzz layer:
+     * https://github.com/tizian/ltc-sheen?tab=readme-ov-file
+     * @internal
+     */
+    _environmentFuzzBRDFTexture: Nullable<BaseTexture>;
     /**
      * Force the shader to compute irradiance in the fragment shader in order to take normal mapping into account.
      * @internal

package/Materials/PBR/openPbrMaterial.js

@@ -1,7 +1,7 @@
 import { __decorate } from "../../tslib.es6.js";
 /* eslint-disable @typescript-eslint/naming-convention */
 import { serialize, expandToProperty, addAccessorsForMaterialProperty, serializeAsTexture, serializeAsColor3, serializeAsVector2 } from "../../Misc/decorators.js";
-import { GetEnvironmentBRDFTexture } from "../../Misc/brdfTextureTools.js";
+import { GetEnvironmentBRDFTexture, GetEnvironmentFuzzBRDFTexture } from "../../Misc/brdfTextureTools.js";
 import { Scene } from "../../scene.js";
 import { Color3 } from "../../Maths/math.color.js";
 import { ImageProcessingConfiguration } from "../imageProcessingConfiguration.js";
@@ -181,6 +181,7 @@ export class OpenPBRMaterialDefines extends ImageProcessingDefinesMixin(OpenPBRM
         this.THIN_FILM_THICKNESS_FROM_THIN_FILM_TEXTURE = false;
         this.ENVIRONMENTBRDF = false;
         this.ENVIRONMENTBRDF_RGBD = false;
+        this.FUZZENVIRONMENTBRDF = false;
         this.NORMAL = false;
         this.TANGENT = false;
         this.OBJECTSPACE_NORMALMAP = false;
@@ -188,12 +189,28 @@ export class OpenPBRMaterialDefines extends ImageProcessingDefinesMixin(OpenPBRM
         this.PARALLAX_RHS = false;
         this.PARALLAXOCCLUSION = false;
         this.NORMALXYSCALE = true;
-        this.ANISOTROPIC = false; // Enables anisotropic logic. Still needed because it's used in pbrHelperFunctions
-        this.ANISOTROPIC_OPENPBR = true; // Tells the shader to use OpenPBR's anisotropic roughness remapping
-        this.ANISOTROPIC_BASE = false; // Tells the shader to apply anisotropy to the base layer
-        this.ANISOTROPIC_COAT = false; // Tells the shader to apply anisotropy to the coat layer
+        /**
+         * Enables anisotropic logic. Still needed because it's used in pbrHelperFunctions
+         */
+        this.ANISOTROPIC = false;
+        /**
+         * Tells the shader to use OpenPBR's anisotropic roughness remapping
+         */
+        this.ANISOTROPIC_OPENPBR = true;
+        /**
+         * Tells the shader to apply anisotropy to the base layer
+         */
+        this.ANISOTROPIC_BASE = false;
+        /**
+         * Tells the shader to apply anisotropy to the coat layer
+         */
+        this.ANISOTROPIC_COAT = false;
+        /**
+         * Tells the shader to enable the fuzz layer
+         */
+        this.FUZZ = false;
         this.THIN_FILM = false; // Enables thin film layer
-        this.IRIDESCENCE = false; // Enables iridescence layer
+        this.IRIDESCENCE = false; // Enables legacy iridescence code
         this.REFLECTION = false;
         this.REFLECTIONMAP_3D = false;
         this.REFLECTIONMAP_SPHERICAL = false;
@@ -483,6 +500,12 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
          * same texture as the coat_weight.
          */
         this.useCoatRoughnessFromWeightTexture = false;
+        this._fuzzWeight = new Property("fuzz_weight", 0.0, "vFuzzWeight", 1, 0);
+        this._fuzzWeightTexture = new Sampler("fuzz_weight", "fuzzWeight", "FUZZ_WEIGHT");
+        this._fuzzColor = new Property("fuzz_color", Color3.White(), "vFuzzColor", 3, 0);
+        this._fuzzColorTexture = new Sampler("fuzz_color", "fuzzColor", "FUZZ_COLOR");
+        this._fuzzRoughness = new Property("fuzz_roughness", 0.5, "vFuzzRoughness", 1, 0);
+        this._fuzzRoughnessTexture = new Sampler("fuzz_roughness", "fuzzRoughness", "FUZZ_ROUGHNESS");
         this._geometryNormalTexture = new Sampler("geometry_normal", "geometryNormal", "GEOMETRY_NORMAL");
         this._geometryTangent = new Property("geometry_tangent", new Vector2(1, 0), "vSpecularAnisotropy", 3, 0);
         this._geometryTangentTexture = new Sampler("geometry_tangent", "geometryTangent", "GEOMETRY_TANGENT");
@@ -775,6 +798,13 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
          * @internal
          */
         this._environmentBRDFTexture = null;
+        /**
+         * Specifies the environment BRDF texture used to compute the scale and offset roughness values
+         * from cos theta and roughness for the fuzz layer:
+         * https://github.com/tizian/ltc-sheen?tab=readme-ov-file
+         * @internal
+         */
+        this._environmentFuzzBRDFTexture = null;
         /**
          * Force the shader to compute irradiance in the fragment shader in order to take normal mapping into account.
          * @internal
@@ -858,6 +888,7 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
             return this._renderTargets;
         };
         this._environmentBRDFTexture = GetEnvironmentBRDFTexture(this.getScene());
+        this._environmentFuzzBRDFTexture = GetEnvironmentFuzzBRDFTexture(this.getScene());
         this.prePassConfiguration = new PrePassConfiguration();
         // Build the internal property list that can be used to generate and update the uniform buffer
         this._propertyList = {};
@@ -927,6 +958,12 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         this._coatIor;
         this._coatDarkening;
         this._coatDarkeningTexture;
+        this._fuzzWeight;
+        this._fuzzWeightTexture;
+        this._fuzzColor;
+        this._fuzzColorTexture;
+        this._fuzzRoughness;
+        this._fuzzRoughnessTexture;
         this._geometryNormalTexture;
         this._geometryTangent;
         this._geometryTangentTexture;
@@ -1141,6 +1178,12 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
                         return false;
                     }
                 }
+                if (this._environmentFuzzBRDFTexture && MaterialFlags.ReflectionTextureEnabled) {
+                    // This is blocking.
+                    if (!this._environmentFuzzBRDFTexture.isReady()) {
+                        return false;
+                    }
+                }
                 if (OpenPBRMaterial._noiseTextures[scene.uniqueId]) {
                     if (!OpenPBRMaterial._noiseTextures[scene.uniqueId].isReady()) {
                         return false;
@@ -1339,7 +1382,10 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
                 if (defines.ENVIRONMENTBRDF) {
                     ubo.setTexture("environmentBrdfSampler", this._environmentBRDFTexture);
                 }
-                if (defines.ANISOTROPIC) {
+                if (defines.FUZZENVIRONMENTBRDF) {
+                    ubo.setTexture("environmentFuzzBrdfSampler", this._environmentFuzzBRDFTexture);
+                }
+                if (defines.ANISOTROPIC || defines.FUZZ) {
                     ubo.setTexture("blueNoiseSampler", OpenPBRMaterial._noiseTextures[this.getScene().uniqueId]);
                 }
             }
@@ -1460,6 +1506,9 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
             if (this._environmentBRDFTexture && this.getScene().environmentBRDFTexture !== this._environmentBRDFTexture) {
                 this._environmentBRDFTexture.dispose();
             }
+            if (this._environmentFuzzBRDFTexture && this.getScene().environmentFuzzBRDFTexture !== this._environmentFuzzBRDFTexture) {
+                this._environmentFuzzBRDFTexture.dispose();
+            }
             // Loop through samplers and dispose the textures
             for (const key in this._samplersList) {
                 const sampler = this._samplersList[key];
@@ -1484,6 +1533,9 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         return this.getScene().environmentTexture;
     }
     _prepareEffect(mesh, renderingMesh, defines, onCompiled = null, onError = null, useInstances = null, useClipPlane = null) {
+        if (this.fuzzWeight > 0) {
+            this._environmentFuzzBRDFTexture = GetEnvironmentFuzzBRDFTexture(this.getScene());
+        }
         this._prepareDefines(mesh, renderingMesh, defines, useInstances, useClipPlane);
         if (!defines.isDirty) {
             return null;
@@ -1593,6 +1645,7 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         }
         const samplers = [
             "environmentBrdfSampler",
+            "environmentFuzzBrdfSampler",
             "blueNoiseSampler",
             "boneSampler",
             "morphTargets",
@@ -1747,6 +1800,12 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
                     defines.ENVIRONMENTBRDF = false;
                     defines.ENVIRONMENTBRDF_RGBD = false;
                 }
+                if (this._environmentFuzzBRDFTexture) {
+                    defines.FUZZENVIRONMENTBRDF = true;
+                }
+                else {
+                    defines.FUZZENVIRONMENTBRDF = false;
+                }
                 if (this._shouldUseAlphaFromBaseColorTexture()) {
                     defines.ALPHA_FROM_BASE_COLOR_TEXTURE = true;
                 }
@@ -1812,6 +1871,14 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         }
         defines.THIN_FILM = this.thinFilmWeight > 0.0;
         defines.IRIDESCENCE = this.thinFilmWeight > 0.0;
+        if (this.fuzzWeight > 0 && MaterialFlags.ReflectionTextureEnabled) {
+            defines.FUZZ = true;
+            if (!mesh.isVerticesDataPresent(VertexBuffer.TangentKind)) {
+                defines._needUVs = true;
+                defines.MAINUV1 = true;
+            }
+            this._environmentFuzzBRDFTexture = GetEnvironmentFuzzBRDFTexture(this.getScene());
+        }
         // Misc.
         if (defines._areMiscDirty) {
             PrepareDefinesForMisc(mesh, scene, this._useLogarithmicDepth, this.pointsCloud, this.fogEnabled, this.needAlphaTestingForMesh(mesh), defines, this._applyDecalMapAfterDetailMap, this._useVertexPulling, renderingMesh, this._setVertexOutputInvariant);
@@ -2035,6 +2102,30 @@ __decorate([
 __decorate([
     serialize()
 ], OpenPBRMaterial.prototype, "useCoatRoughnessFromWeightTexture", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzWeight")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzWeight", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzWeightTexture")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzWeightTexture", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzColor")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzColor", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzColorTexture")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzColorTexture", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzRoughness")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzRoughness", void 0);
+__decorate([
+    addAccessorsForMaterialProperty("_markAllSubMeshesAsTexturesDirty", "fuzzRoughnessTexture")
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+], OpenPBRMaterial.prototype, "_fuzzRoughnessTexture", void 0);
 __decorate([
     serializeAsTexture()
 ], OpenPBRMaterial.prototype, "geometryNormalTexture", void 0);