@babylonjs/core 5.23.0 → 5.25.0

package/Engines/thinEngine.js

@@ -36,7 +36,7 @@ export class ThinEngine {
      * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
      */
     constructor(canvasOrContext, antialias, options, adaptToDeviceRatio) {
-        /** @hidden */
+        /** @internal */
         this._name = "WebGL";
         /**
          * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
@@ -79,17 +79,17 @@ export class ThinEngine {
          */
         this.onDisposeObservable = new Observable();
         this._frameId = 0;
-        /** @hidden */
+        /** @internal */
         this._uniformBuffers = new Array();
-        /** @hidden */
+        /** @internal */
         this._storageBuffers = new Array();
-        /** @hidden */
+        /** @internal */
         this._webGLVersion = 1.0;
         this._windowIsBackground = false;
         this._highPrecisionShadersAllowed = true;
-        /** @hidden */
+        /** @internal */
         this._badOS = false;
-        /** @hidden */
+        /** @internal */
         this._badDesktopOS = false;
         this._renderingQueueLaunched = false;
         this._activeRenderLoops = new Array();
@@ -103,46 +103,46 @@ export class ThinEngine {
          */
         this.onContextRestoredObservable = new Observable();
         this._contextWasLost = false;
-        /** @hidden */
+        /** @internal */
         this._doNotHandleContextLost = false;
         /**
          * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
          */
         this.disableVertexArrayObjects = false;
         // States
-        /** @hidden */
+        /** @internal */
         this._colorWrite = true;
-        /** @hidden */
+        /** @internal */
         this._colorWriteChanged = true;
-        /** @hidden */
+        /** @internal */
         this._depthCullingState = new DepthCullingState();
-        /** @hidden */
+        /** @internal */
         this._stencilStateComposer = new StencilStateComposer();
-        /** @hidden */
+        /** @internal */
         this._stencilState = new StencilState();
-        /** @hidden */
+        /** @internal */
         this._alphaState = new AlphaState();
-        /** @hidden */
+        /** @internal */
         this._alphaMode = 1;
-        /** @hidden */
+        /** @internal */
         this._alphaEquation = 0;
         // Cache
-        /** @hidden */
+        /** @internal */
         this._internalTexturesCache = new Array();
-        /** @hidden */
+        /** @internal */
         this._renderTargetWrapperCache = new Array();
-        /** @hidden */
+        /** @internal */
         this._activeChannel = 0;
         this._currentTextureChannel = -1;
-        /** @hidden */
+        /** @internal */
         this._boundTexturesCache = {};
         this._compiledEffects = {};
         this._vertexAttribArraysEnabled = [];
         this._uintIndicesCurrentlySet = false;
         this._currentBoundBuffer = new Array();
-        /** @hidden */
+        /** @internal */
         this._currentFramebuffer = null;
-        /** @hidden */
+        /** @internal */
         this._dummyFramebuffer = null;
         this._currentBufferPointers = new Array();
         this._currentInstanceLocations = new Array();
@@ -157,9 +157,9 @@ export class ThinEngine {
          * If set to true zooming in and out in the browser will rescale the hardware-scaling correctly.
          */
         this.adaptToDeviceRatio = false;
-        /** @hidden */
+        /** @internal */
         this._lastDevicePixelRatio = 1.0;
-        /** @hidden */
+        /** @internal */
         this._transformTextureUrl = null;
         /**
          * Gets information about the current host
@@ -175,7 +175,7 @@ export class ThinEngine {
          * Observable event triggered before each texture is initialized
          */
         this.onBeforeTextureInitObservable = new Observable();
-        /** @hidden */
+        /** @internal */
         this._isWebGPU = false;
         this._snapshotRenderingMode = 0;
         this._useExactSrgbConversions = false;
@@ -401,13 +401,13 @@ export class ThinEngine {
      */
     // Not mixed with Version for tooling purpose.
     static get NpmPackage() {
-        return "babylonjs@5.23.0";
+        return "babylonjs@5.25.0";
     }
     /**
      * Returns the current version of the framework
      */
     static get Version() {
-        return "5.23.0";
+        return "5.25.0";
     }
     /**
      * Returns a string describing the current engine
@@ -444,8 +444,7 @@ export class ThinEngine {
         Effect.ShadersRepository = value;
     }
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessor(shaderLanguage) {
         return this._shaderProcessor;
@@ -489,7 +488,7 @@ export class ThinEngine {
     getCreationOptions() {
         return this._creationOptions;
     }
-    /** @hidden */
+    /** @internal */
     get _shouldUseHighPrecisionShader() {
         return !!(this._caps.highPrecisionShaderSupported && this._highPrecisionShadersAllowed);
     }
@@ -628,14 +627,14 @@ export class ThinEngine {
      * Create a canvas. This method is overridden by other engines
      * @param width width
      * @param height height
-     * @return ICanvas interface
+     * @returns ICanvas interface
      */
     createCanvas(width, height) {
         return ThinEngine._CreateCanvas(width, height);
     }
     /**
      * Create an image to use with canvas
-     * @return IImage interface
+     * @returns IImage interface
      */
     createCanvasImage() {
         return document.createElement("img");
@@ -680,8 +679,7 @@ export class ThinEngine {
         this._renderingCanvas = canvas;
     }
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessingContext(shaderLanguage) {
         return null;
@@ -1007,7 +1005,7 @@ export class ThinEngine {
     get isStencilEnable() {
         return this._isStencilEnable;
     }
-    /** @hidden */
+    /** @internal */
     _prepareWorkingCanvas() {
         if (this._workingCanvas) {
             return;
@@ -1095,7 +1093,7 @@ export class ThinEngine {
             this._activeRenderLoops.splice(index, 1);
         }
     }
-    /** @hidden */
+    /** @internal */
     _renderLoop() {
         if (!this._contextWasLost) {
             let shouldRender = true;
@@ -1178,9 +1176,7 @@ export class ThinEngine {
     }
     /**
      * Can be used to override the current requestAnimationFrame requester.
-     * @param bindedRenderFunction
-     * @param requester
-     * @hidden
+     * @internal
      */
     _queueNewFrame(bindedRenderFunction, requester) {
         return ThinEngine.QueueNewFrame(bindedRenderFunction, requester);
@@ -1234,11 +1230,7 @@ export class ThinEngine {
         this._gl.clear(mode);
     }
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @hidden
+     * @internal
      */
     _viewport(x, y, width, height) {
         if (x !== this._viewportCached.x || y !== this._viewportCached.y || width !== this._viewportCached.z || height !== this._viewportCached.w) {
@@ -1453,8 +1445,7 @@ export class ThinEngine {
         return this.useReverseDepthBuffer ? -zOffsetUnits : zOffsetUnits;
     }
     /**
-     * @param framebuffer
-     * @hidden
+     * @internal
      */
     _bindUnboundFramebuffer(framebuffer) {
         if (this._currentFramebuffer !== framebuffer) {
@@ -1462,7 +1453,7 @@ export class ThinEngine {
             this._currentFramebuffer = framebuffer;
         }
     }
-    /** @hidden */
+    /** @internal */
     _currentFrameBufferIsDefaultFrameBuffer() {
         return this._currentFramebuffer === null;
     }
@@ -1530,7 +1521,7 @@ export class ThinEngine {
         this.wipeCaches();
     }
     // VBOs
-    /** @hidden */
+    /** @internal */
     _resetVertexBufferBinding() {
         this.bindArrayBuffer(null);
         this._cachedVertexBuffers = null;
@@ -1710,8 +1701,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param indexBuffer
-     * @hidden
+     * @internal
      */
     _bindIndexBufferWithCache(indexBuffer) {
         if (indexBuffer == null) {
@@ -1877,8 +1867,7 @@ export class ThinEngine {
         this._gl.deleteVertexArray(vao);
     }
     /**
-     * @param buffer
-     * @hidden
+     * @internal
      */
     _releaseBuffer(buffer) {
         buffer.references--;
@@ -2086,14 +2075,13 @@ export class ThinEngine {
                 return this._gl.TRIANGLES;
         }
     }
-    /** @hidden */
+    /** @internal */
     _reportDrawCall() {
         // Will be implemented by children
     }
     // Shaders
     /**
-     * @param effect
-     * @hidden
+     * @internal
      */
     _releaseEffect(effect) {
         if (this._compiledEffects[effect._key]) {
@@ -2105,8 +2093,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param pipelineContext
-     * @hidden
+     * @internal
      */
     _deletePipelineContext(pipelineContext) {
         const webGLPipelineContext = pipelineContext;
@@ -2115,7 +2102,7 @@ export class ThinEngine {
             this._gl.deleteProgram(webGLPipelineContext.program);
         }
     }
-    /** @hidden */
+    /** @internal */
     _getGlobalDefines(defines) {
         if (defines) {
             if (this.isNDCHalfZRange) {
@@ -2215,8 +2202,7 @@ export class ThinEngine {
         return shader;
     }
     /**
-     * @param shader
-     * @hidden
+     * @internal
      */
     _getShaderSource(shader) {
         return this._gl.getShaderSource(shader);
@@ -2357,17 +2343,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param pipelineContext
-     * @param vertexSourceCode
-     * @param fragmentSourceCode
-     * @param createAsRaw
-     * @param rawVertexSourceCode
-     * @param rawFragmentSourceCode
-     * @param rebuildRebind
-     * @param defines
-     * @param transformFeedbackVaryings
-     * @param key
-     * @hidden
+     * @internal
      */
     _preparePipelineContext(pipelineContext, vertexSourceCode, fragmentSourceCode, createAsRaw, rawVertexSourceCode, rawFragmentSourceCode, rebuildRebind, defines, transformFeedbackVaryings, key) {
         const webGLRenderingState = pipelineContext;
@@ -2380,8 +2356,7 @@ export class ThinEngine {
         webGLRenderingState.program.__SPECTOR_rebuildProgram = rebuildRebind;
     }
     /**
-     * @param pipelineContext
-     * @hidden
+     * @internal
      */
     _isRenderingStateCompiled(pipelineContext) {
         const webGLPipelineContext = pipelineContext;
@@ -2392,9 +2367,7 @@ export class ThinEngine {
         return false;
     }
     /**
-     * @param pipelineContext
-     * @param action
-     * @hidden
+     * @internal
      */
     _executeWhenRenderingStateIsCompiled(pipelineContext, action) {
         const webGLPipelineContext = pipelineContext;
@@ -2831,9 +2804,7 @@ export class ThinEngine {
         this.bindIndexBuffer(null);
     }
     /**
-     * @param samplingMode
-     * @param generateMipMaps
-     * @hidden
+     * @internal
      */
     _getSamplingParameters(samplingMode, generateMipMaps) {
         const gl = this._gl;
@@ -2934,7 +2905,7 @@ export class ThinEngine {
             mag: magFilter,
         };
     }
-    /** @hidden */
+    /** @internal */
     _createTexture() {
         const texture = this._gl.createTexture();
         if (!texture) {
@@ -2942,13 +2913,13 @@ export class ThinEngine {
         }
         return texture;
     }
-    /** @hidden */
+    /** @internal */
     _createHardwareTexture() {
         return new WebGLHardwareTexture(this._createTexture(), this._gl);
     }
     /**
      * Creates an internal texture without binding it to a framebuffer
-     * @hidden
+     * @internal
      * @param size defines the size of the texture
      * @param options defines the options used to create the texture
      * @param delayGPUTextureCreation true to delay the texture creation the first time it is really needed. false to create it right away
@@ -3028,9 +2999,7 @@ export class ThinEngine {
         return texture;
     }
     /**
-     * @param useSRGBBuffer
-     * @param noMipmap
-     * @hidden
+     * @internal
      */
     _getUseSRGBBuffer(useSRGBBuffer, noMipmap) {
         // Generating mipmaps for sRGB textures is not supported in WebGL1 so we must disable the support if mipmaps is enabled
@@ -3247,18 +3216,13 @@ export class ThinEngine {
      * @param mimeType optional mime type
      * @param imageBitmapOptions optional the options to use when creating an ImageBitmap
      * @returns the HTMLImageElement of the loaded image
-     * @hidden
+     * @internal
      */
     static _FileToolsLoadImage(input, onLoad, onError, offlineProvider, mimeType, imageBitmapOptions) {
         throw _WarnImport("FileTools");
     }
     /**
-     * @param source
-     * @param destination
-     * @param scene
-     * @param internalFormat
-     * @param onComplete
-     * @hidden
+     * @internal
      */
     _rescaleTexture(source, destination, scene, internalFormat, onComplete) { }
     /**
@@ -3329,8 +3293,7 @@ export class ThinEngine {
         throw _WarnImport("Engine.RawTexture");
     }
     /**
-     * @param value
-     * @hidden
+     * @internal
      */
     _unpackFlipY(value) {
         if (this._unpackFlipYCached !== value) {
@@ -3340,7 +3303,7 @@ export class ThinEngine {
             }
         }
     }
-    /** @hidden */
+    /** @internal */
     _getUnpackAlignement() {
         return this._gl.getParameter(this._gl.UNPACK_ALIGNMENT);
     }
@@ -3406,13 +3369,7 @@ export class ThinEngine {
         this._bindTextureDirectly(target, null);
     }
     /**
-     * @param internalTexture
-     * @param size
-     * @param generateStencil
-     * @param bilinearFiltering
-     * @param comparisonFunction
-     * @param samples
-     * @hidden
+     * @internal
      */
     _setupDepthStencilTexture(internalTexture, size, generateStencil, bilinearFiltering, comparisonFunction, samples = 1) {
         const width = size.width || size;
@@ -3450,14 +3407,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param texture
-     * @param internalFormat
-     * @param width
-     * @param height
-     * @param data
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadCompressedDataToTextureDirectly(texture, internalFormat, width, height, data, faceIndex = 0, lod = 0) {
         const gl = this._gl;
@@ -3527,13 +3477,7 @@ export class ThinEngine {
         this._gl.compressedTexImage2D(target, lod, internalFormat, width, height, 0, data);
     }
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @param babylonInternalFormat
-     * @param useTextureWidthAndHeight
-     * @hidden
+     * @internal
      */
     _uploadDataToTextureDirectly(texture, imageData, faceIndex = 0, lod = 0, babylonInternalFormat, useTextureWidthAndHeight = false) {
         const gl = this._gl;
@@ -3582,11 +3526,7 @@ export class ThinEngine {
         this._bindTextureDirectly(target, null);
     }
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadArrayBufferViewToTexture(texture, imageData, faceIndex = 0, lod = 0) {
         const gl = this._gl;
@@ -3645,12 +3585,7 @@ export class ThinEngine {
         this._prepareWebGLTextureContinuation(texture, scene, noMipmap, isCompressed, samplingMode);
     }
     /**
-     * @param generateStencilBuffer
-     * @param generateDepthBuffer
-     * @param width
-     * @param height
-     * @param samples
-     * @hidden
+     * @internal
      */
     _setupFramebufferDepthAttachments(generateStencilBuffer, generateDepthBuffer, width, height, samples = 1) {
         const gl = this._gl;
@@ -3671,18 +3606,15 @@ export class ThinEngine {
         return null;
     }
     /**
-     * @param width
-     * @param height
-     * @param samples
-     * @param internalFormat
-     * @param msInternalFormat
-     * @param attachment
-     * @param unbindBuffer
-     * @hidden
+     * @internal
      */
     _createRenderBuffer(width, height, samples, internalFormat, msInternalFormat, attachment, unbindBuffer = true) {
         const gl = this._gl;
         const renderBuffer = gl.createRenderbuffer();
+        return this._updateRenderBuffer(renderBuffer, width, height, samples, internalFormat, msInternalFormat, attachment, unbindBuffer);
+    }
+    _updateRenderBuffer(renderBuffer, width, height, samples, internalFormat, msInternalFormat, attachment, unbindBuffer = true) {
+        const gl = this._gl;
         gl.bindRenderbuffer(gl.RENDERBUFFER, renderBuffer);
         if (samples > 1 && gl.renderbufferStorageMultisample) {
             gl.renderbufferStorageMultisample(gl.RENDERBUFFER, samples, msInternalFormat, width, height);
@@ -3697,8 +3629,7 @@ export class ThinEngine {
         return renderBuffer;
     }
     /**
-     * @param texture
-     * @hidden
+     * @internal
      */
     _releaseTexture(texture) {
         this._deleteTexture(texture._hardwareTexture?.underlyingResource);
@@ -3724,8 +3655,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param rtWrapper
-     * @hidden
+     * @internal
      */
     _releaseRenderTargetWrapper(rtWrapper) {
         const index = this._renderTargetWrapperCache.indexOf(rtWrapper);
@@ -3767,11 +3697,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param target
-     * @param texture
-     * @param forTextureDataUpdate
-     * @param force
-     * @hidden
+     * @internal
      */
     _bindTextureDirectly(target, texture, forTextureDataUpdate = false, force = false) {
         let wasPreviouslyBound = false;
@@ -3805,10 +3731,7 @@ export class ThinEngine {
         return wasPreviouslyBound;
     }
     /**
-     * @param channel
-     * @param texture
-     * @param name
-     * @hidden
+     * @internal
      */
     _bindTexture(channel, texture, name) {
         if (channel === undefined) {
@@ -3984,10 +3907,7 @@ export class ThinEngine {
         }
     }
     /**
-     * @param target
-     * @param internalTexture
-     * @param anisotropicFilteringLevel
-     * @hidden
+     * @internal
      */
     _setAnisotropicLevel(target, internalTexture, anisotropicFilteringLevel) {
         const anisotropicFilterExtension = this._caps.textureAnisotropicFilterExtension;
@@ -4171,8 +4091,7 @@ export class ThinEngine {
         return successful;
     }
     /**
-     * @param type
-     * @hidden
+     * @internal
      */
     _getWebGLTextureType(type) {
         if (this._webGLVersion === 1) {
@@ -4229,9 +4148,7 @@ export class ThinEngine {
         return this._gl.UNSIGNED_BYTE;
     }
     /**
-     * @param format
-     * @param useSRGBBuffer
-     * @hidden
+     * @internal
      */
     _getInternalFormat(format, useSRGBBuffer = false) {
         let internalFormat = useSRGBBuffer ? this._gl.SRGB8_ALPHA8 : this._gl.RGBA;
@@ -4277,10 +4194,7 @@ export class ThinEngine {
         return internalFormat;
     }
     /**
-     * @param type
-     * @param format
-     * @param useSRGBBuffer
-     * @hidden
+     * @internal
      */
     _getRGBABufferInternalSizedFormat(type, format, useSRGBBuffer = false) {
         if (this._webGLVersion === 1) {
@@ -4446,8 +4360,7 @@ export class ThinEngine {
         return useSRGBBuffer ? this._gl.SRGB8_ALPHA8 : this._gl.RGBA8;
     }
     /**
-     * @param type
-     * @hidden
+     * @internal
      */
     _getRGBAMultiSampleBufferFormat(type) {
         if (type === 1) {
@@ -4459,13 +4372,7 @@ export class ThinEngine {
         return this._gl.RGBA8;
     }
     /**
-     * @param url
-     * @param onSuccess
-     * @param onProgress
-     * @param offlineProvider
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     _loadFile(url, onSuccess, onProgress, offlineProvider, useArrayBuffer, onError) {
         const request = ThinEngine._FileToolsLoadFile(url, onSuccess, onProgress, offlineProvider, useArrayBuffer, onError);
@@ -4484,7 +4391,7 @@ export class ThinEngine {
      * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
      * @param onError callback called when the file fails to load
      * @returns a file request object
-     * @hidden
+     * @internal
      */
     static _FileToolsLoadFile(url, onSuccess, onProgress, offlineProvider, useArrayBuffer, onError) {
         throw _WarnImport("FileTools");
@@ -4563,7 +4470,7 @@ export class ThinEngine {
     /**
      * Find the next highest power of two.
      * @param x Number to start search from.
-     * @return Next highest power of two.
+     * @returns Next highest power of two.
      */
     static CeilingPOT(x) {
         x--;
@@ -4578,7 +4485,7 @@ export class ThinEngine {
     /**
      * Find the next lowest power of two.
      * @param x Number to start search from.
-     * @return Next lowest power of two.
+     * @returns Next lowest power of two.
      */
     static FloorPOT(x) {
         x = x | (x >> 1);
@@ -4591,7 +4498,7 @@ export class ThinEngine {
     /**
      * Find the nearest power of two.
      * @param x Number to start search from.
-     * @return Next nearest power of two.
+     * @returns Next nearest power of two.
      */
     static NearestPOT(x) {
         const c = ThinEngine.CeilingPOT(x);
@@ -4686,7 +4593,7 @@ ThinEngine.ExceptionList = [
     // mobile browsers using safari 15.4 on ios
     { key: ".*(15.4).*AppleWebKit.*Safari", capture: null, captureConstraint: null, targets: ["antialias", "maxMSAASamples"] },
 ];
-/** @hidden */
+/** @internal */
 ThinEngine._TextureLoaders = [];
 // Updatable statics so stick with vars here
 /**