@babylonjs/core 5.45.2 → 5.47.0

package/Rendering/geometryBufferRenderer.js

@@ -10,54 +10,35 @@ import { Material } from "../Materials/material.js";
 import "../Shaders/geometry.fragment.js";
 import "../Shaders/geometry.vertex.js";
 import { MaterialFlags } from "../Materials/materialFlags.js";
+import { addClipPlaneUniforms, bindClipPlane, prepareDefinesForClipPlanes } from "../Materials/clipPlaneMaterialHelper.js";
+/** list the uniforms used by the geometry renderer */
+const uniforms = [
+    "world",
+    "mBones",
+    "viewProjection",
+    "diffuseMatrix",
+    "view",
+    "previousWorld",
+    "previousViewProjection",
+    "mPreviousBones",
+    "bumpMatrix",
+    "reflectivityMatrix",
+    "albedoMatrix",
+    "reflectivityColor",
+    "albedoColor",
+    "metallic",
+    "glossiness",
+    "vTangentSpaceParams",
+    "vBumpInfos",
+    "morphTargetInfluences",
+    "morphTargetTextureInfo",
+    "morphTargetTextureIndices",
+];
+addClipPlaneUniforms(uniforms);
 /**
  * This renderer is helpful to fill one of the render target with a geometry buffer.
  */
 export class GeometryBufferRenderer {
-    /**
-     * Creates a new G Buffer for the scene
-     * @param scene The scene the buffer belongs to
-     * @param ratio How big is the buffer related to the main canvas (default: 1)
-     * @param depthFormat Format of the depth texture (default: 15)
-     */
-    constructor(scene, ratio = 1, depthFormat = 15) {
-        /**
-         * Dictionary used to store the previous transformation matrices of each rendered mesh
-         * in order to compute objects velocities when enableVelocity is set to "true"
-         * @internal
-         */
-        this._previousTransformationMatrices = {};
-        /**
-         * Dictionary used to store the previous bones transformation matrices of each rendered mesh
-         * in order to compute objects velocities when enableVelocity is set to "true"
-         * @internal
-         */
-        this._previousBonesTransformationMatrices = {};
-        /**
-         * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
-         * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
-         */
-        this.excludedSkinnedMeshesFromVelocity = [];
-        /** Gets or sets a boolean indicating if transparent meshes should be rendered */
-        this.renderTransparentMeshes = true;
-        this._resizeObserver = null;
-        this._enablePosition = false;
-        this._enableVelocity = false;
-        this._enableReflectivity = false;
-        this._positionIndex = -1;
-        this._velocityIndex = -1;
-        this._reflectivityIndex = -1;
-        this._depthIndex = -1;
-        this._normalIndex = -1;
-        this._linkedWithPrePass = false;
-        this._scene = scene;
-        this._ratio = ratio;
-        this._useUbo = scene.getEngine().supportsUniformBuffers;
-        this._depthFormat = depthFormat;
-        GeometryBufferRenderer._SceneComponentInitialization(this._scene);
-        // Render target
-        this._createRenderTargets();
-    }
     /**
      * @internal
      * Sets up internal structures to share outputs with PrePassRenderer
@@ -240,6 +221,50 @@ export class GeometryBufferRenderer {
     get ratio() {
         return this._ratio;
     }
+    /**
+     * Creates a new G Buffer for the scene
+     * @param scene The scene the buffer belongs to
+     * @param ratio How big is the buffer related to the main canvas (default: 1)
+     * @param depthFormat Format of the depth texture (default: 15)
+     */
+    constructor(scene, ratio = 1, depthFormat = 15) {
+        /**
+         * Dictionary used to store the previous transformation matrices of each rendered mesh
+         * in order to compute objects velocities when enableVelocity is set to "true"
+         * @internal
+         */
+        this._previousTransformationMatrices = {};
+        /**
+         * Dictionary used to store the previous bones transformation matrices of each rendered mesh
+         * in order to compute objects velocities when enableVelocity is set to "true"
+         * @internal
+         */
+        this._previousBonesTransformationMatrices = {};
+        /**
+         * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
+         * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
+         */
+        this.excludedSkinnedMeshesFromVelocity = [];
+        /** Gets or sets a boolean indicating if transparent meshes should be rendered */
+        this.renderTransparentMeshes = true;
+        this._resizeObserver = null;
+        this._enablePosition = false;
+        this._enableVelocity = false;
+        this._enableReflectivity = false;
+        this._positionIndex = -1;
+        this._velocityIndex = -1;
+        this._reflectivityIndex = -1;
+        this._depthIndex = -1;
+        this._normalIndex = -1;
+        this._linkedWithPrePass = false;
+        this._scene = scene;
+        this._ratio = ratio;
+        this._useUbo = scene.getEngine().supportsUniformBuffers;
+        this._depthFormat = depthFormat;
+        GeometryBufferRenderer._SceneComponentInitialization(this._scene);
+        // Render target
+        this._createRenderTargets();
+    }
     /**
      * Checks whether everything is ready to render a submesh to the G buffer.
      * @param subMesh the submesh to check readiness for
@@ -470,6 +495,7 @@ export class GeometryBufferRenderer {
         else {
             defines.push("#define RENDER_TARGET_COUNT " + this._multiRenderTarget.textures.length);
         }
+        prepareDefinesForClipPlanes(material, this._scene, defines);
         // Get correct effect
         const engine = this._scene.getEngine();
         const drawWrapper = subMesh._getDrawWrapper(undefined, true);
@@ -478,28 +504,7 @@ export class GeometryBufferRenderer {
         if (cachedDefines !== join) {
             drawWrapper.setEffect(engine.createEffect("geometry", {
                 attributes: attribs,
-                uniformsNames: [
-                    "world",
-                    "mBones",
-                    "viewProjection",
-                    "diffuseMatrix",
-                    "view",
-                    "previousWorld",
-                    "previousViewProjection",
-                    "mPreviousBones",
-                    "bumpMatrix",
-                    "reflectivityMatrix",
-                    "albedoMatrix",
-                    "reflectivityColor",
-                    "albedoColor",
-                    "metallic",
-                    "glossiness",
-                    "vTangentSpaceParams",
-                    "vBumpInfos",
-                    "morphTargetInfluences",
-                    "morphTargetTextureInfo",
-                    "morphTargetTextureIndices",
-                ],
+                uniformsNames: uniforms,
                 samplers: ["diffuseSampler", "bumpSampler", "reflectivitySampler", "albedoSampler", "morphTargets"],
                 defines: join,
                 onCompiled: null,
@@ -637,124 +642,124 @@ export class GeometryBufferRenderer {
                     MaterialHelper.BindSceneUniformBuffer(effect, this._scene.getSceneUniformBuffer());
                     this._scene.finalizeSceneUbo();
                 }
-                if (material) {
-                    let sideOrientation;
-                    const instanceDataStorage = renderingMesh._instanceDataStorage;
-                    if (!instanceDataStorage.isFrozen && (material.backFaceCulling || renderingMesh.overrideMaterialSideOrientation !== null)) {
-                        const mainDeterminant = effectiveMesh._getWorldMatrixDeterminant();
-                        sideOrientation = renderingMesh.overrideMaterialSideOrientation;
-                        if (sideOrientation === null) {
-                            sideOrientation = material.sideOrientation;
-                        }
-                        if (mainDeterminant < 0) {
-                            sideOrientation = sideOrientation === Material.ClockWiseSideOrientation ? Material.CounterClockWiseSideOrientation : Material.ClockWiseSideOrientation;
-                        }
+                let sideOrientation;
+                const instanceDataStorage = renderingMesh._instanceDataStorage;
+                if (!instanceDataStorage.isFrozen && (material.backFaceCulling || renderingMesh.overrideMaterialSideOrientation !== null)) {
+                    const mainDeterminant = effectiveMesh._getWorldMatrixDeterminant();
+                    sideOrientation = renderingMesh.overrideMaterialSideOrientation;
+                    if (sideOrientation === null) {
+                        sideOrientation = material.sideOrientation;
                     }
-                    else {
-                        sideOrientation = instanceDataStorage.sideOrientation;
+                    if (mainDeterminant < 0) {
+                        sideOrientation = sideOrientation === Material.ClockWiseSideOrientation ? Material.CounterClockWiseSideOrientation : Material.ClockWiseSideOrientation;
                     }
-                    material._preBind(drawWrapper, sideOrientation);
-                    // Alpha test
-                    if (material.needAlphaTesting()) {
-                        const alphaTexture = material.getAlphaTestTexture();
-                        if (alphaTexture) {
-                            effect.setTexture("diffuseSampler", alphaTexture);
-                            effect.setMatrix("diffuseMatrix", alphaTexture.getTextureMatrix());
-                        }
+                }
+                else {
+                    sideOrientation = instanceDataStorage.sideOrientation;
+                }
+                material._preBind(drawWrapper, sideOrientation);
+                // Alpha test
+                if (material.needAlphaTesting()) {
+                    const alphaTexture = material.getAlphaTestTexture();
+                    if (alphaTexture) {
+                        effect.setTexture("diffuseSampler", alphaTexture);
+                        effect.setMatrix("diffuseMatrix", alphaTexture.getTextureMatrix());
                     }
-                    // Bump
-                    if (material.bumpTexture && scene.getEngine().getCaps().standardDerivatives && MaterialFlags.BumpTextureEnabled) {
-                        effect.setFloat3("vBumpInfos", material.bumpTexture.coordinatesIndex, 1.0 / material.bumpTexture.level, material.parallaxScaleBias);
-                        effect.setMatrix("bumpMatrix", material.bumpTexture.getTextureMatrix());
-                        effect.setTexture("bumpSampler", material.bumpTexture);
-                        effect.setFloat2("vTangentSpaceParams", material.invertNormalMapX ? -1.0 : 1.0, material.invertNormalMapY ? -1.0 : 1.0);
+                }
+                // Bump
+                if (material.bumpTexture && scene.getEngine().getCaps().standardDerivatives && MaterialFlags.BumpTextureEnabled) {
+                    effect.setFloat3("vBumpInfos", material.bumpTexture.coordinatesIndex, 1.0 / material.bumpTexture.level, material.parallaxScaleBias);
+                    effect.setMatrix("bumpMatrix", material.bumpTexture.getTextureMatrix());
+                    effect.setTexture("bumpSampler", material.bumpTexture);
+                    effect.setFloat2("vTangentSpaceParams", material.invertNormalMapX ? -1.0 : 1.0, material.invertNormalMapY ? -1.0 : 1.0);
+                }
+                // Reflectivity
+                if (this._enableReflectivity) {
+                    // for PBR materials: cf. https://doc.babylonjs.com/features/featuresDeepDive/materials/using/masterPBR
+                    if (material.getClassName() === "PBRMetallicRoughnessMaterial") {
+                        // if it is a PBR material in MetallicRoughness Mode:
+                        if (material.metallicRoughnessTexture !== null) {
+                            effect.setTexture("reflectivitySampler", material.metallicRoughnessTexture);
+                            effect.setMatrix("reflectivityMatrix", material.metallicRoughnessTexture.getTextureMatrix());
+                        }
+                        if (material.metallic !== null) {
+                            effect.setFloat("metallic", material.metallic);
+                        }
+                        if (material.roughness !== null) {
+                            effect.setFloat("glossiness", 1.0 - material.roughness);
+                        }
+                        if (material.baseTexture !== null) {
+                            effect.setTexture("albedoSampler", material.baseTexture);
+                            effect.setMatrix("albedoMatrix", material.baseTexture.getTextureMatrix());
+                        }
+                        if (material.baseColor !== null) {
+                            effect.setColor3("albedoColor", material.baseColor);
+                        }
                     }
-                    // Reflectivity
-                    if (this._enableReflectivity) {
-                        // for PBR materials: cf. https://doc.babylonjs.com/features/featuresDeepDive/materials/using/masterPBR
-                        if (material.getClassName() === "PBRMetallicRoughnessMaterial") {
-                            // if it is a PBR material in MetallicRoughness Mode:
-                            if (material.metallicRoughnessTexture !== null) {
-                                effect.setTexture("reflectivitySampler", material.metallicRoughnessTexture);
-                                effect.setMatrix("reflectivityMatrix", material.metallicRoughnessTexture.getTextureMatrix());
-                            }
-                            if (material.metallic !== null) {
-                                effect.setFloat("metallic", material.metallic);
-                            }
-                            if (material.roughness !== null) {
-                                effect.setFloat("glossiness", 1.0 - material.roughness);
-                            }
-                            if (material.baseTexture !== null) {
-                                effect.setTexture("albedoSampler", material.baseTexture);
-                                effect.setMatrix("albedoMatrix", material.baseTexture.getTextureMatrix());
-                            }
-                            if (material.baseColor !== null) {
-                                effect.setColor3("albedoColor", material.baseColor);
-                            }
+                    else if (material.getClassName() === "PBRSpecularGlossinessMaterial") {
+                        // if it is a PBR material in Specular/Glossiness Mode:
+                        if (material.specularGlossinessTexture !== null) {
+                            effect.setTexture("reflectivitySampler", material.specularGlossinessTexture);
+                            effect.setMatrix("reflectivityMatrix", material.specularGlossinessTexture.getTextureMatrix());
                         }
-                        else if (material.getClassName() === "PBRSpecularGlossinessMaterial") {
-                            // if it is a PBR material in Specular/Glossiness Mode:
-                            if (material.specularGlossinessTexture !== null) {
-                                effect.setTexture("reflectivitySampler", material.specularGlossinessTexture);
-                                effect.setMatrix("reflectivityMatrix", material.specularGlossinessTexture.getTextureMatrix());
-                            }
-                            else {
-                                if (material.specularColor !== null) {
-                                    effect.setColor3("reflectivityColor", material.specularColor);
-                                }
-                            }
-                            if (material.glossiness !== null) {
-                                effect.setFloat("glossiness", material.glossiness);
+                        else {
+                            if (material.specularColor !== null) {
+                                effect.setColor3("reflectivityColor", material.specularColor);
                             }
                         }
-                        else if (material.getClassName() === "PBRMaterial") {
-                            // if it is the bigger PBRMaterial
-                            if (material.metallicTexture !== null) {
-                                effect.setTexture("reflectivitySampler", material.metallicTexture);
-                                effect.setMatrix("reflectivityMatrix", material.metallicTexture.getTextureMatrix());
+                        if (material.glossiness !== null) {
+                            effect.setFloat("glossiness", material.glossiness);
+                        }
+                    }
+                    else if (material.getClassName() === "PBRMaterial") {
+                        // if it is the bigger PBRMaterial
+                        if (material.metallicTexture !== null) {
+                            effect.setTexture("reflectivitySampler", material.metallicTexture);
+                            effect.setMatrix("reflectivityMatrix", material.metallicTexture.getTextureMatrix());
+                        }
+                        if (material.metallic !== null) {
+                            effect.setFloat("metallic", material.metallic);
+                        }
+                        if (material.roughness !== null) {
+                            effect.setFloat("glossiness", 1.0 - material.roughness);
+                        }
+                        if (material.roughness !== null || material.metallic !== null || material.metallicTexture !== null) {
+                            // MetallicRoughness Model
+                            if (material.albedoTexture !== null) {
+                                effect.setTexture("albedoSampler", material.albedoTexture);
+                                effect.setMatrix("albedoMatrix", material.albedoTexture.getTextureMatrix());
                             }
-                            if (material.metallic !== null) {
-                                effect.setFloat("metallic", material.metallic);
+                            if (material.albedoColor !== null) {
+                                effect.setColor3("albedoColor", material.albedoColor);
                             }
-                            if (material.roughness !== null) {
-                                effect.setFloat("glossiness", 1.0 - material.roughness);
+                        }
+                        else {
+                            // SpecularGlossiness Model
+                            if (material.reflectivityTexture !== null) {
+                                effect.setTexture("reflectivitySampler", material.reflectivityTexture);
+                                effect.setMatrix("reflectivityMatrix", material.reflectivityTexture.getTextureMatrix());
                             }
-                            if (material.roughness !== null || material.metallic !== null || material.metallicTexture !== null) {
-                                // MetallicRoughness Model
-                                if (material.albedoTexture !== null) {
-                                    effect.setTexture("albedoSampler", material.albedoTexture);
-                                    effect.setMatrix("albedoMatrix", material.albedoTexture.getTextureMatrix());
-                                }
-                                if (material.albedoColor !== null) {
-                                    effect.setColor3("albedoColor", material.albedoColor);
-                                }
+                            else if (material.reflectivityColor !== null) {
+                                effect.setColor3("reflectivityColor", material.reflectivityColor);
                             }
-                            else {
-                                // SpecularGlossiness Model
-                                if (material.reflectivityTexture !== null) {
-                                    effect.setTexture("reflectivitySampler", material.reflectivityTexture);
-                                    effect.setMatrix("reflectivityMatrix", material.reflectivityTexture.getTextureMatrix());
-                                }
-                                else if (material.reflectivityColor !== null) {
-                                    effect.setColor3("reflectivityColor", material.reflectivityColor);
-                                }
-                                if (material.microSurface !== null) {
-                                    effect.setFloat("glossiness", material.microSurface);
-                                }
+                            if (material.microSurface !== null) {
+                                effect.setFloat("glossiness", material.microSurface);
                             }
                         }
-                        else if (material.getClassName() === "StandardMaterial") {
-                            // if StandardMaterial:
-                            if (material.specularTexture !== null) {
-                                effect.setTexture("reflectivitySampler", material.specularTexture);
-                                effect.setMatrix("reflectivityMatrix", material.specularTexture.getTextureMatrix());
-                            }
-                            if (material.specularColor !== null) {
-                                effect.setColor3("reflectivityColor", material.specularColor);
-                            }
+                    }
+                    else if (material.getClassName() === "StandardMaterial") {
+                        // if StandardMaterial:
+                        if (material.specularTexture !== null) {
+                            effect.setTexture("reflectivitySampler", material.specularTexture);
+                            effect.setMatrix("reflectivityMatrix", material.specularTexture.getTextureMatrix());
+                        }
+                        if (material.specularColor !== null) {
+                            effect.setColor3("reflectivityColor", material.specularColor);
                         }
                     }
                 }
+                // Clip plane
+                bindClipPlane(effect, material, this._scene);
                 // Bones
                 if (renderingMesh.useBones && renderingMesh.computeBonesUsingShaders && renderingMesh.skeleton) {
                     effect.setMatrices("mBones", renderingMesh.skeleton.getTransformMatrices(renderingMesh));