@babylonjs/core 5.46.0 → 5.47.1

package/Engines/thinEngine.d.ts

@@ -56,23 +56,13 @@ export interface HostInformation {
      */
     isMobile: boolean;
 }
-/** Interface defining initialization parameters for Engine class */
-export interface EngineOptions extends WebGLContextAttributes {
+/** Interface defining initialization parameters for ThinEngine class */
+export interface ThinEngineOptions {
     /**
      * Defines if the engine should no exceed a specified device ratio
      * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
      */
     limitDeviceRatio?: number;
-    /**
-     * Defines if webvr should be enabled automatically
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/cameras/webVRCamera
-     */
-    autoEnableWebVR?: boolean;
-    /**
-     * Defines if webgl2 should be turned off even if supported
-     * @see https://doc.babylonjs.com/setup/support/webGL2
-     */
-    disableWebGL2Support?: boolean;
     /**
      * Defines if webaudio should be initialized as well
      * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
@@ -101,6 +91,44 @@ export interface EngineOptions extends WebGLContextAttributes {
      * If not handle, you might need to set it up on your side for expected touch devices behavior.
      */
     doNotHandleTouchAction?: boolean;
+    /**
+     * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
+     */
+    useHighPrecisionMatrix?: boolean;
+    /**
+     * Defines whether to adapt to the device's viewport characteristics (default: false)
+     */
+    adaptToDeviceRatio?: boolean;
+    /**
+     * True if the more expensive but exact conversions should be used for transforming colors to and from linear space within shaders.
+     * Otherwise, the default is to use a cheaper approximation.
+     */
+    useExactSrgbConversions?: boolean;
+    /**
+     * Defines whether MSAA is enabled on the canvas.
+     */
+    antialias?: boolean;
+    /**
+     * Defines whether the stencil buffer should be enabled.
+     */
+    stencil?: boolean;
+    /**
+     * Defines whether the canvas should be created in "premultiplied" mode (if false, the canvas is created in the "opaque" mode) (true by default)
+     */
+    premultipliedAlpha?: boolean;
+}
+/** Interface defining initialization parameters for Engine class */
+export interface EngineOptions extends ThinEngineOptions, WebGLContextAttributes {
+    /**
+     * Defines if webvr should be enabled automatically
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/cameras/webVRCamera
+     */
+    autoEnableWebVR?: boolean;
+    /**
+     * Defines if webgl2 should be turned off even if supported
+     * @see https://doc.babylonjs.com/setup/support/webGL2
+     */
+    disableWebGL2Support?: boolean;
     /**
      * Defines that engine should compile shaders with high precision floats (if supported). True by default
      */
@@ -109,29 +137,16 @@ export interface EngineOptions extends WebGLContextAttributes {
      * Make the canvas XR Compatible for XR sessions
      */
     xrCompatible?: boolean;
-    /**
-     * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
-     */
-    useHighPrecisionMatrix?: boolean;
     /**
      * Will prevent the system from falling back to software implementation if a hardware device cannot be created
      */
     failIfMajorPerformanceCaveat?: boolean;
-    /**
-     * Defines whether to adapt to the device's viewport characteristics (default: false)
-     */
-    adaptToDeviceRatio?: boolean;
     /**
      * If sRGB Buffer support is not set during construction, use this value to force a specific state
      * This is added due to an issue when processing textures in chrome/edge/firefox
      * This will not influence NativeEngine and WebGPUEngine which set the behavior to true during construction.
      */
     forceSRGBBufferSupportState?: boolean;
-    /**
-     * True if the more expensive but exact conversions should be used for transforming colors to and from linear space within shaders.
-     * Otherwise, the default is to use a cheaper approximation.
-     */
-    useExactSrgbConversions?: boolean;
 }
 /**
  * The base engine class (root of all engines)
@@ -221,11 +236,11 @@ export declare class ThinEngine {
     /**
      * Indicates if the z range in NDC space is 0..1 (value: true) or -1..1 (value: false)
      */
-    readonly isNDCHalfZRange = false;
+    readonly isNDCHalfZRange: boolean;
     /**
      * Indicates that the origin of the texture/framebuffer space is the bottom left corner. If false, the origin is top left
      */
-    readonly hasOriginBottomLeft = true;
+    readonly hasOriginBottomLeft: boolean;
     /**
      * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
      */
@@ -503,14 +518,13 @@ export declare class ThinEngine {
      * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
      */
     constructor(canvasOrContext: Nullable<HTMLCanvasElement | OffscreenCanvas | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
+    protected _setupMobileChecks(): void;
     protected _restoreEngineAfterContextLost(initEngine: () => void): void;
     /**
      * Shared initialization across engines types.
      * @param canvas The canvas associated with this instance of the engine.
-     * @param doNotHandleTouchAction Defines that engine should ignore modifying touch action attribute and style
-     * @param audioEngine Defines if an audio engine should be created by default
      */
-    protected _sharedInit(canvas: HTMLCanvasElement, doNotHandleTouchAction: boolean, audioEngine: boolean): void;
+    protected _sharedInit(canvas: HTMLCanvasElement): void;
     /**
      * @internal
      */

package/Engines/thinEngine.js

@@ -34,13 +34,13 @@ export class ThinEngine {
      */
     // Not mixed with Version for tooling purpose.
     static get NpmPackage() {
-        return "babylonjs@5.46.0";
+        return "babylonjs@5.47.1";
     }
     /**
      * Returns the current version of the framework
      */
     static get Version() {
-        return "5.46.0";
+        return "5.47.1";
     }
     /**
      * Returns a string describing the current engine
@@ -280,6 +280,7 @@ export class ThinEngine {
      * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
      */
     constructor(canvasOrContext, antialias, options, adaptToDeviceRatio) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         /** @internal */
         this._name = "WebGL";
         /**
@@ -440,66 +441,39 @@ export class ThinEngine {
         this.adaptToDeviceRatio = adaptToDeviceRatio !== null && adaptToDeviceRatio !== void 0 ? adaptToDeviceRatio : false;
         this._stencilStateComposer.stencilGlobal = this._stencilState;
         PerformanceConfigurator.SetMatrixPrecision(!!options.useHighPrecisionMatrix);
+        options.antialias = antialias !== null && antialias !== void 0 ? antialias : options.antialias;
+        options.deterministicLockstep = (_a = options.deterministicLockstep) !== null && _a !== void 0 ? _a : false;
+        options.lockstepMaxSteps = (_b = options.lockstepMaxSteps) !== null && _b !== void 0 ? _b : 4;
+        options.timeStep = (_c = options.timeStep) !== null && _c !== void 0 ? _c : 1 / 60;
+        options.audioEngine = (_d = options.audioEngine) !== null && _d !== void 0 ? _d : true;
+        options.stencil = (_e = options.stencil) !== null && _e !== void 0 ? _e : true;
+        this._audioContext = (_g = (_f = options.audioEngineOptions) === null || _f === void 0 ? void 0 : _f.audioContext) !== null && _g !== void 0 ? _g : null;
+        this._audioDestination = (_j = (_h = options.audioEngineOptions) === null || _h === void 0 ? void 0 : _h.audioDestination) !== null && _j !== void 0 ? _j : null;
+        this.premultipliedAlpha = (_k = options.premultipliedAlpha) !== null && _k !== void 0 ? _k : true;
+        this._useExactSrgbConversions = (_l = options.useExactSrgbConversions) !== null && _l !== void 0 ? _l : false;
+        this._doNotHandleContextLost = !!options.doNotHandleContextLost;
+        this._isStencilEnable = options.stencil ? true : false;
+        // Viewport
+        adaptToDeviceRatio = adaptToDeviceRatio || options.adaptToDeviceRatio || false;
+        const devicePixelRatio = IsWindowObjectExist() ? window.devicePixelRatio || 1.0 : 1.0;
+        const limitDeviceRatio = options.limitDeviceRatio || devicePixelRatio;
+        this._hardwareScalingLevel = adaptToDeviceRatio ? 1.0 / Math.min(limitDeviceRatio, devicePixelRatio) : 1.0;
+        this._lastDevicePixelRatio = devicePixelRatio;
         if (!canvasOrContext) {
             return;
         }
-        adaptToDeviceRatio = adaptToDeviceRatio || options.adaptToDeviceRatio || false;
         if (canvasOrContext.getContext) {
             canvas = canvasOrContext;
             this._renderingCanvas = canvas;
-            if (antialias !== undefined) {
-                options.antialias = antialias;
-            }
-            if (options.deterministicLockstep === undefined) {
-                options.deterministicLockstep = false;
-            }
-            if (options.lockstepMaxSteps === undefined) {
-                options.lockstepMaxSteps = 4;
-            }
-            if (options.timeStep === undefined) {
-                options.timeStep = 1 / 60;
-            }
             if (options.preserveDrawingBuffer === undefined) {
                 options.preserveDrawingBuffer = false;
             }
-            if (options.audioEngine === undefined) {
-                options.audioEngine = true;
-            }
-            if (options.audioEngineOptions !== undefined && options.audioEngineOptions.audioContext !== undefined) {
-                this._audioContext = options.audioEngineOptions.audioContext;
-            }
-            if (options.audioEngineOptions !== undefined && options.audioEngineOptions.audioDestination !== undefined) {
-                this._audioDestination = options.audioEngineOptions.audioDestination;
-            }
-            if (options.stencil === undefined) {
-                options.stencil = true;
-            }
-            if (options.premultipliedAlpha === false) {
-                this.premultipliedAlpha = false;
-            }
             if (options.xrCompatible === undefined) {
                 options.xrCompatible = true;
             }
-            if (options.useExactSrgbConversions !== undefined) {
-                this._useExactSrgbConversions = options.useExactSrgbConversions;
-            }
-            this._doNotHandleContextLost = options.doNotHandleContextLost ? true : false;
             // Exceptions
             if (navigator && navigator.userAgent) {
-                // Function to check if running on mobile device
-                this._checkForMobile = () => {
-                    const currentUA = navigator.userAgent;
-                    this.hostInformation.isMobile =
-                        currentUA.indexOf("Mobile") !== -1 ||
-                            // Needed for iOS 13+ detection on iPad (inspired by solution from https://stackoverflow.com/questions/9038625/detect-if-device-is-ios)
-                            (currentUA.indexOf("Mac") !== -1 && IsDocumentAvailable() && "ontouchend" in document);
-                };
-                // Set initial isMobile value
-                this._checkForMobile();
-                // Set up event listener to check when window is resized (used to get emulator activation to work properly)
-                if (IsWindowObjectExist()) {
-                    window.addEventListener("resize", this._checkForMobile);
-                }
+                this._setupMobileChecks();
                 const ua = navigator.userAgent;
                 for (const exception of ThinEngine.ExceptionList) {
                     const key = exception.key;
@@ -610,13 +584,7 @@ export class ThinEngine {
         if (options.useHighPrecisionFloats !== undefined) {
             this._highPrecisionShadersAllowed = options.useHighPrecisionFloats;
         }
-        // Viewport
-        const devicePixelRatio = IsWindowObjectExist() ? window.devicePixelRatio || 1.0 : 1.0;
-        const limitDeviceRatio = options.limitDeviceRatio || devicePixelRatio;
-        this._hardwareScalingLevel = adaptToDeviceRatio ? 1.0 / Math.min(limitDeviceRatio, devicePixelRatio) : 1.0;
-        this._lastDevicePixelRatio = devicePixelRatio;
         this.resize();
-        this._isStencilEnable = options.stencil ? true : false;
         this._initGLContext();
         this._initFeatures();
         // Prepare buffer pointers
@@ -641,6 +609,25 @@ export class ThinEngine {
             this._renderingCanvas.setAttribute("data-engine", versionToLog);
         }
     }
+    _setupMobileChecks() {
+        if (!(navigator && navigator.userAgent)) {
+            return;
+        }
+        // Function to check if running on mobile device
+        this._checkForMobile = () => {
+            const currentUA = navigator.userAgent;
+            this.hostInformation.isMobile =
+                currentUA.indexOf("Mobile") !== -1 ||
+                    // Needed for iOS 13+ detection on iPad (inspired by solution from https://stackoverflow.com/questions/9038625/detect-if-device-is-ios)
+                    (currentUA.indexOf("Mac") !== -1 && IsDocumentAvailable() && "ontouchend" in document);
+        };
+        // Set initial isMobile value
+        this._checkForMobile();
+        // Set up event listener to check when window is resized (used to get emulator activation to work properly)
+        if (IsWindowObjectExist()) {
+            window.addEventListener("resize", this._checkForMobile);
+        }
+    }
     _restoreEngineAfterContextLost(initEngine) {
         // Adding a timeout to avoid race condition at browser level
         setTimeout(async () => {
@@ -680,10 +667,8 @@ export class ThinEngine {
     /**
      * Shared initialization across engines types.
      * @param canvas The canvas associated with this instance of the engine.
-     * @param doNotHandleTouchAction Defines that engine should ignore modifying touch action attribute and style
-     * @param audioEngine Defines if an audio engine should be created by default
      */
-    _sharedInit(canvas, doNotHandleTouchAction, audioEngine) {
+    _sharedInit(canvas) {
         this._renderingCanvas = canvas;
     }
     /**