@babylonjs/core 5.24.0 → 5.26.0

package/Engines/thinEngine.d.ts

@@ -40,7 +40,7 @@ import type { LoadFileError } from "../Misc/fileTools";
 import type { Texture } from "../Materials/Textures/texture";
 /**
  * Defines the interface used by objects working like Scene
- * @hidden
+ * @internal
  */
 export interface ISceneLike {
     addPendingData(data: any): void;
@@ -149,7 +149,7 @@ export declare class ThinEngine {
         captureConstraint: null;
         targets: string[];
     })[];
-    /** @hidden */
+    /** @internal */
     static _TextureLoaders: IInternalTextureLoader[];
     /**
      * Returns the current npm package of the sdk
@@ -163,7 +163,7 @@ export declare class ThinEngine {
      * Returns a string describing the current engine
      */
     get description(): string;
-    /** @hidden */
+    /** @internal */
     protected _name: string;
     /**
      * Gets or sets the name of the engine
@@ -185,8 +185,7 @@ export declare class ThinEngine {
     static set ShadersRepository(value: string);
     protected _shaderProcessor: Nullable<IShaderProcessor>;
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessor(shaderLanguage: ShaderLanguage): Nullable<IShaderProcessor>;
     /**
@@ -240,18 +239,18 @@ export declare class ThinEngine {
      * Gets the current frame id
      */
     get frameId(): number;
-    /** @hidden */
+    /** @internal */
     _uniformBuffers: UniformBuffer[];
-    /** @hidden */
+    /** @internal */
     _storageBuffers: StorageBuffer[];
     /**
      * Gets a boolean indicating that the engine supports uniform buffers
      * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
      */
     get supportsUniformBuffers(): boolean;
-    /** @hidden */
+    /** @internal */
     _gl: WebGL2RenderingContext;
-    /** @hidden */
+    /** @internal */
     _webGLVersion: number;
     protected _renderingCanvas: Nullable<HTMLCanvasElement>;
     protected _windowIsBackground: boolean;
