@babylonjs/core 5.23.0 → 5.25.0

package/Materials/effect.js

@@ -59,24 +59,24 @@ export class Effect {
          * Observable that will be called if an error occurs during shader compilation.
          */
         this.onErrorObservable = new Observable();
-        /** @hidden */
+        /** @internal */
         this._onBindObservable = null;
         /**
-         * @hidden
+         * @internal
          * Specifies if the effect was previously ready
          */
         this._wasPreviouslyReady = false;
         /**
-         * @hidden
+         * @internal
          * Specifies if the effect was previously using instances
          */
         this._wasPreviouslyUsingInstances = null;
         this._isDisposed = false;
-        /** @hidden */
+        /** @internal */
         this._bonesComputationForcedToCPU = false;
-        /** @hidden */
+        /** @internal */
         this._uniformBuffersNames = {};
-        /** @hidden */
+        /** @internal */
         this._multiTarget = false;
         this._samplers = {};
         this._isReady = false;
@@ -85,7 +85,7 @@ export class Effect {
         this._uniforms = {};
         /**
          * Key for the effect.
-         * @hidden
+         * @internal
          */
         this._key = "";
         this._fallbacks = null;
@@ -94,16 +94,16 @@ export class Effect {
         this._transformFeedbackVaryings = null;
         /**
          * Compiled shader to webGL program.
-         * @hidden
+         * @internal
          */
         this._pipelineContext = null;
-        /** @hidden */
+        /** @internal */
         this._vertexSourceCode = "";
-        /** @hidden */
+        /** @internal */
         this._fragmentSourceCode = "";
-        /** @hidden */
+        /** @internal */
         this._rawVertexSourceCode = "";
-        /** @hidden */
+        /** @internal */
         this._rawFragmentSourceCode = "";
         this.name = baseName;
         this._key = key;
@@ -221,6 +221,27 @@ export class Effect {
             shaderCodes[1] = fragmentCode;
             shadersLoaded();
         });
+        const proxyFunction = function (functionName) {
+            // check if the function exists in the pipelineContext
+            return function () {
+                if (this._pipelineContext) {
+                    const func = this._pipelineContext[functionName];
+                    func.apply(this._pipelineContext, arguments);
+                }
+                return this;
+            };
+        };
+        ["Int?", "IntArray?", "Array?", "Color?", "Vector?", "Float?", "Matrices", "Matrix", "Matrix3x3", "Matrix2x2", "Quaternion", "DirectColor4"].forEach((functionName) => {
+            const name = `set${functionName}`;
+            if (name.endsWith("?")) {
+                ["", 2, 3, 4].forEach((n) => {
+                    this[(name.slice(0, -1) + n)] = this[(name.slice(0, -1) + n)] || proxyFunction(name.slice(0, -1) + n).bind(this);
+                });
+            }
+            else {
+                this[name] = this[name] || proxyFunction(name).bind(this);
+            }
+        });
     }
     /**
      * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
@@ -491,7 +512,7 @@ export class Effect {
      * @param fragmentSourceCode The source code for the fragment shader.
      * @param onCompiled Callback called when completed.
      * @param onError Callback called on error.
-     * @hidden
+     * @internal
      */
     _rebuildProgram(vertexSourceCode, fragmentSourceCode, onCompiled, onError) {
         this._isReady = false;
@@ -516,7 +537,7 @@ export class Effect {
     }
     /**
      * Prepares the effect
-     * @hidden
+     * @internal
      */
     _prepareEffect() {
         const attributesNames = this._attributesNames;
@@ -622,14 +643,19 @@ export class Effect {
             }
         }
         Logger.Error("Error: " + this._compilationError);
-        if (previousPipelineContext) {
-            this._pipelineContext = previousPipelineContext;
-            this._isReady = true;
+        const notifyErrors = () => {
             if (this.onError) {
                 this.onError(this, this._compilationError);
             }
             this.onErrorObservable.notifyObservers(this);
+        };
+        // In case a previous compilation was successful, we need to restore the previous pipeline context
+        if (previousPipelineContext) {
+            this._pipelineContext = previousPipelineContext;
+            this._isReady = true;
+            notifyErrors();
         }
+        // Lets try to compile fallbacks as long as we have some.
         if (fallbacks) {
             this._pipelineContext = null;
             if (fallbacks.hasMoreFallbacks) {
@@ -641,10 +667,7 @@ export class Effect {
             else {
                 // Sorry we did everything we can
                 this._allFallbacksProcessed = true;
-                if (this.onError) {
-                    this.onError(this, this._compilationError);
-                }
-                this.onErrorObservable.notifyObservers(this);
+                notifyErrors();
                 this.onErrorObservable.clear();
                 // Unbind mesh reference in fallbacks
                 if (this._fallbacks) {
@@ -654,6 +677,10 @@ export class Effect {
         }
         else {
             this._allFallbacksProcessed = true;
+            // In case of error, without any prior successful compilation, let s notify observers
+            if (!previousPipelineContext) {
+                notifyErrors();
+            }
         }
     }
     /**
@@ -666,7 +693,7 @@ export class Effect {
      * Binds a texture to the engine to be used as output of the shader.
      * @param channel Name of the output variable.
      * @param texture Texture to bind.
-     * @hidden
+     * @internal
      */
     _bindTexture(channel, texture) {
         this._engine._bindTexture(this._samplers[channel], texture, channel);
@@ -747,92 +774,6 @@ export class Effect {
     bindUniformBlock(blockName, index) {
         this._engine.bindUniformBlock(this._pipelineContext, blockName, index);
     }
-    /**
-     * Sets an integer value on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param value Value to be set.
-     * @returns this effect.
-     */
-    setInt(uniformName, value) {
-        this._pipelineContext.setInt(uniformName, value);
-        return this;
-    }
-    /**
-     * Sets an int2 value on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First int in int2.
-     * @param y Second int in int2.
-     * @returns this effect.
-     */
-    setInt2(uniformName, x, y) {
-        this._pipelineContext.setInt2(uniformName, x, y);
-        return this;
-    }
-    /**
-     * Sets an int3 value on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First int in int3.
-     * @param y Second int in int3.
-     * @param z Third int in int3.
-     * @returns this effect.
-     */
-    setInt3(uniformName, x, y, z) {
-        this._pipelineContext.setInt3(uniformName, x, y, z);
-        return this;
-    }
-    /**
-     * Sets an int4 value on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First int in int4.
-     * @param y Second int in int4.
-     * @param z Third int in int4.
-     * @param w Fourth int in int4.
-     * @returns this effect.
-     */
-    setInt4(uniformName, x, y, z, w) {
-        this._pipelineContext.setInt4(uniformName, x, y, z, w);
-        return this;
-    }
-    /**
-     * Sets an int array on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setIntArray(uniformName, array) {
-        this._pipelineContext.setIntArray(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setIntArray2(uniformName, array) {
-        this._pipelineContext.setIntArray2(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setIntArray3(uniformName, array) {
-        this._pipelineContext.setIntArray3(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setIntArray4(uniformName, array) {
-        this._pipelineContext.setIntArray4(uniformName, array);
-        return this;
-    }
     /**
      * Sets an float array on a uniform variable.
      * @param uniformName Name of the variable.
@@ -873,98 +814,6 @@ export class Effect {
         this._pipelineContext.setArray4(uniformName, array);
         return this;
     }
-    /**
-     * Sets an array on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setArray(uniformName, array) {
-        this._pipelineContext.setArray(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setArray2(uniformName, array) {
-        this._pipelineContext.setArray2(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setArray3(uniformName, array) {
-        this._pipelineContext.setArray3(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
-     * @param uniformName Name of the variable.
-     * @param array array to be set.
-     * @returns this effect.
-     */
-    setArray4(uniformName, array) {
-        this._pipelineContext.setArray4(uniformName, array);
-        return this;
-    }
-    /**
-     * Sets matrices on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param matrices matrices to be set.
-     * @returns this effect.
-     */
-    setMatrices(uniformName, matrices) {
-        this._pipelineContext.setMatrices(uniformName, matrices);
-        return this;
-    }
-    /**
-     * Sets matrix on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param matrix matrix to be set.
-     * @returns this effect.
-     */
-    setMatrix(uniformName, matrix) {
-        this._pipelineContext.setMatrix(uniformName, matrix);
-        return this;
-    }
-    /**
-     * Sets a 3x3 matrix on a uniform variable. (Specified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
-     * @param uniformName Name of the variable.
-     * @param matrix matrix to be set.
-     * @returns this effect.
-     */
-    setMatrix3x3(uniformName, matrix) {
-        // the cast is ok because it is gl.uniformMatrix3fv() which is called at the end, and this function accepts Float32Array and Array<number>
-        this._pipelineContext.setMatrix3x3(uniformName, matrix);
-        return this;
-    }
-    /**
-     * Sets a 2x2 matrix on a uniform variable. (Specified as [1,2,3,4] will result in [1,2][3,4] matrix)
-     * @param uniformName Name of the variable.
-     * @param matrix matrix to be set.
-     * @returns this effect.
-     */
-    setMatrix2x2(uniformName, matrix) {
-        // the cast is ok because it is gl.uniformMatrix3fv() which is called at the end, and this function accepts Float32Array and Array<number>
-        this._pipelineContext.setMatrix2x2(uniformName, matrix);
-        return this;
-    }
-    /**
-     * Sets a float on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param value value to be set.
-     * @returns this effect.
-     */
-    setFloat(uniformName, value) {
-        this._pipelineContext.setFloat(uniformName, value);
-        return this;
-    }
     /**
      * Sets a boolean on a uniform variable.
      * @param uniformName Name of the variable.
@@ -975,120 +824,11 @@ export class Effect {
         this._pipelineContext.setInt(uniformName, bool ? 1 : 0);
         return this;
     }
-    /**
-     * Sets a Vector2 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param vector2 vector2 to be set.
-     * @returns this effect.
-     */
-    setVector2(uniformName, vector2) {
-        this._pipelineContext.setVector2(uniformName, vector2);
-        return this;
-    }
-    /**
-     * Sets a float2 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First float in float2.
-     * @param y Second float in float2.
-     * @returns this effect.
-     */
-    setFloat2(uniformName, x, y) {
-        this._pipelineContext.setFloat2(uniformName, x, y);
-        return this;
-    }
-    /**
-     * Sets a Vector3 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param vector3 Value to be set.
-     * @returns this effect.
-     */
-    setVector3(uniformName, vector3) {
-        this._pipelineContext.setVector3(uniformName, vector3);
-        return this;
-    }
-    /**
-     * Sets a float3 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First float in float3.
-     * @param y Second float in float3.
-     * @param z Third float in float3.
-     * @returns this effect.
-     */
-    setFloat3(uniformName, x, y, z) {
-        this._pipelineContext.setFloat3(uniformName, x, y, z);
-        return this;
-    }
-    /**
-     * Sets a Vector4 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param vector4 Value to be set.
-     * @returns this effect.
-     */
-    setVector4(uniformName, vector4) {
-        this._pipelineContext.setVector4(uniformName, vector4);
-        return this;
-    }
-    /**
-     * Sets a Quaternion on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param quaternion Value to be set.
-     * @returns this effect.
-     */
-    setQuaternion(uniformName, quaternion) {
-        this._pipelineContext.setQuaternion(uniformName, quaternion);
-        return this;
-    }
-    /**
-     * Sets a float4 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param x First float in float4.
-     * @param y Second float in float4.
-     * @param z Third float in float4.
-     * @param w Fourth float in float4.
-     * @returns this effect.
-     */
-    setFloat4(uniformName, x, y, z, w) {
-        this._pipelineContext.setFloat4(uniformName, x, y, z, w);
-        return this;
-    }
-    /**
-     * Sets a Color3 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param color3 Value to be set.
-     * @returns this effect.
-     */
-    setColor3(uniformName, color3) {
-        this._pipelineContext.setColor3(uniformName, color3);
-        return this;
-    }
-    /**
-     * Sets a Color4 on a uniform variable.
-     * @param uniformName Name of the variable.
-     * @param color3 Value to be set.
-     * @param alpha Alpha value to be set.
-     * @returns this effect.
-     */
-    setColor4(uniformName, color3, alpha) {
-        this._pipelineContext.setColor4(uniformName, color3, alpha);
-        return this;
-    }
-    /**
-     * Sets a Color4 on a uniform variable
-     * @param uniformName defines the name of the variable
-     * @param color4 defines the value to be set
-     * @returns this effect.
-     */
-    setDirectColor4(uniformName, color4) {
-        this._pipelineContext.setDirectColor4(uniformName, color4);
-        return this;
-    }
     /**
      * Release all associated resources.
      **/
     dispose() {
-        if (this._pipelineContext) {
-            this._pipelineContext.dispose();
-        }
+        this._pipelineContext?.dispose();
         this._engine._releaseEffect(this);
         this._isDisposed = true;
     }