@babylonjs/core 7.2.2 → 7.3.0

package/Engines/engine.d.ts

@@ -1,5 +1,4 @@
 
-import { Observable } from "../Misc/observable";
 import type { Nullable } from "../types";
 import type { Scene } from "../scene";
 import { InternalTexture } from "../Materials/Textures/internalTexture";
@@ -14,23 +13,19 @@ import type { IViewportLike, IColor4Like } from "../Maths/math.like";
 import type { RenderTargetTexture } from "../Materials/Textures/renderTargetTexture";
 import { PerformanceMonitor } from "../Misc/performanceMonitor";
 import type { DataBuffer } from "../Buffers/dataBuffer";
-import { PerfCounter } from "../Misc/perfCounter";
 import type { RenderTargetWrapper } from "./renderTargetWrapper";
 import "./Extensions/engine.alpha";
 import "./Extensions/engine.readTexture";
 import "./Extensions/engine.dynamicBuffer";
-import type { IAudioEngine } from "../Audio/Interfaces/IAudioEngine";
+import "./AbstractEngine/abstractEngine.loadingScreen";
+import "./AbstractEngine/abstractEngine.dom";
+import "./AbstractEngine/abstractEngine.states";
+import "./AbstractEngine/abstractEngine.renderPass";
+import "./AbstractEngine/abstractEngine.texture";
 import type { Material } from "../Materials/material";
 import type { PostProcess } from "../PostProcesses/postProcess";
-/**
- * Defines the interface used by objects containing a viewport (like a camera)
- */
-interface IViewportOwnerLike {
-    /**
-     * Gets or sets the viewport
-     */
-    viewport: IViewportLike;
-}
+import { AbstractEngine } from "./abstractEngine";
+import "../Audio/audioEngine";
 /**
  * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  */
