@babylonjs/core 5.24.0 → 5.26.0

package/Engines/webgpuEngine.d.ts

@@ -145,48 +145,48 @@ export declare class WebGPUEngine extends Engine {
     private readonly _uploadEncoderDescriptor;
     private readonly _renderEncoderDescriptor;
     private readonly _renderTargetEncoderDescriptor;
-    /** @hidden */
+    /** @internal */
     readonly _clearDepthValue = 1;
-    /** @hidden */
+    /** @internal */
     readonly _clearReverseDepthValue = 0;
-    /** @hidden */
+    /** @internal */
     readonly _clearStencilValue = 0;
     private readonly _defaultSampleCount;
     private _canvas;
-    /** @hidden */
+    /** @internal */
     _options: WebGPUEngineOptions;
     private _glslang;
     private _tintWASM;
     private _adapter;
     private _adapterSupportedExtensions;
-    /** @hidden */
+    /** @internal */
     _device: GPUDevice;
     private _deviceEnabledExtensions;
     private _context;
     private _swapChainTexture;
     private _mainPassSampleCount;
-    /** @hidden */
+    /** @internal */
     _textureHelper: WebGPUTextureHelper;
-    /** @hidden */
+    /** @internal */
     _bufferManager: WebGPUBufferManager;
     private _clearQuad;
-    /** @hidden */
+    /** @internal */
     _cacheSampler: WebGPUCacheSampler;
-    /** @hidden */
+    /** @internal */
     _cacheRenderPipeline: WebGPUCacheRenderPipeline;
     private _cacheBindGroups;
     private _emptyVertexBuffer;
-    /** @hidden */
+    /** @internal */
     _mrtAttachments: number[];
-    /** @hidden */
+    /** @internal */
     _timestampQuery: WebGPUTimestampQuery;
-    /** @hidden */
+    /** @internal */
     _occlusionQuery: WebGPUOcclusionQuery;
-    /** @hidden */
+    /** @internal */
     _compiledComputeEffects: {
         [key: string]: ComputeEffect;
     };
-    /** @hidden */
+    /** @internal */
     _counters: {
         numEnableEffects: number;
         numEnableDrawWrapper: number;
@@ -212,52 +212,52 @@ export declare class WebGPUEngine extends Engine {
     private _mainTextureExtends;
     private _depthTextureFormat;
     private _colorFormat;
-    /** @hidden */
+    /** @internal */
     _ubInvertY: WebGPUDataBuffer;
-    /** @hidden */
+    /** @internal */
     _ubDontInvertY: WebGPUDataBuffer;
-    /** @hidden */
+    /** @internal */
     _uploadEncoder: GPUCommandEncoder;
-    /** @hidden */
+    /** @internal */
     _renderEncoder: GPUCommandEncoder;
-    /** @hidden */
+    /** @internal */
     _renderTargetEncoder: GPUCommandEncoder;
     private _commandBuffers;
-    /** @hidden */
+    /** @internal */
     _currentRenderPass: Nullable<GPURenderPassEncoder>;
-    /** @hidden */
+    /** @internal */
     _mainRenderPassWrapper: WebGPURenderPassWrapper;
-    /** @hidden */
+    /** @internal */
     _rttRenderPassWrapper: WebGPURenderPassWrapper;
-    /** @hidden */
+    /** @internal */
     _pendingDebugCommands: Array<[string, Nullable<string>]>;
-    /** @hidden */
+    /** @internal */
     _bundleList: WebGPUBundleList;
-    /** @hidden */
+    /** @internal */
     _bundleListRenderTarget: WebGPUBundleList;
-    /** @hidden */
+    /** @internal */
     _onAfterUnbindFrameBufferObservable: Observable<WebGPUEngine>;
     private _defaultDrawContext;
     private _defaultMaterialContext;
-    /** @hidden */
+    /** @internal */
     _currentDrawContext: WebGPUDrawContext;
-    /** @hidden */
+    /** @internal */
     _currentMaterialContext: WebGPUMaterialContext;
     private _currentOverrideVertexBuffers;
     private _currentIndexBuffer;
     private _colorWriteLocal;
     private _forceEnableEffect;
-    /** @hidden */
+    /** @internal */
     dbgShowShaderCode: boolean;
-    /** @hidden */
+    /** @internal */
     dbgSanityChecks: boolean;
-    /** @hidden */
+    /** @internal */
     dbgVerboseLogsForFirstFrames: boolean;
-    /** @hidden */
+    /** @internal */
     dbgVerboseLogsNumFrames: number;
-    /** @hidden */
+    /** @internal */
     dbgLogIfNotDrawWrapper: boolean;
-    /** @hidden */
+    /** @internal */
     dbgShowEmptyEnableEffectCalls: boolean;
     private _snapshotRendering;
     /**
@@ -330,7 +330,7 @@ export declare class WebGPUEngine extends Engine {
      */
     get compatibilityMode(): boolean;
     set compatibilityMode(mode: boolean);
-    /** @hidden */
+    /** @internal */
     get currentSampleCount(): number;
     /**
      * Create a new instance of the gpu engine asynchronously
@@ -367,16 +367,14 @@ export declare class WebGPUEngine extends Engine {
     setSize(width: number, height: number, forceSetSize?: boolean): boolean;
     private _shaderProcessorWGSL;
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessor(shaderLanguage: ShaderLanguage): Nullable<IShaderProcessor>;
     /**
-     * @param shaderLanguage
-     * @hidden
+     * @internal
      */
     _getShaderProcessingContext(shaderLanguage: ShaderLanguage): Nullable<ShaderProcessingContext>;
-    /** @hidden */
+    /** @internal */
     applyStates(): void;
     /**
      * Force the entire cache to be cleared
@@ -399,11 +397,7 @@ export declare class WebGPUEngine extends Engine {
     private _mustUpdateViewport;
     private _applyViewport;
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @hidden
+     * @internal
      */
     _viewport(x: number, y: number, width: number, height: number): void;
     private _scissorsCurrent;
@@ -423,8 +417,7 @@ export declare class WebGPUEngine extends Engine {
     private _resetCurrentStencilRef;
     private _mustUpdateStencilRef;
     /**
-     * @param renderPass
-     * @hidden
+     * @internal
      */
     _applyStencilRef(renderPass: GPURenderPassEncoder): void;
     private _blendColorsCurrent;
@@ -459,17 +452,15 @@ export declare class WebGPUEngine extends Engine {
      */
     createIndexBuffer(indices: IndicesArray): DataBuffer;
     /**
-     * @param data
-     * @param creationFlags
-     * @hidden
+     * @internal
      */
     _createBuffer(data: DataArray | number, creationFlags: number): DataBuffer;
     /**
-     * @hidden
+     * @internal
      */
     bindBuffersDirectly(): void;
     /**
-     * @hidden
+     * @internal
      */
     updateAndBindInstancesBuffer(): void;
     /**
@@ -485,8 +476,7 @@ export declare class WebGPUEngine extends Engine {
         [kind: string]: Nullable<VertexBuffer>;
     }): void;
     /**
-     * @param buffer
-     * @hidden
+     * @internal
      */
     _releaseBuffer(buffer: DataBuffer): boolean;
     /**
@@ -511,11 +501,11 @@ export declare class WebGPUEngine extends Engine {
     private _compileRawPipelineStageDescriptor;
     private _compilePipelineStageDescriptor;
     /**
-     * @hidden
+     * @internal
      */
     createRawShaderProgram(): WebGLProgram;
     /**
-     * @hidden
+     * @internal
      */
     createShaderProgram(): WebGLProgram;
     /**
@@ -541,15 +531,7 @@ export declare class WebGPUEngine extends Engine {
      */
     createDrawContext(): WebGPUDrawContext | undefined;
     /**
-     * @param pipelineContext
-     * @param vertexSourceCode
-     * @param fragmentSourceCode
-     * @param createAsRaw
-     * @param rawVertexSourceCode
-     * @param rawFragmentSourceCode
-     * @param rebuildRebind
-     * @param defines
-     * @hidden
+     * @internal
      */
     _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rawVertexSourceCode: string, rawFragmentSourceCode: string, rebuildRebind: any, defines: Nullable<string>): void;
     /**
@@ -565,8 +547,7 @@ export declare class WebGPUEngine extends Engine {
      */
     enableEffect(effect: Nullable<Effect | DrawWrapper>): void;
     /**
-     * @param effect
-     * @hidden
+     * @internal
      */
     _releaseEffect(effect: Effect): void;
     /**
@@ -579,21 +560,20 @@ export declare class WebGPUEngine extends Engine {
      * 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 */
     _createHardwareTexture(): HardwareTextureWrapper;
     /**
-     * @param texture
-     * @hidden
+     * @internal
      */
     _releaseTexture(texture: InternalTexture): void;
     /**
-     * @hidden
+     * @internal
      */
     _getRGBABufferInternalSizedFormat(): number;
     updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
     /**
      * 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
@@ -661,10 +641,7 @@ export declare class WebGPUEngine extends Engine {
      */
     updateTextureDimensions(texture: InternalTexture, width: number, height: number, depth?: number): void;
     /**
-     * @param name
-     * @param texture
-     * @param baseName
-     * @hidden
+     * @internal
      */
     _setInternalTexture(name: string, texture: Nullable<InternalTexture | ExternalTexture>, baseName?: string): void;
     /**
@@ -685,17 +662,11 @@ export declare class WebGPUEngine extends Engine {
     setTextureArray(channel: number, unused: Nullable<WebGLUniformLocation>, textures: BaseTexture[], name: string): void;
     protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean, name?: string, baseName?: string): boolean;
     /**
-     * @param target
-     * @param internalTexture
-     * @param anisotropicFilteringLevel
-     * @hidden
+     * @internal
      */
     _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
     /**
-     * @param channel
-     * @param texture
-     * @param name
-     * @hidden
+     * @internal
      */
     _bindTexture(channel: number, texture: InternalTexture, name: string): void;
     /**
@@ -704,9 +675,7 @@ export declare class WebGPUEngine extends Engine {
      */
     generateMipmaps(texture: InternalTexture): void;
     /**
-     * @param texture
-     * @param commandEncoder
-     * @hidden
+     * @internal
      */
     _generateMipmaps(texture: InternalTexture, commandEncoder?: GPUCommandEncoder): void;
     /**
@@ -723,40 +692,19 @@ export declare class WebGPUEngine extends Engine {
      */
     updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number, generateMipMaps?: boolean): void;
     /**
-     * @param texture
-     * @param internalFormat
-     * @param width
-     * @param height
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, imageData: 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;
     /**
-     * @param texture
-     * @param imageData
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
     /**
-     * @param texture
-     * @param image
-     * @param faceIndex
-     * @param lod
-     * @hidden
+     * @internal
      */
     _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
     /**
@@ -783,13 +731,13 @@ export declare class WebGPUEngine extends Engine {
      * @param reopenPass true to reopen at the end of the function the pass that was active when entering the function
      */
     flushFramebuffer(reopenPass?: boolean): void;
-    /** @hidden */
+    /** @internal */
     _currentFrameBufferIsDefaultFrameBuffer(): boolean;
     private _startRenderTargetRenderPass;
-    /** @hidden */
+    /** @internal */
     _endRenderTargetRenderPass(): void;
     private _getCurrentRenderPass;
-    /** @hidden */
+    /** @internal */
     _getCurrentRenderPassIndex(): number;
     private _startMainRenderPass;
     private _endMainRenderPass;
@@ -816,13 +764,11 @@ export declare class WebGPUEngine extends Engine {
      */
     restoreDefaultFramebuffer(): void;
     /**
-     * @param wrapper
-     * @hidden
+     * @internal
      */
     _setColorFormat(wrapper: WebGPURenderPassWrapper): void;
     /**
-     * @param wrapper
-     * @hidden
+     * @internal
      */
     _setDepthTextureFormat(wrapper: WebGPURenderPassWrapper): void;
     setDitheringState(): void;
@@ -883,11 +829,11 @@ export declare class WebGPUEngine extends Engine {
      */
     getError(): number;
     /**
-     * @hidden
+     * @internal
      */
     bindSamplers(): void;
     /**
-     * @hidden
+     * @internal
      */
     _bindTextureDirectly(): boolean;
     /**
@@ -896,94 +842,92 @@ export declare class WebGPUEngine extends Engine {
      */
     areAllEffectsReady(): boolean;
     /**
-     * @param pipelineContext
-     * @param action
-     * @hidden
+     * @internal
      */
     _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
     /**
-     * @hidden
+     * @internal
      */
     _isRenderingStateCompiled(): boolean;
-    /** @hidden */
+    /** @internal */
     _getUnpackAlignement(): number;
     /**
-     * @hidden
+     * @internal
      */
     _unpackFlipY(): void;
     /**
-     * @hidden
+     * @internal
      */
     _bindUnboundFramebuffer(): void;
     /**
-     * @hidden
+     * @internal
      */
     _getSamplingParameters(): {
         min: number;
         mag: number;
     };
     /**
-     * @hidden
+     * @internal
      */
     getUniforms(): Nullable<WebGLUniformLocation>[];
     /**
-     * @hidden
+     * @internal
      */
     setIntArray(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setIntArray2(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setIntArray3(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setIntArray4(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setArray(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setArray2(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setArray3(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setArray4(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setMatrices(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setMatrix3x3(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setMatrix2x2(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setFloat(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setFloat2(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setFloat3(): boolean;
     /**
-     * @hidden
+     * @internal
      */
     setFloat4(): boolean;
 }