@babylonjs/core 9.4.1 → 9.5.0

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 } from "../../Misc/decorators.js";
-import { GetEnvironmentBRDFTexture, GetEnvironmentFuzzBRDFTexture } from "../../Misc/brdfTextureTools.js";
+import { GetEnvironmentFuzzBRDFTexture, GetOpenPBREnvironmentBRDFTexture } from "../../Misc/brdfTextureTools.js";
 import { Color3 } from "../../Maths/math.color.js";
 import { ImageProcessingConfiguration } from "../imageProcessingConfiguration.js";
 import { Texture } from "../Textures/texture.js";
@@ -56,6 +56,13 @@ class Uniform {
     }
     constructor(name, componentNum) {
         this.linkedProperties = {};
+        /**
+         * Cached key of the first entry of `linkedProperties`, set when the first
+         * property is linked. Used by the per-frame bind loop to avoid an
+         * `Object.keys(linkedProperties)[0]` allocation when reading scalar
+         * uniforms.
+         */
+        this.firstLinkedKey = "";
         this.name = name;
         this.numComponents = componentNum;
     }
@@ -73,8 +80,11 @@ class Property {
      * @param targetUniformComponentNum The number of components in the target uniform. All properties that are
      * packed into the same uniform must agree on the size of the target uniform.
      * @param targetUniformComponentOffset The offset in the uniform where this property will be packed.
+     * @param requiredDefine Optional define name. When provided, the per-frame
+     *  bind loop will skip pushing the owning uniform to the UBO unless
+     *  `defines[requiredDefine]` is true.
      */
-    constructor(name, defaultValue, targetUniformName, targetUniformComponentNum, targetUniformComponentOffset = 0) {
+    constructor(name, defaultValue, targetUniformName, targetUniformComponentNum, targetUniformComponentOffset = 0, requiredDefine) {
         // public includeAlphaFromProp: string = "";
         /**
          * If not given a type, there will be no uniform defined for this property and
@@ -88,6 +98,7 @@ class Property {
         this.value = defaultValue;
         this.targetUniformComponentNum = targetUniformComponentNum;
         this.targetUniformComponentOffset = targetUniformComponentOffset;
+        this.requiredDefine = requiredDefine;
     }
     /**
      * Returns the number of components of the property based on its default value type.
@@ -242,6 +253,11 @@ export class OpenPBRMaterialDefines extends ImageProcessingDefinesMixin(OpenPBRM
          * Enables the use of screen-space irradiance texture for scattering
          */
         this.USE_IRRADIANCE_TEXTURE_FOR_SCATTERING = false;
+        /**
+         * Indicates that the irradiance texture is from the legacy GeometryBufferRenderer.
+         * We use this to handle direct lights which don't render in the legacy GBuffer irradiance.
+         */
+        this.USE_IRRADIANCE_TEXTURE_FOR_SCATTERING_GBUFFER = false;
         /**
          * Enables transmission slab
          */
@@ -554,14 +570,14 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         this._transmissionDispersionScale = new Property("transmission_dispersion_scale", 0.0, "vTransmissionDispersionScale", 1, 0);
         this._transmissionDispersionScaleTexture = new Sampler("transmission_dispersion_scale", "transmissionDispersionScale", "TRANSMISSION_DISPERSION_SCALE");
         this._transmissionDispersionAbbeNumber = new Property("transmission_dispersion_abbe_number", 20.0, "vTransmissionDispersionAbbeNumber", 1, 0);
-        this._subsurfaceWeight = new Property("subsurface_weight", 0.0, "vSubsurfaceWeight", 1, 0);
+        this._subsurfaceWeight = new Property("subsurface_weight", 0.0, "vSubsurfaceWeight", 1, 0, "SUBSURFACE_SLAB");
         this._subsurfaceWeightTexture = new Sampler("subsurface_weight", "subsurfaceWeight", "SUBSURFACE_WEIGHT");
-        this._subsurfaceColor = new Property("subsurface_color", new Color3(0.8, 0.8, 0.8), "vSubsurfaceColor", 3, 0);
+        this._subsurfaceColor = new Property("subsurface_color", new Color3(0.8, 0.8, 0.8), "vSubsurfaceColor", 3, 0, "SUBSURFACE_SLAB");
         this._subsurfaceColorTexture = new Sampler("subsurface_color", "subsurfaceColor", "SUBSURFACE_COLOR");
-        this._subsurfaceRadius = new Property("subsurface_radius", 1.0, "vSubsurfaceRadius", 1, 0);
-        this._subsurfaceRadiusScale = new Property("subsurface_radius_scale", new Color3(1, 0.5, 0.25), "vSubsurfaceRadiusScale", 3, 0);
+        this._subsurfaceRadius = new Property("subsurface_radius", 1.0, "vSubsurfaceRadius", 1, 0, "SUBSURFACE_SLAB");
+        this._subsurfaceRadiusScale = new Property("subsurface_radius_scale", new Color3(1, 0.5, 0.25), "vSubsurfaceRadiusScale", 3, 0, "SUBSURFACE_SLAB");
         this._subsurfaceRadiusScaleTexture = new Sampler("subsurface_radius_scale", "subsurfaceRadiusScale", "SUBSURFACE_RADIUS_SCALE");
-        this._subsurfaceScatterAnisotropy = new Property("subsurface_scatter_anisotropy", 0.0, "vSubsurfaceScatterAnisotropy", 1, 0);
+        this._subsurfaceScatterAnisotropy = new Property("subsurface_scatter_anisotropy", 0.0, "vSubsurfaceScatterAnisotropy", 1, 0, "SUBSURFACE_SLAB");
         this._coatWeight = new Property("coat_weight", 0.0, "vCoatWeight", 1, 0);
         this._coatWeightTexture = new Sampler("coat_weight", "coatWeight", "COAT_WEIGHT");
         this._coatColor = new Property("coat_color", Color3.White(), "vCoatColor", 3, 0);
@@ -608,6 +624,12 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         this._sssIrradianceTexture = null;
         this._sssDepthTexture = null;
         this._uniformsList = {};
+        /**
+         * Flat array view of `_uniformsList`, populated once at construction. Used
+         * by the per-frame bind loop to avoid `Object.values()` allocation and
+         * closure creation on every submesh binding.
+         */
+        this._uniformsArray = [];
         this._samplersList = {};
         this._samplerDefines = {};
         /**
@@ -995,7 +1017,7 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
             this._callbackPluginEventFillRenderTargetTextures(this._eventInfo);
             return this._renderTargets;
         };
-        this._environmentBRDFTexture = GetEnvironmentBRDFTexture(this.getScene());
+        this._environmentBRDFTexture = GetOpenPBREnvironmentBRDFTexture(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
@@ -1014,13 +1036,23 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
             let uniform = this._uniformsList[prop.targetUniformName];
             if (!uniform) {
                 uniform = new Uniform(prop.targetUniformName, prop.targetUniformComponentNum);
+                uniform.requiredDefine = prop.requiredDefine;
                 this._uniformsList[prop.targetUniformName] = uniform;
             }
             else if (uniform.numComponents !== prop.targetUniformComponentNum) {
                 Logger.Error(`Uniform ${prop.targetUniformName} already exists of size ${uniform.numComponents}, but trying to set it to ${prop.targetUniformComponentNum}.`);
             }
+            else if (uniform.requiredDefine !== prop.requiredDefine) {
+                // Properties packed into the same uniform must share the same gating
+                // define, otherwise we cannot safely skip the per-frame UBO update.
+                uniform.requiredDefine = undefined;
+            }
+            if (uniform.firstLinkedKey === "") {
+                uniform.firstLinkedKey = prop.name;
+            }
             uniform.linkedProperties[prop.name] = prop;
         });
+        this._uniformsArray = Object.values(this._uniformsList);
         // Build the internal list of samplers
         this._samplersList = {};
         for (const key of Object.getOwnPropertyNames(this)) {
@@ -1519,7 +1551,16 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
                 if (this.pointsCloud) {
                     ubo.updateFloat("pointSize", this.pointSize);
                 }
-                Object.values(this._uniformsList).forEach((uniform) => {
+                const uniformsArray = this._uniformsArray;
+                for (let i = 0, len = uniformsArray.length; i < len; i++) {
+                    const uniform = uniformsArray[i];
+                    // Skip uniforms whose define is currently inactive. The shader only
+                    // reads them inside the same #ifdef block, so the UBO bytes can stay
+                    // stale. The full update will happen on the next bind once the
+                    // define becomes active again.
+                    if (uniform.requiredDefine !== undefined && !defines[uniform.requiredDefine]) {
+                        continue;
+                    }
                     // If the property actually defines a uniform, update it.
                     if (uniform.numComponents === 4) {
                         uniform.populateVectorFromLinkedProperties(TmpVectors.Vector4[0]);
@@ -1534,9 +1575,9 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
                         ubo.updateFloat2(uniform.name, TmpVectors.Vector2[0].x, TmpVectors.Vector2[0].y);
                     }
                     else if (uniform.numComponents === 1) {
-                        ubo.updateFloat(uniform.name, uniform.linkedProperties[Object.keys(uniform.linkedProperties)[0]].value);
+                        ubo.updateFloat(uniform.name, uniform.linkedProperties[uniform.firstLinkedKey].value);
                     }
-                });
+                }
                 // Misc
                 this._lightingInfos.x = this.directIntensity;
                 this._lightingInfos.y = this.emissionLuminance;
@@ -1693,7 +1734,7 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
     dispose(forceDisposeEffect, forceDisposeTextures) {
         this._breakShaderLoadedCheck = true;
         if (forceDisposeTextures) {
-            if (this._environmentBRDFTexture && this.getScene().environmentBRDFTexture !== this._environmentBRDFTexture) {
+            if (this._environmentBRDFTexture && this.getScene().openPBREnvironmentBRDFTexture !== this._environmentBRDFTexture) {
                 this._environmentBRDFTexture.dispose();
             }
             if (this._environmentFuzzBRDFTexture && this.getScene().environmentFuzzBRDFTexture !== this._environmentFuzzBRDFTexture) {
@@ -2111,16 +2152,22 @@ export class OpenPBRMaterial extends OpenPBRMaterialBase {
         // Determine whether we should use the prepass irradiance texture for scattering.
         // If this IS a prepass, we don't want to use the irradiance texture as it won't be available yet.
         if (!defines.PREPASS && (defines.SUBSURFACE_SLAB || defines.TRANSMISSION_SLAB_VOLUME)) {
+            let usingGBuffer = false;
             if (!this.sssIrradianceTexture && scene.geometryBufferRenderer) {
                 const irradianceTextureIndex = scene.geometryBufferRenderer.getTextureIndex(GeometryBufferRenderer.IRRADIANCE_TEXTURE_TYPE);
                 this.sssIrradianceTexture = scene.geometryBufferRenderer.getGBuffer().textures[irradianceTextureIndex];
+                usingGBuffer = true;
             }
             if (!this.sssDepthTexture && scene.geometryBufferRenderer) {
                 const depthIndex = scene.geometryBufferRenderer.getTextureIndex(GeometryBufferRenderer.SCREENSPACE_DEPTH_TEXTURE_TYPE);
                 this.sssDepthTexture = scene.geometryBufferRenderer.getGBuffer().textures[depthIndex];
+                usingGBuffer = true;
             }
             if (this.sssIrradianceTexture && this.sssDepthTexture) {
                 defines.USE_IRRADIANCE_TEXTURE_FOR_SCATTERING = true;
+                if (usingGBuffer) {
+                    defines.USE_IRRADIANCE_TEXTURE_FOR_SCATTERING_GBUFFER = true;
+                }
             }
         }
         defines.FUZZ = this.fuzzWeight > 0 && MaterialFlags.ReflectionTextureEnabled;