@@ -264,28 +263,28 @@ export declare class ThinEngine {
      */
     getCreationOptions(): EngineOptions;
     protected _highPrecisionShadersAllowed: boolean;
-    /** @hidden */
+    /** @internal */
     get _shouldUseHighPrecisionShader(): boolean;
     /**
      * Gets a boolean indicating that only power of 2 textures are supported
      * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
      */
     get needPOTTextures(): boolean;
-    /** @hidden */
+    /** @internal */
     _badOS: boolean;
-    /** @hidden */
+    /** @internal */
     _badDesktopOS: boolean;
-    /** @hidden */
+    /** @internal */
     _hardwareScalingLevel: number;
-    /** @hidden */
+    /** @internal */
     _caps: EngineCapabilities;
-    /** @hidden */
+    /** @internal */
     _features: EngineFeatures;
     protected _isStencilEnable: boolean;
     private _glVersion;
     private _glRenderer;
     private _glVendor;
-    /** @hidden */
+    /** @internal */
     _videoTextureSupported: boolean;
     protected _renderingQueueLaunched: boolean;
     protected _activeRenderLoops: (() => void)[];
@@ -305,7 +304,7 @@ export declare class ThinEngine {
     private _onContextLost;
     private _onContextRestored;
     protected _contextWasLost: boolean;
-    /** @hidden */
+    /** @internal */
     _doNotHandleContextLost: boolean;
     /**
      * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
@@ -317,70 +316,70 @@ export declare class ThinEngine {
      * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
      */
     disableVertexArrayObjects: boolean;
-    /** @hidden */
+    /** @internal */
     protected _colorWrite: boolean;
-    /** @hidden */
+    /** @internal */
     protected _colorWriteChanged: boolean;
-    /** @hidden */
+    /** @internal */
     protected _depthCullingState: DepthCullingState;
-    /** @hidden */
+    /** @internal */
     protected _stencilStateComposer: StencilStateComposer;
-    /** @hidden */
+    /** @internal */
     protected _stencilState: StencilState;
-    /** @hidden */
+    /** @internal */
     _alphaState: AlphaState;
-    /** @hidden */
+    /** @internal */
     _alphaMode: number;
-    /** @hidden */
+    /** @internal */
     _alphaEquation: number;
-    /** @hidden */
+    /** @internal */
     _internalTexturesCache: InternalTexture[];
-    /** @hidden */
+    /** @internal */
     _renderTargetWrapperCache: RenderTargetWrapper[];
-    /** @hidden */
+    /** @internal */
     protected _activeChannel: number;
     private _currentTextureChannel;
-    /** @hidden */
+    /** @internal */
     protected _boundTexturesCache: {
         [key: string]: Nullable<InternalTexture>;
     };
     protected _currentEffect: Nullable<Effect>;
-    /** @hidden */
+    /** @internal */
     _currentDrawContext: IDrawContext;
-    /** @hidden */
+    /** @internal */
     _currentMaterialContext: IMaterialContext;
-    /** @hidden */
+    /** @internal */
     protected _currentProgram: Nullable<WebGLProgram>;
     protected _compiledEffects: {
         [key: string]: Effect;
     };
     private _vertexAttribArraysEnabled;
-    /** @hidden */
+    /** @internal */
     protected _cachedViewport: Nullable<IViewportLike>;
     private _cachedVertexArrayObject;
-    /** @hidden */
+    /** @internal */
     protected _cachedVertexBuffers: any;
-    /** @hidden */
+    /** @internal */
     protected _cachedIndexBuffer: Nullable<DataBuffer>;
-    /** @hidden */
+    /** @internal */
     protected _cachedEffectForVertexBuffers: Nullable<Effect>;
-    /** @hidden */
+    /** @internal */
     _currentRenderTarget: Nullable<RenderTargetWrapper>;
     private _uintIndicesCurrentlySet;
     protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
-    /** @hidden */
+    /** @internal */
     _currentFramebuffer: Nullable<WebGLFramebuffer>;
-    /** @hidden */
+    /** @internal */
     _dummyFramebuffer: Nullable<WebGLFramebuffer>;
     private _currentBufferPointers;
     private _currentInstanceLocations;
     private _currentInstanceBuffers;
     private _textureUnits;
-    /** @hidden */
+    /** @internal */
     _workingCanvas: Nullable<ICanvas>;
-    /** @hidden */
+    /** @internal */
     _workingContext: Nullable<ICanvasRenderingContext>;
-    /** @hidden */
+    /** @internal */
     _boundRenderFunction: any;
     private _vaoRecordInProgress;
     private _mustWipeVertexAttributes;
@@ -388,7 +387,7 @@ export declare class ThinEngine {
     private _emptyCubeTexture;
     private _emptyTexture3D;
     private _emptyTexture2DArray;
-    /** @hidden */
+    /** @internal */
     _frameHandler: number;
     private _nextFreeTextureSlots;
     private _maxSimultaneousTextures;
@@ -398,9 +397,9 @@ export declare class ThinEngine {
      * If set to true zooming in and out in the browser will rescale the hardware-scaling correctly.
      */
     adaptToDeviceRatio: boolean;
-    /** @hidden */
+    /** @internal */
     private _lastDevicePixelRatio;
-    /** @hidden */
+    /** @internal */
     _transformTextureUrl: Nullable<(url: string) => string>;
     /**
      * Gets information about the current host
@@ -445,13 +444,13 @@ export declare class ThinEngine {
      * Observable event triggered before each texture is initialized
      */
     onBeforeTextureInitObservable: Observable<Texture>;
-    /** @hidden */
+    /** @internal */
     protected _isWebGPU: boolean;
     /**
      * Gets a boolean indicating if the engine runs in WebGPU or not.
      */
     get isWebGPU(): boolean;
-    /** @hidden */
+    /** @internal */
     protected _shaderPlatformName: string;
     /**
      * Gets the shader platform name used by the effects.
@@ -509,8 +508,7 @@ export declare class ThinEngine {
      */
     protected _sharedInit(canvas: HTMLCanvasElement, doNotHandleTouchAction: boolean, audioEngine: boolean): void;
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessingContext(shaderLanguage: ShaderLanguage): Nullable<ShaderProcessingContext>;
     private _rebuildInternalTextures;
@@ -538,7 +536,7 @@ export declare class ThinEngine {
      * Returns true if the stencil buffer has been enabled through the creation option of the context.
      */
     get isStencilEnable(): boolean;
-    /** @hidden */
+    /** @internal */
     _prepareWorkingCanvas(): void;
     /**
      * Reset the texture cache to empty state
@@ -591,7 +589,7 @@ export declare class ThinEngine {
      * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
      */
     stopRenderLoop(renderFunction?: () => void): void;
-    /** @hidden */
+    /** @internal */
     _renderLoop(): void;
     /**
      * Gets the HTML canvas attached with the current webGL context
@@ -627,9 +625,7 @@ export declare class ThinEngine {
     getRenderHeight(useScreen?: boolean): number;
     /**
      * Can be used to override the current requestAnimationFrame requester.
-     * @param bindedRenderFunction
-     * @param requester
-     * @hidden
+     * @internal
      */
     protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
     /**
@@ -652,11 +648,7 @@ export declare class ThinEngine {
         w: number;
     };
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @hidden
+     * @internal
      */
     _viewport(x: number, y: number, width: number, height: number): void;
     /**
@@ -740,11 +732,10 @@ export declare class ThinEngine {
      */
     getZOffsetUnits(): number;
     /**
-     * @param framebuffer
-     * @hidden
+     * @internal
      */
     _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
-    /** @hidden */
+    /** @internal */
     _currentFrameBufferIsDefaultFrameBuffer(): boolean;
     /**
      * Generates the mipmaps for a texture
@@ -766,7 +757,7 @@ export declare class ThinEngine {
      * Unbind the current render target and bind the default framebuffer
      */
     restoreDefaultFramebuffer(): void;
-    /** @hidden */
+    /** @internal */
     protected _resetVertexBufferBinding(): void;
     /**
      * Creates a vertex buffer
@@ -804,8 +795,7 @@ export declare class ThinEngine {
     updateArrayBuffer(data: Float32Array): void;
     private _vertexAttribPointer;
     /**
-     * @param indexBuffer
-     * @hidden
+     * @internal
      */
     _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
     private _bindVertexBuffersAttributes;
@@ -862,8 +852,7 @@ export declare class ThinEngine {
      */
     releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
     /**
-     * @param buffer
-     * @hidden
+     * @internal
      */
     _releaseBuffer(buffer: DataBuffer): boolean;
     protected _deleteBuffer(buffer: DataBuffer): void;
@@ -936,19 +925,17 @@ export declare class ThinEngine {
      */
     drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
     private _drawMode;
-    /** @hidden */
+    /** @internal */
     protected _reportDrawCall(): void;
     /**
-     * @param effect
-     * @hidden
+     * @internal
      */
     _releaseEffect(effect: Effect): void;
     /**
-     * @param pipelineContext
-     * @hidden
+     * @internal
      */
     _deletePipelineContext(pipelineContext: IPipelineContext): void;
-    /** @hidden */
+    /** @internal */
     _getGlobalDefines(defines?: {
         [key: string]: string;
     }): string | undefined;
@@ -971,8 +958,7 @@ export declare class ThinEngine {
     private _compileShader;
     private _compileRawShader;
     /**
-     * @param shader
-     * @hidden
+     * @internal
      */
     _getShaderSource(shader: WebGLShader): Nullable<string>;
     /**
@@ -1021,28 +1007,15 @@ export declare class ThinEngine {
     protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
     protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
     /**
-     * @param pipelineContext
-     * @param vertexSourceCode
-     * @param fragmentSourceCode
-     * @param createAsRaw
-     * @param rawVertexSourceCode
-     * @param rawFragmentSourceCode
-     * @param rebuildRebind
-     * @param defines
-     * @param transformFeedbackVaryings
-     * @param key
-     * @hidden
+     * @internal
      */
     _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rawVertexSourceCode: string, rawFragmentSourceCode: string, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>, key: string): void;
     /**
-     * @param pipelineContext
-     * @hidden
+     * @internal
      */
     _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
     /**
-     * @param pipelineContext
-     * @param action
-     * @hidden
+     * @internal
      */
     _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
     /**
@@ -1251,21 +1224,19 @@ export declare class ThinEngine {
      */
     wipeCaches(bruteForce?: boolean): void;
     /**
-     * @param samplingMode
-     * @param generateMipMaps
-     * @hidden
+     * @internal
      */
     _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
         min: number;
         mag: number;
     };
-    /** @hidden */
+    /** @internal */
     protected _createTexture(): WebGLTexture;
-    /** @hidden */
+    /** @internal */
     _createHardwareTexture(): HardwareTextureWrapper;
     /**
      * 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
@@ -1274,9 +1245,7 @@ export declare class ThinEngine {
      */
     _createInternalTexture(size: TextureSize, options: boolean | InternalTextureCreationOptions, delayGPUTextureCreation?: boolean, source?: InternalTextureSource): InternalTexture;
     /**
-     * @param useSRGBBuffer
-     * @param noMipmap
-     * @hidden
+     * @internal
      */
     _getUseSRGBBuffer(useSRGBBuffer: boolean, noMipmap: boolean): boolean;
     protected _createTextureBase(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode: number | undefined, onLoad: Nullable<(texture: InternalTexture) => void> | undefined, onError: Nullable<(message: string, exception: any) => void> | undefined, prepareTexture: (texture: InternalTexture, extension: string, scene: Nullable<ISceneLike>, img: HTMLImageElement | ImageBitmap | {
@@ -1322,16 +1291,11 @@ export declare 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: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string, imageBitmapOptions?: ImageBitmapOptions): Nullable<HTMLImageElement>;
     /**
-     * @param source
-     * @param destination
-     * @param scene
-     * @param internalFormat
-     * @param onComplete
-     * @hidden
+     * @internal
      */
     _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
     private _unpackFlipYCached;
@@ -1342,11 +1306,10 @@ export declare class ThinEngine {
      */
     enableUnpackFlipYCached: boolean;
     /**
-     * @param value
-     * @hidden
+     * @internal
      */
     _unpackFlipY(value: boolean): void;
-    /** @hidden */
+    /** @internal */
     _getUnpackAlignement(): number;
     private _getTextureTarget;
     /**
@@ -1373,13 +1336,7 @@ export declare class ThinEngine {
      */
     updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
     /**
-     * @param internalTexture
-     * @param size
-     * @param generateStencil
-     * @param bilinearFiltering
-     * @param comparisonFunction
-     * @param samples
-     * @hidden
+     * @internal
      */
     _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
         width: number;
@@ -1387,24 +1344,11 @@ export declare class ThinEngine {
         layers?: number;
     }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number, samples?: number): void;
     /**
-     * @param texture
-     * @param internalFormat
-     * @param width
-     * @param height
-     * @param data
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @param babylonInternalFormat
-     * @param useTextureWidthAndHeight
-     * @hidden
+     * @internal
      */
     _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
     /**
@@ -1421,44 +1365,26 @@ export declare class ThinEngine {
      */
     updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number, generateMipMaps?: boolean): void;
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
     protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
     private _prepareWebGLTexture;
     /**
-     * @param generateStencilBuffer
-     * @param generateDepthBuffer
-     * @param width
-     * @param height
-     * @param samples
-     * @hidden
+     * @internal
      */
     _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
     /**
-     * @param width
-     * @param height
-     * @param samples
-     * @param internalFormat
-     * @param msInternalFormat
-     * @param attachment
-     * @param unbindBuffer
-     * @hidden
+     * @internal
      */
     _createRenderBuffer(width: number, height: number, samples: number, internalFormat: number, msInternalFormat: number, attachment: number, unbindBuffer?: boolean): Nullable<WebGLRenderbuffer>;
     _updateRenderBuffer(renderBuffer: Nullable<WebGLRenderbuffer>, width: number, height: number, samples: number, internalFormat: number, msInternalFormat: number, attachment: number, unbindBuffer?: boolean): Nullable<WebGLRenderbuffer>;
     /**
-     * @param texture
-     * @hidden
+     * @internal
      */
     _releaseTexture(texture: InternalTexture): void;
     /**
-     * @param rtWrapper
-     * @hidden
+     * @internal
      */
     _releaseRenderTargetWrapper(rtWrapper: RenderTargetWrapper): void;
     protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
@@ -1473,18 +1399,11 @@ export declare class ThinEngine {
     bindSamplers(effect: Effect): void;
     private _activateCurrentTexture;
     /**
-     * @param target
-     * @param texture
-     * @param forTextureDataUpdate
-     * @param force
-     * @hidden
+     * @internal
      */
     _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
     /**
-     * @param channel
-     * @param texture
-     * @param name
-     * @hidden
+     * @internal
      */
     _bindTexture(channel: number, texture: Nullable<InternalTexture>, name: string): void;
     /**
@@ -1511,10 +1430,7 @@ export declare class ThinEngine {
      */
     setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: ThinTexture[], name: string): void;
     /**
-     * @param target
-     * @param internalTexture
-     * @param anisotropicFilteringLevel
-     * @hidden
+     * @internal
      */
     _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
     private _setTextureParameterFloat;
@@ -1551,36 +1467,23 @@ export declare class ThinEngine {
     private _canRenderToHalfFloatFramebuffer;
     private _canRenderToFramebuffer;
     /**
-     * @param type
-     * @hidden
+     * @internal
      */
     _getWebGLTextureType(type: number): number;
     /**
-     * @param format
-     * @param useSRGBBuffer
-     * @hidden
+     * @internal
      */
     _getInternalFormat(format: number, useSRGBBuffer?: boolean): number;
     /**
-     * @param type
-     * @param format
-     * @param useSRGBBuffer
-     * @hidden
+     * @internal
      */
     _getRGBABufferInternalSizedFormat(type: number, format?: number, useSRGBBuffer?: boolean): number;
     /**
-     * @param type
-     * @hidden
+     * @internal
      */
     _getRGBAMultiSampleBufferFormat(type: number): number;
     /**
-     * @param url
-     * @param onSuccess
-     * @param onProgress
-     * @param offlineProvider
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
     /**
@@ -1592,7 +1495,7 @@ export declare 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: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
     /**