@@ -232,38 +227,16 @@ export declare class Engine extends ThinEngine {
      */
     static get Version(): string;
     /** Gets the list of created engines */
-    static get Instances(): Engine[];
+    static get Instances(): AbstractEngine[];
     /**
      * Gets the latest created engine
      */
-    static get LastCreatedEngine(): Nullable<Engine>;
+    static get LastCreatedEngine(): Nullable<AbstractEngine>;
     /**
      * Gets the latest created scene
      */
     static get LastCreatedScene(): Nullable<Scene>;
     /** @internal */
-    /**
-     * Engine abstraction for loading and creating an image bitmap from a given source string.
-     * @param imageSource source to load the image from.
-     * @param options An object that sets options for the image's extraction.
-     * @returns ImageBitmap.
-     */
-    _createImageBitmapFromSource(imageSource: string, options?: ImageBitmapOptions): Promise<ImageBitmap>;
-    /**
-     * Engine abstraction for createImageBitmap
-     * @param image source for image
-     * @param options An object that sets options for the image's extraction.
-     * @returns ImageBitmap
-     */
-    createImageBitmap(image: ImageBitmapSource, options?: ImageBitmapOptions): Promise<ImageBitmap>;
-    /**
-     * Resize an image and returns the image data as an uint8array
-     * @param image image to resize
-     * @param bufferWidth destination buffer width
-     * @param bufferHeight destination buffer height
-     * @returns an uint8array containing RGBA values of bufferWidth * bufferHeight size
-     */
-    resizeImageBitmap(image: HTMLImageElement | ImageBitmap, bufferWidth: number, bufferHeight: number): Uint8Array;
     /**
      * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
      * @param flag defines which part of the materials must be marked as dirty
@@ -277,136 +250,19 @@ export declare class Engine extends ThinEngine {
      * @returns The loading screen
      */
     static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
-    /**
-     * Method called to create the default rescale post process on each engine.
-     */
-    static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
-    /**
-     * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
-     **/
-    enableOfflineSupport: boolean;
-    /**
-     * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
-     **/
-    disableManifestCheck: boolean;
-    /**
-     * Gets or sets a boolean to enable/disable the context menu (right-click) from appearing on the main canvas
-     */
-    disableContextMenu: boolean;
-    /**
-     * Gets the list of created scenes
-     */
-    scenes: Scene[];
-    /** @internal */
-    _virtualScenes: Scene[];
-    /**
-     * Event raised when a new scene is created
-     */
-    onNewSceneAddedObservable: Observable<Scene>;
-    /**
-     * Gets the list of created postprocesses
-     */
-    postProcesses: PostProcess[];
-    /**
-     * Gets a boolean indicating if the pointer is currently locked
-     */
-    isPointerLock: boolean;
-    /**
-     * Observable event triggered each time the rendering canvas is resized
-     */
-    onResizeObservable: Observable<Engine>;
-    /**
-     * Observable event triggered each time the canvas loses focus
-     */
-    onCanvasBlurObservable: Observable<Engine>;
-    /**
-     * Observable event triggered each time the canvas gains focus
-     */
-    onCanvasFocusObservable: Observable<Engine>;
-    /**
-     * Observable event triggered each time the canvas receives pointerout event
-     */
-    onCanvasPointerOutObservable: Observable<PointerEvent>;
-    /**
-     * Observable raised when the engine begins a new frame
-     */
-    onBeginFrameObservable: Observable<Engine>;
     /**
      * If set, will be used to request the next animation frame for the render loop
      */
     customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
-    /**
-     * Observable raised when the engine ends the current frame
-     */
-    onEndFrameObservable: Observable<Engine>;
-    /**
-     * Observable raised when the engine is about to compile a shader
-     */
-    onBeforeShaderCompilationObservable: Observable<Engine>;
-    /**
-     * Observable raised when the engine has just compiled a shader
-     */
-    onAfterShaderCompilationObservable: Observable<Engine>;
-    /**
-     * Gets the audio engine
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic
-     * @ignorenaming
-     */
-    static audioEngine: Nullable<IAudioEngine>;
-    /**
-     * Default AudioEngine factory responsible of creating the Audio Engine.
-     * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
-     */
-    static AudioEngineFactory: (hostElement: Nullable<HTMLElement>, audioContext: Nullable<AudioContext>, audioDestination: Nullable<AudioDestinationNode | MediaStreamAudioDestinationNode>) => IAudioEngine;
-    /**
-     * Default offline support factory responsible of creating a tool used to store data locally.
-     * By default, this will create a Database object if the workload has been embedded.
-     */
-    static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
-    private _loadingScreen;
-    private _pointerLockRequested;
     private _rescalePostProcess;
-    protected _deterministicLockstep: boolean;
-    protected _lockstepMaxSteps: number;
-    protected _timeStep: number;
     protected get _supportsHardwareTextureRescaling(): boolean;
-    private _fps;
-    private _deltaTime;
-    /** @internal */
-    _drawCalls: 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 */
-    canvasTabIndex: number;
-    /**
-     * Turn this value on if you want to pause FPS computation when in background
-     */
-    disablePerformanceMonitorInBackground: boolean;
+    private _measureFps;
     private _performanceMonitor;
     /**
      * Gets the performance monitor attached to this engine
      * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#engineinstrumentation
      */
     get performanceMonitor(): PerformanceMonitor;
-    private _onFocus;
-    private _onBlur;
-    private _onCanvasPointerOut;
-    private _onCanvasBlur;
-    private _onCanvasFocus;
-    private _onCanvasContextMenu;
-    private _onFullscreenChange;
-    private _onPointerLockChange;
-    protected _compatibilityMode: boolean;
-    /**
-     * (WebGPU only) True (default) to be in compatibility mode, meaning rendering all existing scenes without artifacts (same rendering than WebGL).
-     * Setting the property to false will improve performances but may not work in some scenes if some precautions are not taken.
-     * See https://doc.babylonjs.com/setup/support/webGPU/webGPUOptimization/webGPUNonCompatibilityMode for more details
-     */
-    get compatibilityMode(): boolean;
-    set compatibilityMode(mode: boolean);
-    /**
-     * Gets the HTML element used to attach event listeners
-     * @returns a HTML element
-     */
-    getInputElement(): Nullable<HTMLElement>;
     /**
      * Creates a new engine
      * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which already used the WebGL context
@@ -421,144 +277,37 @@ export declare class Engine extends ThinEngine {
      * @param canvas The canvas associated with this instance of the engine.
      */
     protected _sharedInit(canvas: HTMLCanvasElement): void;
-    /** @internal */
-    _verifyPointerLock(): void;
     /**
-     * Gets current aspect ratio
-     * @param viewportOwner defines the camera to use to get the aspect ratio
-     * @param useScreen defines if screen size must be used (or the current render target if any)
-     * @returns a number defining the aspect ratio
-     */
-    getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
-    /**
-     * Gets current screen aspect ratio
-     * @returns a number defining the aspect ratio
-     */
-    getScreenAspectRatio(): number;
-    /**
-     * Gets the client rect of the HTML canvas attached with the current webGL context
-     * @returns a client rectangle
-     */
-    getRenderingCanvasClientRect(): Nullable<ClientRect>;
-    /**
-     * Gets the client rect of the HTML element used for events
-     * @returns a client rectangle
+     * Resize an image and returns the image data as an uint8array
+     * @param image image to resize
+     * @param bufferWidth destination buffer width
+     * @param bufferHeight destination buffer height
+     * @returns an uint8array containing RGBA values of bufferWidth * bufferHeight size
      */
-    getInputElementClientRect(): Nullable<ClientRect>;
+    resizeImageBitmap(image: HTMLImageElement | ImageBitmap, bufferWidth: number, bufferHeight: number): Uint8Array;
     /**
-     * Gets a boolean indicating that the engine is running in deterministic lock step mode
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
-     * @returns true if engine is in deterministic lock step mode
+     * Engine abstraction for loading and creating an image bitmap from a given source string.
+     * @param imageSource source to load the image from.
+     * @param options An object that sets options for the image's extraction.
+     * @returns ImageBitmap
      */
-    isDeterministicLockStep(): boolean;
+    _createImageBitmapFromSource(imageSource: string, options?: ImageBitmapOptions): Promise<ImageBitmap>;
     /**
-     * Gets the max steps when engine is running in deterministic lock step
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
-     * @returns the max steps
+     * Toggle full screen mode
+     * @param requestPointerLock defines if a pointer lock should be requested from the user
      */
-    getLockstepMaxSteps(): number;
+    switchFullscreen(requestPointerLock: boolean): void;
     /**
-     * Returns the time in ms between steps when using deterministic lock step.
-     * @returns time step in (ms)
+     * Enters full screen mode
+     * @param requestPointerLock defines if a pointer lock should be requested from the user
      */
-    getTimeStep(): number;
+    enterFullscreen(requestPointerLock: boolean): void;
     /**
-     * Force the mipmap generation for the given render target texture
-     * @param texture defines the render target texture to use
-     * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
+     * Exits full screen mode
      */
+    exitFullscreen(): void;
     generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
     /** States */
-    /**
-     * Gets a boolean indicating if depth writing is enabled
-     * @returns the current depth writing state
-     */
-    getDepthWrite(): boolean;
-    /**
-     * Enable or disable depth writing
-     * @param enable defines the state to set
-     */
-    setDepthWrite(enable: boolean): void;
-    /**
-     * Gets a boolean indicating if stencil buffer is enabled
-     * @returns the current stencil buffer state
-     */
-    getStencilBuffer(): boolean;
-    /**
-     * Enable or disable the stencil buffer
-     * @param enable defines if the stencil buffer must be enabled or disabled
-     */
-    setStencilBuffer(enable: boolean): void;
-    /**
-     * Gets the current stencil mask
-     * @returns a number defining the new stencil mask to use
-     */
-    getStencilMask(): number;
-    /**
-     * Sets the current stencil mask
-     * @param mask defines the new stencil mask to use
-     */
-    setStencilMask(mask: number): void;
-    /**
-     * Gets the current stencil function
-     * @returns a number defining the stencil function to use
-     */
-    getStencilFunction(): number;
-    /**
-     * Gets the current stencil reference value
-     * @returns a number defining the stencil reference value to use
-     */
-    getStencilFunctionReference(): number;
-    /**
-     * Gets the current stencil mask
-     * @returns a number defining the stencil mask to use
-     */
-    getStencilFunctionMask(): number;
-    /**
-     * Sets the current stencil function
-     * @param stencilFunc defines the new stencil function to use
-     */
-    setStencilFunction(stencilFunc: number): void;
-    /**
-     * Sets the current stencil reference
-     * @param reference defines the new stencil reference to use
-     */
-    setStencilFunctionReference(reference: number): void;
-    /**
-     * Sets the current stencil mask
-     * @param mask defines the new stencil mask to use
-     */
-    setStencilFunctionMask(mask: number): void;
-    /**
-     * Gets the current stencil operation when stencil fails
-     * @returns a number defining stencil operation to use when stencil fails
-     */
-    getStencilOperationFail(): number;
-    /**
-     * Gets the current stencil operation when depth fails
-     * @returns a number defining stencil operation to use when depth fails
-     */
-    getStencilOperationDepthFail(): number;
-    /**
-     * Gets the current stencil operation when stencil passes
-     * @returns a number defining stencil operation to use when stencil passes
-     */
-    getStencilOperationPass(): number;
-    /**
-     * Sets the stencil operation to use when stencil fails
-     * @param operation defines the stencil operation to use when stencil fails
-     */
-    setStencilOperationFail(operation: number): void;
-    /**
-     * Sets the stencil operation to use when depth fails
-     * @param operation defines the stencil operation to use when depth fails
-     */
-    setStencilOperationDepthFail(operation: number): void;
-    /**
-     * Sets the stencil operation to use when stencil passes
-     * @param operation defines the stencil operation to use when stencil passes
-     */
-    setStencilOperationPass(operation: number): void;
     /**
      * Sets a boolean indicating if the dithering state is enabled or disabled
      * @param value defines the dithering state
@@ -569,47 +318,6 @@ export declare class Engine extends ThinEngine {
      * @param value defines the rasterizer state
      */
     setRasterizerState(value: boolean): void;
-    /**
-     * Gets the current depth function
-     * @returns a number defining the depth function
-     */
-    getDepthFunction(): Nullable<number>;
-    /**
-     * Sets the current depth function
-     * @param depthFunc defines the function to use
-     */
-    setDepthFunction(depthFunc: number): void;
-    /**
-     * Sets the current depth function to GREATER
-     */
-    setDepthFunctionToGreater(): void;
-    /**
-     * Sets the current depth function to GEQUAL
-     */
-    setDepthFunctionToGreaterOrEqual(): void;
-    /**
-     * Sets the current depth function to LESS
-     */
-    setDepthFunctionToLess(): void;
-    /**
-     * Sets the current depth function to LEQUAL
-     */
-    setDepthFunctionToLessOrEqual(): void;
-    private _cachedStencilBuffer;
-    private _cachedStencilFunction;
-    private _cachedStencilMask;
-    private _cachedStencilOperationPass;
-    private _cachedStencilOperationFail;
-    private _cachedStencilOperationDepthFail;
-    private _cachedStencilReference;
-    /**
-     * Caches the state of the stencil buffer
-     */
-    cacheStencilState(): void;
-    /**
-     * Restores the state of the stencil buffer
-     */
-    restoreStencilState(): void;
     /**
      * Directly set the WebGL Viewport
      * @param x defines the x coordinate of the viewport (in screen space)
@@ -643,7 +351,6 @@ export declare class Engine extends ThinEngine {
     /**
      * @internal
      */
-    _reportDrawCall(numDrawCalls?: number): void;
     _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: false): Promise<string>;
     _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: true): Promise<ArrayBuffer>;
     /**
@@ -667,7 +374,7 @@ export declare class Engine extends ThinEngine {
      */
     setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>, name?: string): void;
     /**
-     * Sets a texture to the webGL context from a postprocess
+     * Sets a texture to the context from a postprocess
      * @param channel defines the channel to use
      * @param postProcess defines the source postprocess
      * @param name name of the channel
@@ -690,27 +397,22 @@ export declare class Engine extends ThinEngine {
         framebufferHeight: number;
     }>);
     protected _rebuildBuffers(): void;
-    protected _rebuildTextures(): void;
+    /**
+     * Get Font size information
+     * @param font font name
+     * @returns an object containing ascent, height and descent
+     */
+    getFontOffset(font: string): {
+        ascent: number;
+        height: number;
+        descent: number;
+    };
     /** @internal */
     _renderFrame(): void;
     protected _cancelFrame(): void;
     _renderLoop(): void;
     /** @internal */
     _renderViews(): boolean;
