@onerjs/core 8.26.3 → 8.26.4

package/Materials/Background/backgroundMaterial.js

@@ -1,30 +1,27 @@
 import { __decorate } from "../../tslib.es6.js";
 /* eslint-disable @typescript-eslint/naming-convention */
-import { serialize, serializeAsColor3, expandToProperty, serializeAsTexture, serializeAsVector3 } from "../../Misc/decorators.js";
+import { serialize, serializeAsColor3, expandToProperty, serializeAsTexture, serializeAsVector3, serializeAsImageProcessingConfiguration } from "../../Misc/decorators.js";
 import { SmartArray } from "../../Misc/smartArray.js";
 import { Logger } from "../../Misc/logger.js";
 import { Vector3, Vector4 } from "../../Maths/math.vector.js";
 import { VertexBuffer } from "../../Buffers/buffer.js";
 import { MaterialDefines } from "../../Materials/materialDefines.js";
 import { PushMaterial } from "../../Materials/pushMaterial.js";
-import { ImageProcessingDefinesMixin } from "../../Materials/imageProcessingConfiguration.defines.js";
 import { ImageProcessingConfiguration } from "../../Materials/imageProcessingConfiguration.js";
+import { Texture } from "../../Materials/Textures/texture.js";
 
 import { RegisterClass } from "../../Misc/typeStore.js";
 import { MaterialFlags } from "../materialFlags.js";
 import { Color3 } from "../../Maths/math.color.js";
 import { EffectFallbacks } from "../effectFallbacks.js";
 import { AddClipPlaneUniforms, BindClipPlane } from "../clipPlaneMaterialHelper.js";
-import { BindBonesParameters, BindFogParameters, BindLights, BindLogDepth, BindTextureMatrix, BindIBLParameters, BindIBLSamplers, HandleFallbacksForShadows, PrepareAttributesForBones, PrepareAttributesForInstances, PrepareDefinesForAttributes, PrepareDefinesForFrameBoundValues, PrepareDefinesForLights, PrepareDefinesForIBL, PrepareDefinesForMergedUV, PrepareDefinesForMisc, PrepareDefinesForMultiview, PrepareUniformsAndSamplersList, PrepareUniformsAndSamplersForIBL, PrepareUniformLayoutForIBL, } from "../materialHelper.functions.js";
+import { BindBonesParameters, BindFogParameters, BindLights, BindLogDepth, BindTextureMatrix, HandleFallbacksForShadows, PrepareAttributesForBones, PrepareAttributesForInstances, PrepareDefinesForAttributes, PrepareDefinesForFrameBoundValues, PrepareDefinesForLights, PrepareDefinesForMergedUV, PrepareDefinesForMisc, PrepareDefinesForMultiview, PrepareUniformsAndSamplersList, } from "../materialHelper.functions.js";
 import { SerializationHelper } from "../../Misc/decorators.serialization.js";
-import { ImageProcessingMixin } from "../imageProcessing.js";
-class BackgroundMaterialDefinesBase extends MaterialDefines {
-}
 /**
  * Background material defines definition.
  * @internal Mainly internal Use
  */
