@babylonjs/core 5.23.0 → 5.25.0

package/Engines/engine.js

@@ -43,7 +43,7 @@ export class Engine extends ThinEngine {
          * Gets the list of created scenes
          */
         this.scenes = new Array();
-        /** @hidden */
+        /** @internal */
         this._virtualScenes = new Array();
         /**
          * Event raised when a new scene is created
@@ -101,7 +101,7 @@ export class Engine extends ThinEngine {
         // FPS
         this._fps = 60;
         this._deltaTime = 0;
-        /** @hidden */
+        /** @internal */
         this._drawCalls = new PerfCounter();
         /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
         this.canvasTabIndex = 1;
@@ -208,7 +208,7 @@ export class Engine extends ThinEngine {
     static get LastCreatedScene() {
         return EngineStore.LastCreatedScene;
     }
-    /** @hidden */
+    /** @internal */
     /**
      * Engine abstraction for loading and creating an image bitmap from a given source string.
      * @param imageSource source to load the image from.
@@ -664,7 +664,7 @@ export class Engine extends ThinEngine {
      * @param y defines the y coordinate of the viewport (in screen space)
      * @param width defines the width of the viewport (in screen space)
      * @param height defines the height of the viewport (in screen space)
-     * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
+     * @returns the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
      */
     setDirectViewport(x, y, width, height) {
         const currentViewport = this._cachedViewport;
@@ -706,8 +706,7 @@ export class Engine extends ThinEngine {
         gl.disable(gl.SCISSOR_TEST);
     }
     /**
-     * @param numDrawCalls
-     * @hidden
+     * @internal
      */
     _reportDrawCall(numDrawCalls = 1) {
         this._drawCalls.addCount(numDrawCalls, false);
@@ -720,20 +719,18 @@ export class Engine extends ThinEngine {
     initWebVR() {
         throw _WarnImport("WebVRCamera");
     }
-    /** @hidden */
+    /** @internal */
     _prepareVRComponent() {
         // Do nothing as the engine side effect will overload it
     }
     /**
-     * @param canvas
-     * @param document
-     * @hidden
+     * @internal
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _connectVREvents(canvas, document) {
         // Do nothing as the engine side effect will overload it
     }
-    /** @hidden */
+    /** @internal */
     _submitVRFrame() {
         // Do nothing as the engine side effect will overload it
     }
@@ -752,15 +749,12 @@ export class Engine extends ThinEngine {
     isVRPresenting() {
         return false;
     }
-    /** @hidden */
+    /** @internal */
     _requestVRFrame() {
         // Do nothing as the engine side effect will overload it
     }
     /**
-     * @param url
-     * @param offlineProvider
-     * @param useArrayBuffer
-     * @hidden
+     * @internal
      */
     _loadFileAsync(url, offlineProvider, useArrayBuffer) {
         return new Promise((resolve, reject) => {
@@ -857,7 +851,7 @@ export class Engine extends ThinEngine {
         }
         super._rebuildBuffers();
     }
-    /** @hidden */
+    /** @internal */
     _renderFrame() {
         for (let index = 0; index < this._activeRenderLoops.length; index++) {
             const renderFunction = this._activeRenderLoops[index];
@@ -899,7 +893,7 @@ export class Engine extends ThinEngine {
             this._renderingQueueLaunched = false;
         }
     }
-    /** @hidden */
+    /** @internal */
     _renderViews() {
         return false;
     }
@@ -1048,15 +1042,13 @@ export class Engine extends ThinEngine {
         return shaderProgram;
     }
     /**
-     * @param texture
-     * @hidden
+     * @internal
      */
     _releaseTexture(texture) {
         super._releaseTexture(texture);
     }
     /**
-     * @param rtWrapper
-     * @hidden
+     * @internal
      */
     _releaseRenderTargetWrapper(rtWrapper) {
         super._releaseRenderTargetWrapper(rtWrapper);
@@ -1123,7 +1115,7 @@ export class Engine extends ThinEngine {
         }
     }
     /**
-     * @hidden
+     * @internal
      * Rescales a texture
      * @param source input texture
      * @param destination destination texture
@@ -1201,11 +1193,7 @@ export class Engine extends ThinEngine {
         return internalTexture;
     }
     /**
-     * @param texture
-     * @param image
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadImageToTexture(texture, image, faceIndex = 0, lod = 0) {
         const gl = this._gl;
@@ -1304,14 +1292,7 @@ export class Engine extends ThinEngine {
         });
     }
     /**
-     * @param x
-     * @param y
-     * @param w
-     * @param h
-     * @param format
-     * @param type
-     * @param outputBuffer
-     * @hidden
+     * @internal
      */
     _readPixelsAsync(x, y, w, h, format, type, outputBuffer) {
         if (this._webGLVersion < 2) {
@@ -1528,7 +1509,7 @@ export class Engine extends ThinEngine {
     /**
      * Get Font size information
      * @param font font name
-     * @return an object containing ascent, height and descent
+     * @returns an object containing ascent, height and descent
      */
     getFontOffset(font) {
         const text = document.createElement("span");