-    /**
-     * Toggle full screen mode
-     * @param requestPointerLock defines if a pointer lock should be requested from the user
-     */
-    switchFullscreen(requestPointerLock: boolean): void;
-    /**
-     * Enters full screen mode
-     * @param requestPointerLock defines if a pointer lock should be requested from the user
-     */
-    enterFullscreen(requestPointerLock: boolean): void;
-    /**
-     * Exits full screen mode
-     */
-    exitFullscreen(): void;
     /**
      * Enters Pointerlock mode
      */
@@ -723,10 +425,6 @@ export declare class Engine extends ThinEngine {
      * Begin a new frame
      */
     beginFrame(): void;
-    /**
-     * End the current frame
-     */
-    endFrame(): void;
     /**
      * Force a specific size of the canvas
      * @param width defines the new canvas' width
@@ -746,33 +444,6 @@ export declare class Engine extends ThinEngine {
      * @internal
      */
     _releaseRenderTargetWrapper(rtWrapper: RenderTargetWrapper): void;
-    protected static _RenderPassIdCounter: number;
-    /**
-     * Gets or sets the current render pass id
-     */
-    currentRenderPassId: number;
-    private _renderPassNames;
-    /**
-     * Gets the names of the render passes that are currently created
-     * @returns list of the render pass names
-     */
-    getRenderPassNames(): string[];
-    /**
-     * Gets the name of the current render pass
-     * @returns name of the current render pass
-     */
-    getCurrentRenderPassName(): string;
-    /**
-     * Creates a render pass id
-     * @param name Name of the render pass (for debug purpose only)
-     * @returns the id of the new render pass
-     */
-    createRenderPassId(name?: string): number;
-    /**
-     * Releases a render pass id
-     * @param id id of the render pass to release
-     */
-    releaseRenderPassId(id: number): void;
     /**
      * @internal
      * Rescales a texture
@@ -783,17 +454,6 @@ export declare class Engine extends ThinEngine {
      * @param onComplete callback to be called when resize has completed
      */
     _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
-    /**
-     * Gets the current framerate
-     * @returns a number representing the framerate
-     */
-    getFps(): number;
-    /**
-     * Gets the time spent between current and previous frame
-     * @returns a number representing the delta time in ms
-     */
-    getDeltaTime(): number;
-    private _measureFps;
     /**
      * Wraps an external web gl texture in a Babylon texture.
      * @param texture defines the external texture
@@ -833,74 +493,7 @@ export declare class Engine extends ThinEngine {
      */
     _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
     dispose(): void;
-    private _disableTouchAction;
-    /**
-     * Display the loading screen
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    displayLoadingUI(): void;
-    /**
-     * Hide the loading screen
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    hideLoadingUI(): void;
-    /**
-     * Gets the current loading screen object
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    get loadingScreen(): ILoadingScreen;
-    /**
-     * Sets the current loading screen object
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    set loadingScreen(loadingScreen: ILoadingScreen);
-    /**
-     * Sets the current loading screen text
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    set loadingUIText(text: string);
-    /**
-     * Sets the current loading screen background color
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/scene/customLoadingScreen
-     */
-    set loadingUIBackgroundColor(color: string);
-    /**
-     * creates and returns a new video element
-     * @param constraints video constraints
-     * @returns video element
-     */
-    createVideoElement(constraints: MediaTrackConstraints): any;
-    /** Pointerlock and fullscreen */
-    /**
-     * Ask the browser to promote the current element to pointerlock mode
-     * @param element defines the DOM element to promote
-     */
-    static _RequestPointerlock(element: HTMLElement): void;
-    /**
-     * Asks the browser to exit pointerlock mode
-     */
-    static _ExitPointerlock(): void;
-    /**
-     * Ask the browser to promote the current element to fullscreen rendering mode
-     * @param element defines the DOM element to promote
-     */
-    static _RequestFullscreen(element: HTMLElement): void;
-    /**
-     * Asks the browser to exit fullscreen mode
-     */
-    static _ExitFullscreen(): void;
-    /**
-     * Get Font size information
-     * @param font font name
-     * @returns an object containing ascent, height and descent
-     */
-    getFontOffset(font: string): {
-        ascent: number;
-        height: number;
-        descent: number;
-    };
 }
-export {};
 
 // Mixins
 declare global{