-class BackgroundMaterialDefines extends ImageProcessingDefinesMixin(BackgroundMaterialDefinesBase) {
+class BackgroundMaterialDefines extends MaterialDefines {
     /**
      * Constructor of the defines.
      */
@@ -96,6 +93,22 @@ class BackgroundMaterialDefines extends ImageProcessingDefinesMixin(BackgroundMa
          * True if ground projection has been enabled.
          */
         this.PROJECTED_GROUND = false;
+        this.IMAGEPROCESSING = false;
+        this.VIGNETTE = false;
+        this.VIGNETTEBLENDMODEMULTIPLY = false;
+        this.VIGNETTEBLENDMODEOPAQUE = false;
+        this.TONEMAPPING = 0;
+        this.CONTRAST = false;
+        this.COLORCURVES = false;
+        this.COLORGRADING = false;
+        this.COLORGRADING3D = false;
+        this.SAMPLER3DGREENDEPTH = false;
+        this.SAMPLER3DBGRMAP = false;
+        this.DITHER = false;
+        this.IMAGEPROCESSINGPOSTPROCESS = false;
+        this.SKIPFINALCOLORCLAMP = false;
+        this.EXPOSURE = false;
+        this.MULTIVIEW = false;
         // Reflection.
         this.REFLECTION = false;
         this.REFLECTIONMAP_3D = false;
@@ -138,13 +151,11 @@ class BackgroundMaterialDefines extends ImageProcessingDefinesMixin(BackgroundMa
         this.rebuild();
     }
 }
-class BackgroundMaterialBase extends ImageProcessingMixin(PushMaterial) {
-}
 /**
  * Background material used to create an efficient environment around your scene.
  * #157MGZ: simple test
  */
-export class BackgroundMaterial extends BackgroundMaterialBase {
+export class BackgroundMaterial extends PushMaterial {
     /**
      * Experimental Internal Use Only.
      *
@@ -218,6 +229,143 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
         }
         this._fovMultiplier = Math.max(0.0, Math.min(2.0, value));
     }
+    /**
+     * Attaches a new image processing configuration to the PBR Material.
+     * @param configuration (if null the scene configuration will be use)
+     */
+    _attachImageProcessingConfiguration(configuration) {
+        if (configuration === this._imageProcessingConfiguration) {
+            return;
+        }
+        // Detaches observer.
+        if (this._imageProcessingConfiguration && this._imageProcessingObserver) {
+            this._imageProcessingConfiguration.onUpdateParameters.remove(this._imageProcessingObserver);
+        }
+        // Pick the scene configuration if needed.
+        if (!configuration) {
+            this._imageProcessingConfiguration = this.getScene().imageProcessingConfiguration;
+        }
+        else {
+            this._imageProcessingConfiguration = configuration;
+        }
+        // Attaches observer.
+        if (this._imageProcessingConfiguration) {
+            this._imageProcessingObserver = this._imageProcessingConfiguration.onUpdateParameters.add(() => {
+                this._computePrimaryColorFromPerceptualColor();
+                this._markAllSubMeshesAsImageProcessingDirty();
+            });
+        }
+    }
+    /**
+     * Gets the image processing configuration used either in this material.
+     */
+    get imageProcessingConfiguration() {
+        return this._imageProcessingConfiguration;
+    }
+    /**
+     * Sets the Default image processing configuration used either in the this material.
+     *
+     * If sets to null, the scene one is in use.
+     */
+    set imageProcessingConfiguration(value) {
+        this._attachImageProcessingConfiguration(value);
+        // Ensure the effect will be rebuilt.
+        this._markAllSubMeshesAsTexturesDirty();
+    }
+    /**
+     * Gets whether the color curves effect is enabled.
+     */
+    get cameraColorCurvesEnabled() {
+        return this.imageProcessingConfiguration.colorCurvesEnabled;
+    }
+    /**
+     * Sets whether the color curves effect is enabled.
+     */
+    set cameraColorCurvesEnabled(value) {
+        this.imageProcessingConfiguration.colorCurvesEnabled = value;
+    }
+    /**
+     * Gets whether the color grading effect is enabled.
+     */
+    get cameraColorGradingEnabled() {
+        return this.imageProcessingConfiguration.colorGradingEnabled;
+    }
+    /**
+     * Gets whether the color grading effect is enabled.
+     */
+    set cameraColorGradingEnabled(value) {
+        this.imageProcessingConfiguration.colorGradingEnabled = value;
+    }
+    /**
+     * Gets whether tonemapping is enabled or not.
+     */
+    get cameraToneMappingEnabled() {
+        return this._imageProcessingConfiguration.toneMappingEnabled;
+    }
+    /**
+     * Sets whether tonemapping is enabled or not
+     */
+    set cameraToneMappingEnabled(value) {
+        this._imageProcessingConfiguration.toneMappingEnabled = value;
+    }
+    /**
+     * The camera exposure used on this material.
+     * This property is here and not in the camera to allow controlling exposure without full screen post process.
+     * This corresponds to a photographic exposure.
+     */
+    get cameraExposure() {
+        return this._imageProcessingConfiguration.exposure;
+    }
+    /**
+     * The camera exposure used on this material.
+     * This property is here and not in the camera to allow controlling exposure without full screen post process.
+     * This corresponds to a photographic exposure.
+     */
+    set cameraExposure(value) {
+        this._imageProcessingConfiguration.exposure = value;
+    }
+    /**
+     * Gets The camera contrast used on this material.
+     */
+    get cameraContrast() {
+        return this._imageProcessingConfiguration.contrast;
+    }
+    /**
+     * Sets The camera contrast used on this material.
+     */
+    set cameraContrast(value) {
+        this._imageProcessingConfiguration.contrast = value;
+    }
+    /**
+     * Gets the Color Grading 2D Lookup Texture.
+     */
+    get cameraColorGradingTexture() {
+        return this._imageProcessingConfiguration.colorGradingTexture;
+    }
+    /**
+     * Sets the Color Grading 2D Lookup Texture.
+     */
+    set cameraColorGradingTexture(value) {
+        this.imageProcessingConfiguration.colorGradingTexture = value;
+    }
+    /**
+     * The color grading curves provide additional color adjustment that is applied after any color grading transform (3D LUT).
+     * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
+     * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
+     * corresponding to low luminance, medium luminance, and high luminance areas respectively.
+     */
+    get cameraColorCurves() {
+        return this.imageProcessingConfiguration.colorCurves;
+    }
+    /**
+     * The color grading curves provide additional color adjustment that is applied after any color grading transform (3D LUT).
+     * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
+     * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
+     * corresponding to low luminance, medium luminance, and high luminance areas respectively.
+     */
+    set cameraColorCurves(value) {
+        this.imageProcessingConfiguration.colorCurves = value;
+    }
     /**
      * Instantiates a Background Material in the given scene
      * @param name The friendly name of the material
@@ -315,6 +463,10 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
          * Make the material only render shadows
          */
         this.shadowOnly = false;
+        /**
+         * Keep track of the image processing observer to allow dispose and replace.
+         */
+        this._imageProcessingObserver = null;
         /**
          * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
          * Setting this flag to true (not done automatically!) will convert it back to RGB.
@@ -434,14 +586,53 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                     defines.OPACITYFRESNEL = false;
                 }
                 const reflectionTexture = this._reflectionTexture;
-                PrepareDefinesForIBL(scene, reflectionTexture, defines);
                 if (reflectionTexture && MaterialFlags.ReflectionTextureEnabled) {
                     if (!reflectionTexture.isReadyOrNotBlocking()) {
                         return false;
                     }
+                    defines.REFLECTION = true;
+                    defines.GAMMAREFLECTION = reflectionTexture.gammaSpace;
+                    defines.RGBDREFLECTION = reflectionTexture.isRGBD;
+                    defines.REFLECTIONBLUR = this._reflectionBlur > 0;
+                    defines.LODINREFLECTIONALPHA = reflectionTexture.lodLevelInAlpha;
                     defines.EQUIRECTANGULAR_RELFECTION_FOV = this.useEquirectangularFOV;
                     defines.REFLECTIONBGR = this.switchToBGR;
-                    defines.REFLECTIONBLUR = this._reflectionBlur > 0;
+                    if (reflectionTexture.coordinatesMode === Texture.INVCUBIC_MODE) {
+                        defines.INVERTCUBICMAP = true;
+                    }
+                    defines.REFLECTIONMAP_3D = reflectionTexture.isCube;
+                    defines.REFLECTIONMAP_OPPOSITEZ = defines.REFLECTIONMAP_3D && this.getScene().useRightHandedSystem ? !reflectionTexture.invertZ : reflectionTexture.invertZ;
+                    switch (reflectionTexture.coordinatesMode) {
+                        case Texture.EXPLICIT_MODE:
+                            defines.REFLECTIONMAP_EXPLICIT = true;
+                            break;
+                        case Texture.PLANAR_MODE:
+                            defines.REFLECTIONMAP_PLANAR = true;
+                            break;
+                        case Texture.PROJECTION_MODE:
+                            defines.REFLECTIONMAP_PROJECTION = true;
+                            break;
+                        case Texture.SKYBOX_MODE:
+                            defines.REFLECTIONMAP_SKYBOX = true;
+                            break;
+                        case Texture.SPHERICAL_MODE:
+                            defines.REFLECTIONMAP_SPHERICAL = true;
+                            break;
+                        case Texture.EQUIRECTANGULAR_MODE:
+                            defines.REFLECTIONMAP_EQUIRECTANGULAR = true;
+                            break;
+                        case Texture.FIXED_EQUIRECTANGULAR_MODE:
+                            defines.REFLECTIONMAP_EQUIRECTANGULAR_FIXED = true;
+                            break;
+                        case Texture.FIXED_EQUIRECTANGULAR_MIRRORED_MODE:
+                            defines.REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED = true;
+                            break;
+                        case Texture.CUBIC_MODE:
+                        case Texture.INVCUBIC_MODE:
+                        default:
+                            defines.REFLECTIONMAP_CUBIC = true;
+                            break;
+                    }
                     if (this.reflectionFresnel) {
                         defines.REFLECTIONFRESNEL = true;
                         defines.REFLECTIONFALLOFF = this.reflectionFalloffDistance > 0;
@@ -456,9 +647,25 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                     }
                 }
                 else {
+                    defines.REFLECTION = false;
                     defines.REFLECTIONFRESNEL = false;
                     defines.REFLECTIONFALLOFF = false;
                     defines.REFLECTIONBLUR = false;
+                    defines.REFLECTIONMAP_3D = false;
+                    defines.REFLECTIONMAP_SPHERICAL = false;
+                    defines.REFLECTIONMAP_PLANAR = false;
+                    defines.REFLECTIONMAP_CUBIC = false;
+                    defines.REFLECTIONMAP_PROJECTION = false;
+                    defines.REFLECTIONMAP_SKYBOX = false;
+                    defines.REFLECTIONMAP_EXPLICIT = false;
+                    defines.REFLECTIONMAP_EQUIRECTANGULAR = false;
+                    defines.REFLECTIONMAP_EQUIRECTANGULAR_FIXED = false;
+                    defines.REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED = false;
+                    defines.INVERTCUBICMAP = false;
+                    defines.REFLECTIONMAP_OPPOSITEZ = false;
+                    defines.LODINREFLECTIONALPHA = false;
+                    defines.GAMMAREFLECTION = false;
+                    defines.RGBDREFLECTION = false;
                 }
             }
             defines.PREMULTIPLYALPHA = this.alphaMode === 7 || this.alphaMode === 8;
@@ -538,6 +745,9 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                 "mBones",
                 "vPrimaryColor",
                 "vPrimaryColorShadow",
+                "vReflectionInfos",
+                "reflectionMatrix",
+                "vReflectionMicrosurfaceInfos",
                 "fFovMultiplier",
                 "shadowLevel",
                 "alpha",
@@ -549,8 +759,7 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                 "logarithmicDepthConstant",
             ];
             AddClipPlaneUniforms(uniforms);
-            const samplers = ["diffuseSampler"];
-            PrepareUniformsAndSamplersForIBL(uniforms, samplers, false);
+            const samplers = ["diffuseSampler", "reflectionSampler", "reflectionSamplerLow", "reflectionSamplerHigh"];
             const uniformBuffers = ["Material", "Scene"];
             if (ImageProcessingConfiguration) {
                 ImageProcessingConfiguration.PrepareUniforms(uniforms, defines);
@@ -639,7 +848,10 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
         this._uniformBuffer.addUniform("vPrimaryColor", 4);
         this._uniformBuffer.addUniform("vPrimaryColorShadow", 4);
         this._uniformBuffer.addUniform("vDiffuseInfos", 2);
+        this._uniformBuffer.addUniform("vReflectionInfos", 2);
         this._uniformBuffer.addUniform("diffuseMatrix", 16);
+        this._uniformBuffer.addUniform("reflectionMatrix", 16);
+        this._uniformBuffer.addUniform("vReflectionMicrosurfaceInfos", 3);
         this._uniformBuffer.addUniform("fFovMultiplier", 1);
         this._uniformBuffer.addUniform("pointSize", 1);
         this._uniformBuffer.addUniform("shadowLevel", 1);
@@ -647,7 +859,6 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
         this._uniformBuffer.addUniform("vBackgroundCenter", 3);
         this._uniformBuffer.addUniform("vReflectionControl", 4);
         this._uniformBuffer.addUniform("projectedGroundInfos", 2);
-        PrepareUniformLayoutForIBL(this._uniformBuffer, true, false, false);
         this._uniformBuffer.create();
     }
     /**
@@ -702,7 +913,11 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                         this._uniformBuffer.updateFloat2("vDiffuseInfos", this._diffuseTexture.coordinatesIndex, this._diffuseTexture.level);
                         BindTextureMatrix(this._diffuseTexture, this._uniformBuffer, "diffuse");
                     }
-                    BindIBLParameters(scene, defines, this._uniformBuffer, reflectionTexture, false, true);
+                    if (reflectionTexture && MaterialFlags.ReflectionTextureEnabled) {
+                        this._uniformBuffer.updateMatrix("reflectionMatrix", reflectionTexture.getReflectionTextureMatrix());
+                        this._uniformBuffer.updateFloat2("vReflectionInfos", reflectionTexture.level, this._reflectionBlur);
+                        this._uniformBuffer.updateFloat3("vReflectionMicrosurfaceInfos", reflectionTexture.getSize().width, reflectionTexture.lodGenerationScale, reflectionTexture.lodGenerationOffset);
+                    }
                 }
                 if (this.shadowLevel > 0) {
                     this._uniformBuffer.updateFloat("shadowLevel", this.shadowLevel);
@@ -727,7 +942,17 @@ export class BackgroundMaterial extends BackgroundMaterialBase {
                     this._uniformBuffer.setTexture("diffuseSampler", this._diffuseTexture);
                 }
                 if (reflectionTexture && MaterialFlags.ReflectionTextureEnabled) {
-                    BindIBLSamplers(scene, defines, this._uniformBuffer, reflectionTexture);
+                    if (defines.REFLECTIONBLUR && defines.TEXTURELODSUPPORT) {
+                        this._uniformBuffer.setTexture("reflectionSampler", reflectionTexture);
+                    }
+                    else if (!defines.REFLECTIONBLUR) {
+                        this._uniformBuffer.setTexture("reflectionSampler", reflectionTexture);
+                    }
+                    else {
+                        this._uniformBuffer.setTexture("reflectionSampler", reflectionTexture._lodTextureMid || reflectionTexture);
+                        this._uniformBuffer.setTexture("reflectionSamplerLow", reflectionTexture._lodTextureLow || reflectionTexture);
+                        this._uniformBuffer.setTexture("reflectionSamplerHigh", reflectionTexture._lodTextureHigh || reflectionTexture);
+                    }
                     if (defines.REFLECTIONFRESNEL) {
                         this._uniformBuffer.updateFloat3("vBackgroundCenter", this.sceneCenter.x, this.sceneCenter.y, this.sceneCenter.z);
                         this._uniformBuffer.updateFloat4("vReflectionControl", this._reflectionControls.x, this._reflectionControls.y, this._reflectionControls.z, this._reflectionControls.w);
@@ -956,6 +1181,9 @@ __decorate([
 __decorate([
     expandToProperty("_markAllSubMeshesAsLightsDirty")
 ], BackgroundMaterial.prototype, "shadowOnly", void 0);
+__decorate([
+    serializeAsImageProcessingConfiguration()
+], BackgroundMaterial.prototype, "_imageProcessingConfiguration", void 0);
 __decorate([
     serialize(),
     expandToProperty("_markAllSubMeshesAsMiscDirty")