rhodonite 0.4.2 → 0.5.2

package/dist/esm/webgl/WebGLResourceRepository.d.ts

@@ -1,221 +1,351 @@
-/// <reference types="webgl-ext" />
-import Accessor from '../foundation/memory/Accessor';
-import CGAPIResourceRepository from '../foundation/renderer/CGAPIResourceRepository';
-import Primitive from '../foundation/geometry/Primitive';
-import { AttributeNames } from './shaders/GLSLShader';
-import { VertexAttributeEnum } from '../foundation/definitions/VertexAttribute';
-import { TextureParameterEnum } from '../foundation/definitions/TextureParameter';
-import { PixelFormatEnum } from '../foundation/definitions/PixelFormat';
-import { ComponentTypeEnum } from '../foundation/definitions/ComponentType';
-import WebGLContextWrapper from './WebGLContextWrapper';
-import { ShaderSemanticsInfo } from '../foundation/definitions/ShaderSemantics';
-import IRenderable from '../foundation/textures/IRenderable';
-import FrameBuffer from '../foundation/renderer/FrameBuffer';
-import { HdriFormatEnum } from '../foundation/definitions/HdriFormat';
-import Vector4 from '../foundation/math/Vector4';
-import RenderPass from '../foundation/renderer/RenderPass';
-import { WebGLResourceHandle, TypedArray, Index, Size, Count, CGAPIResourceHandle, Byte, ArrayType } from '../types/CommonTypes';
-import { BasisFile } from '../types/BasisTexture';
-import { CompressionTextureTypeEnum } from '../foundation/definitions/CompressionTextureType';
-export declare type VertexHandles = {
-    vaoHandle: CGAPIResourceHandle;
-    iboHandle?: CGAPIResourceHandle;
-    vboHandles: Array<CGAPIResourceHandle>;
-    attributesFlags: Array<boolean>;
-    setComplete: boolean;
-};
-declare type DirectTextureData = TypedArray | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement;
-export declare type TextureData = {
-    level: Count;
-    width: Count;
-    height: Count;
-    buffer: ArrayBufferView;
-};
-export declare type WebGLResource = WebGLBuffer | WebGLFramebuffer | WebGLObject | WebGLProgram | WebGLRenderbuffer | WebGLTexture | WebGLTransformFeedback;
-export default class WebGLResourceRepository extends CGAPIResourceRepository {
-    private static __instance;
-    private __webglContexts;
-    private __glw?;
-    private __resourceCounter;
-    private __webglResources;
-    private constructor();
-    static getInstance(): WebGLResourceRepository;
-    addWebGLContext(gl: WebGLRenderingContext | WebGL2RenderingContext, canvas: HTMLCanvasElement, asCurrent: boolean, isDebug: boolean): void;
-    generateWebGLContext(canvas: HTMLCanvasElement, webglOption: WebGLContextAttributes, version: number, asCurrent: boolean, isDebug: boolean, fallback?: boolean): WebGLRenderingContext | WebGL2RenderingContext | undefined;
-    get currentWebGLContextWrapper(): WebGLContextWrapper | undefined;
-    private getResourceNumber;
-    getWebGLResource(WebGLResourceHandle: WebGLResourceHandle): WebGLResource | null;
-    createIndexBuffer(accessor: Accessor): number;
-    updateIndexBuffer(accessor: Accessor, resourceHandle: number): void;
-    createVertexBuffer(accessor: Accessor): number;
-    createVertexBufferFromTypedArray(typedArray: TypedArray): number;
-    updateVertexBuffer(accessor: Accessor, resourceHandle: number): void;
-    createVertexArray(): number | undefined;
-    bindTexture2D(textureSlotIndex: Index, textureUid: CGAPIResourceHandle): void;
-    bindTextureCube(textureSlotIndex: Index, textureUid: CGAPIResourceHandle): void;
-    createVertexBufferAndIndexBuffer(primitive: Primitive): VertexHandles;
-    updateVertexBufferAndIndexBuffer(primitive: Primitive, vertexHandles: VertexHandles): void;
-    createShaderProgram({ materialTypeName, vertexShaderStr, fragmentShaderStr, attributeNames, attributeSemantics, }: {
-        materialTypeName: string;
-        vertexShaderStr: string;
-        fragmentShaderStr: string;
-        attributeNames: AttributeNames;
-        attributeSemantics: Array<VertexAttributeEnum>;
-    }): number;
-    private __checkShaderCompileStatus;
-    private __checkShaderProgramLinkStatus;
-    setupUniformLocations(shaderProgramUid: WebGLResourceHandle, infoArray: ShaderSemanticsInfo[], isUniformOnlyMode: boolean): WebGLProgram;
-    private __isUniformValueDirty;
-    setUniformValue(shaderProgram: WebGLProgram, semanticStr: string, firstTime: boolean, value: any, index?: Index): boolean;
-    bindTexture(info: any, value: any): void;
-    setUniformValueInner(shaderProgram: WebGLProgram, semanticStr: string, info: ShaderSemanticsInfo, isMatrix: boolean, componentNumber: number, isVector: boolean, { x, y, z, w, }: {
-        x: number | ArrayType | boolean;
-        y?: number | boolean;
-        z?: number | boolean;
-        w?: number | boolean;
-    }, { firstTime, delta }: {
-        firstTime?: boolean;
-        delta?: number;
-    }, index?: Count): boolean;
-    setVertexDataToPipeline({ vaoHandle, iboHandle, vboHandles, }: {
-        vaoHandle: WebGLResourceHandle;
-        iboHandle?: WebGLResourceHandle;
-        vboHandles: Array<WebGLResourceHandle>;
-    }, primitive: Primitive, instanceIDBufferUid?: WebGLResourceHandle): void;
-    createTexture(data: DirectTextureData, { level, internalFormat, width, height, border, format, type, magFilter, minFilter, wrapS, wrapT, generateMipmap, anisotropy, isPremultipliedAlpha, }: {
-        level: Index;
-        internalFormat: TextureParameterEnum | PixelFormatEnum;
-        width: Size;
-        height: Size;
-        border: Size;
-        format: PixelFormatEnum;
-        type: ComponentTypeEnum;
-        magFilter: TextureParameterEnum;
-        minFilter: TextureParameterEnum;
-        wrapS: TextureParameterEnum;
-        wrapT: TextureParameterEnum;
-        generateMipmap: boolean;
-        anisotropy: boolean;
-        isPremultipliedAlpha: boolean;
-    }): WebGLResourceHandle;
-    /**
-     * Create and bind compressed texture object
-     * @param textureDataArray transcoded texture data for each mipmaps(levels)
-     * @param compressionTextureType
-     */
-    createCompressedTexture(textureDataArray: TextureData[], compressionTextureType: CompressionTextureTypeEnum, { magFilter, minFilter, wrapS, wrapT, anisotropy, }: {
-        magFilter: TextureParameterEnum;
-        minFilter: TextureParameterEnum;
-        wrapS: TextureParameterEnum;
-        wrapT: TextureParameterEnum;
-        anisotropy: boolean;
-    }): WebGLResourceHandle;
-    createCompressedTextureFromBasis(basisFile: BasisFile, { border, format, type, magFilter, minFilter, wrapS, wrapT, anisotropy, isPremultipliedAlpha, }: {
-        border: Size;
-        format: PixelFormatEnum;
-        type: ComponentTypeEnum;
-        magFilter: TextureParameterEnum;
-        minFilter: TextureParameterEnum;
-        wrapS: TextureParameterEnum;
-        wrapT: TextureParameterEnum;
-        anisotropy: boolean;
-        isPremultipliedAlpha: boolean;
-    }): WebGLResourceHandle;
-    private decodeBasisImage;
-    createFrameBufferObject(): number;
-    attachColorBufferToFrameBufferObject(framebuffer: FrameBuffer, index: Index, renderable: IRenderable): void;
-    attachDepthBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
-    attachStencilBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
-    attachDepthStencilBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
-    private __attachDepthOrStencilBufferToFrameBufferObject;
-    createRenderBuffer(width: Size, height: Size, internalFormat: TextureParameterEnum, isMSAA: boolean, sampleCountMSAA: Count): number;
-    setDrawTargets(framebuffer?: FrameBuffer): void;
-    bindFramebuffer(framebuffer?: FrameBuffer): void;
-    unbindFramebuffer(): void;
-    createRenderTargetTexture({ width, height, level, internalFormat, format, type, magFilter, minFilter, wrapS, wrapT, }: {
-        width: Size;
-        height: Size;
-        level: Index;
-        internalFormat: TextureParameterEnum | PixelFormatEnum;
-        format: PixelFormatEnum;
-        type: ComponentTypeEnum;
-        magFilter: TextureParameterEnum;
-        minFilter: TextureParameterEnum;
-        wrapS: TextureParameterEnum;
-        wrapT: TextureParameterEnum;
-    }): number;
-    createCubeTexture(mipLevelCount: Count, images: Array<{
-        posX: DirectTextureData;
-        negX: DirectTextureData;
-        posY: DirectTextureData;
-        negY: DirectTextureData;
-        posZ: DirectTextureData;
-        negZ: DirectTextureData;
-    }>, width: Size, height: Size): number;
-    /**
-     * Create Cube Texture from image files.
-     * @param baseUri the base uri to load images;
-     * @param mipLevelCount the number of mip levels (include root level). if no mipmap, the value should be 1;
-     * @returns the WebGLResourceHandle for the generated Cube Texture
-     */
-    createCubeTextureFromFiles(baseUri: string, mipLevelCount: Count, isNamePosNeg: boolean, hdriFormat: HdriFormatEnum): Promise<number>;
-    createCubeTextureFromBasis(basisFile: BasisFile, { magFilter, minFilter, wrapS, wrapT, border, }: {
-        magFilter?: import("../foundation/misc/EnumIO").EnumIO | undefined;
-        minFilter?: import("../foundation/misc/EnumIO").EnumIO | undefined;
-        wrapS?: import("../foundation/misc/EnumIO").EnumIO | undefined;
-        wrapT?: import("../foundation/misc/EnumIO").EnumIO | undefined;
-        border?: number | undefined;
-    }): number;
-    createDummyBlackCubeTexture(): number;
-    createDummyCubeTexture(rgbaStr?: string): number;
-    setWebGLTextureDirectly(webGLTexture: WebGLTexture): number;
-    createTextureFromDataUri(dataUri: string, { level, internalFormat, border, format, type, magFilter, minFilter, wrapS, wrapT, generateMipmap, anisotropy, isPremultipliedAlpha, }: {
-        level: Index;
-        internalFormat: TextureParameterEnum | PixelFormatEnum;
-        border: Size;
-        format: PixelFormatEnum;
-        type: ComponentTypeEnum;
-        magFilter: TextureParameterEnum;
-        minFilter: TextureParameterEnum;
-        wrapS: TextureParameterEnum;
-        wrapT: TextureParameterEnum;
-        generateMipmap: boolean;
-        anisotropy: boolean;
-        isPremultipliedAlpha: boolean;
-    }): Promise<WebGLResourceHandle>;
-    updateTexture(textureUid: WebGLResourceHandle, textureData: DirectTextureData, { level, xoffset, yoffset, width, height, format, type, }: {
-        level: Index;
-        xoffset: Size;
-        yoffset: Size;
-        width: Size;
-        height: Size;
-        format: PixelFormatEnum;
-        type: ComponentTypeEnum;
-    }): void;
-    deleteFrameBufferObject(frameBufferObjectHandle: WebGLResourceHandle): void;
-    deleteRenderBuffer(renderBufferUid: WebGLResourceHandle): void;
-    deleteTexture(textureHandle: WebGLResourceHandle): void;
-    createDummyTexture(rgbaStr?: string): number;
-    createDummyBlackTexture(): number;
-    createDummyWhiteTexture(): number;
-    createDummyNormalTexture(): number;
-    __createDummyTextureInner(base64: string): number;
-    createUniformBuffer(bufferView: TypedArray | DataView): number;
-    updateUniformBuffer(uboUid: WebGLResourceHandle, typedArray: TypedArray, offsetByte: Byte, byteLength: Byte): void;
-    bindUniformBlock(shaderProgramUid: WebGLResourceHandle, blockName: string, blockIndex: Index): void;
-    bindUniformBufferBase(blockIndex: Index, uboUid: WebGLResourceHandle): void;
-    deleteUniformBuffer(uboUid: WebGLResourceHandle): void;
-    setupUniformBufferDataArea(typedArray?: TypedArray): number;
-    getGlslDataUBODefinitionString(): string;
-    getGlslDataUBOVec4SizeString(): string;
-    createTransformFeedback(): number;
-    deleteTransformFeedback(transformFeedbackUid: WebGLResourceHandle): void;
-    setViewport(viewport?: Vector4): void;
-    clearFrameBuffer(renderPass: RenderPass): void;
-    deleteVertexDataResources(vertexHandles: VertexHandles): void;
-    deleteVertexArray(vaoHandle: WebGLResourceHandle): void;
-    deleteVertexBuffer(vboUid: WebGLResourceHandle): void;
-    resizeCanvas(width: Size, height: Size): void;
-    switchDepthTest(flag: boolean): void;
-}
-export {};
+/// <reference types="webgl-ext" />
+import Accessor from '../foundation/memory/Accessor';
+import CGAPIResourceRepository from '../foundation/renderer/CGAPIResourceRepository';
+import Primitive from '../foundation/geometry/Primitive';
+import { AttributeNames } from './shaders/GLSLShader';
+import { VertexAttributeEnum } from '../foundation/definitions/VertexAttribute';
+import { TextureParameterEnum } from '../foundation/definitions/TextureParameter';
+import { PixelFormatEnum } from '../foundation/definitions/PixelFormat';
+import { ComponentTypeEnum } from '../foundation/definitions/ComponentType';
+import WebGLContextWrapper from './WebGLContextWrapper';
+import { ShaderSemanticsInfo } from '../foundation/definitions/ShaderSemantics';
+import IRenderable from '../foundation/textures/IRenderable';
+import FrameBuffer from '../foundation/renderer/FrameBuffer';
+import { HdriFormatEnum } from '../foundation/definitions/HdriFormat';
+import Vector4 from '../foundation/math/Vector4';
+import RenderPass from '../foundation/renderer/RenderPass';
+import { WebGLResourceHandle, TypedArray, Index, Size, Count, CGAPIResourceHandle, Byte, ArrayType } from '../types/CommonTypes';
+import { BasisFile } from '../types/BasisTexture';
+import { RnWebGLProgram } from './WebGLExtendedTypes';
+import { CompressionTextureTypeEnum } from '../foundation/definitions/CompressionTextureType';
+import Material from '../foundation/materials/core/Material';
+export declare type VertexHandles = {
+    vaoHandle: CGAPIResourceHandle;
+    iboHandle?: CGAPIResourceHandle;
+    vboHandles: Array<CGAPIResourceHandle>;
+    attributesFlags: Array<boolean>;
+    setComplete: boolean;
+};
+declare type DirectTextureData = TypedArray | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement;
+export declare type TextureData = {
+    level: Count;
+    width: Count;
+    height: Count;
+    buffer: ArrayBufferView;
+};
+export declare type WebGLResource = WebGLBuffer | WebGLFramebuffer | WebGLObject | WebGLProgram | WebGLRenderbuffer | WebGLTexture | WebGLTransformFeedback;
+export default class WebGLResourceRepository extends CGAPIResourceRepository {
+    private static __instance;
+    private __webglContexts;
+    private __glw?;
+    private __resourceCounter;
+    private __webglResources;
+    private constructor();
+    static getInstance(): WebGLResourceRepository;
+    addWebGLContext(gl: WebGLRenderingContext | WebGL2RenderingContext, canvas: HTMLCanvasElement, asCurrent: boolean, isDebug: boolean): void;
+    generateWebGLContext(canvas: HTMLCanvasElement, webglOption: WebGLContextAttributes, version: number, asCurrent: boolean, isDebug: boolean, fallback?: boolean): WebGLRenderingContext | WebGL2RenderingContext;
+    get currentWebGLContextWrapper(): WebGLContextWrapper | undefined;
+    private getResourceNumber;
+    getWebGLResource(WebGLResourceHandle: WebGLResourceHandle): WebGLResource | null;
+    createIndexBuffer(accessor: Accessor): number;
+    updateIndexBuffer(accessor: Accessor, resourceHandle: number): void;
+    createVertexBuffer(accessor: Accessor): number;
+    createVertexBufferFromTypedArray(typedArray: TypedArray): number;
+    updateVertexBuffer(accessor: Accessor, resourceHandle: number): void;
+    createVertexArray(): number | undefined;
+    /**
+     * bind the Texture2D
+     * @param textureSlotIndex
+     * @param textureUid
+     */
+    bindTexture2D(textureSlotIndex: Index, textureUid: CGAPIResourceHandle): void;
+    /**
+     * bind the TextureCube
+     * @param textureSlotIndex
+     * @param textureUid
+     */
+    bindTextureCube(textureSlotIndex: Index, textureUid: CGAPIResourceHandle): void;
+    /**
+     * create a VertexBuffer and IndexBuffer
+     * @param primitive
+     * @returns
+     */
+    createVertexBufferAndIndexBuffer(primitive: Primitive): VertexHandles;
+    /**
+     * update the VertexBuffer and IndexBuffer
+     * @param primitive
+     * @param vertexHandles
+     */
+    updateVertexBufferAndIndexBuffer(primitive: Primitive, vertexHandles: VertexHandles): void;
+    /**
+     * create a shader program
+     * @param param0
+     * @returns
+     */
+    createShaderProgram({ material, vertexShaderStr, fragmentShaderStr, attributeNames, attributeSemantics, }: {
+        material: Material;
+        vertexShaderStr: string;
+        fragmentShaderStr: string;
+        attributeNames: AttributeNames;
+        attributeSemantics: Array<VertexAttributeEnum>;
+    }): number;
+    private __checkShaderCompileStatus;
+    private __checkShaderProgramLinkStatus;
+    /**
+     * setup the uniform locations
+     * @param shaderProgramUid
+     * @param infoArray
+     * @param isUniformOnlyMode
+     * @returns
+     */
+    setupUniformLocations(shaderProgramUid: WebGLResourceHandle, infoArray: ShaderSemanticsInfo[], isUniformOnlyMode: boolean): WebGLProgram;
+    setupBasicUniformLocations(shaderProgramUid: WebGLResourceHandle): void;
+    /**
+     * set an uniform value
+     */
+    setUniformValue(shaderProgram_: WebGLProgram, semanticStr: string, firstTime: boolean, value: any, index?: Index): boolean;
+    /**
+     * bind the texture
+     * @param info
+     * @param value
+     */
+    bindTexture(info: ShaderSemanticsInfo, value: any): void;
+    /**
+     * set the uniform value
+     * @param shaderProgram
+     * @param semanticStr
+     * @param info
+     * @param isMatrix
+     * @param componentNumber
+     * @param isVector
+     * @param param6
+     * @param index
+     * @returns
+     */
+    setUniformValueInner(shaderProgram: WebGLProgram, semanticStr: string, info: ShaderSemanticsInfo, isMatrix: boolean, componentNumber: number, isVector: boolean, { x, y, z, w, }: {
+        x: number | ArrayType | boolean;
+        y?: number | boolean;
+        z?: number | boolean;
+        w?: number | boolean;
+    }, index?: Count): boolean;
+    /**
+     * set the VertexData to the Pipeline
+     */
+    setVertexDataToPipeline({ vaoHandle, iboHandle, vboHandles, }: {
+        vaoHandle: WebGLResourceHandle;
+        iboHandle?: WebGLResourceHandle;
+        vboHandles: Array<WebGLResourceHandle>;
+    }, primitive: Primitive, instanceIDBufferUid?: WebGLResourceHandle): void;
+    /**
+     * create a Texture
+     * @param data
+     * @param param1
+     * @returns
+     */
+    createTexture(data: DirectTextureData, { level, internalFormat, width, height, border, format, type, magFilter, minFilter, wrapS, wrapT, generateMipmap, anisotropy, isPremultipliedAlpha, }: {
+        level: Index;
+        internalFormat: TextureParameterEnum | PixelFormatEnum;
+        width: Size;
+        height: Size;
+        border: Size;
+        format: PixelFormatEnum;
+        type: ComponentTypeEnum;
+        magFilter: TextureParameterEnum;
+        minFilter: TextureParameterEnum;
+        wrapS: TextureParameterEnum;
+        wrapT: TextureParameterEnum;
+        generateMipmap: boolean;
+        anisotropy: boolean;
+        isPremultipliedAlpha: boolean;
+    }): WebGLResourceHandle;
+    /**
+     * Create and bind compressed texture object
+     * @param textureDataArray transcoded texture data for each mipmaps(levels)
+     * @param compressionTextureType
+     */
+    createCompressedTexture(textureDataArray: TextureData[], compressionTextureType: CompressionTextureTypeEnum, { magFilter, minFilter, wrapS, wrapT, anisotropy, }: {
+        magFilter: TextureParameterEnum;
+        minFilter: TextureParameterEnum;
+        wrapS: TextureParameterEnum;
+        wrapT: TextureParameterEnum;
+        anisotropy: boolean;
+    }): WebGLResourceHandle;
+    /**
+     * create CompressedTextureFromBasis
+     * @param basisFile
+     * @param param1
+     * @returns
+     */
+    createCompressedTextureFromBasis(basisFile: BasisFile, { border, format, type, magFilter, minFilter, wrapS, wrapT, anisotropy, isPremultipliedAlpha, }: {
+        border: Size;
+        format: PixelFormatEnum;
+        type: ComponentTypeEnum;
+        magFilter: TextureParameterEnum;
+        minFilter: TextureParameterEnum;
+        wrapS: TextureParameterEnum;
+        wrapT: TextureParameterEnum;
+        anisotropy: boolean;
+        isPremultipliedAlpha: boolean;
+    }): WebGLResourceHandle;
+    /**
+     * decode the BasisImage
+     * @param basisFile
+     * @param basisCompressionType
+     * @param imageIndex
+     * @param levelIndex
+     * @returns
+     */
+    private decodeBasisImage;
+    /**
+     * create a FrameBufferObject
+     * @returns
+     */
+    createFrameBufferObject(): number;
+    /**
+     * attach the ColorBuffer to the FrameBufferObject
+     * @param framebuffer a Framebuffer
+     * @param renderable a ColorBuffer
+     */
+    attachColorBufferToFrameBufferObject(framebuffer: FrameBuffer, index: Index, renderable: IRenderable): void;
+    /**
+     * attach the DepthBuffer to the FrameBufferObject
+     * @param framebuffer a Framebuffer
+     * @param renderable a DepthBuffer
+     */
+    attachDepthBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
+    /**
+     * attach the StencilBuffer to the FrameBufferObject
+     * @param framebuffer a Framebuffer
+     * @param renderable a StencilBuffer
+     */
+    attachStencilBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
+    /**
+     * attach the depthStencilBuffer to the FrameBufferObject
+     * @param framebuffer a Framebuffer
+     * @param renderable a depthStencilBuffer
+     */
+    attachDepthStencilBufferToFrameBufferObject(framebuffer: FrameBuffer, renderable: IRenderable): void;
+    private __attachDepthOrStencilBufferToFrameBufferObject;
+    /**
+     * create Renderbuffer
+     */
+    createRenderBuffer(width: Size, height: Size, internalFormat: TextureParameterEnum, isMSAA: boolean, sampleCountMSAA: Count): number;
+    /**
+     * set drawTargets
+     * @param framebuffer
+     */
+    setDrawTargets(framebuffer?: FrameBuffer): void;
+    /**
+     * bind Framebuffer
+     * @param framebuffer
+     */
+    bindFramebuffer(framebuffer?: FrameBuffer): void;
+    /**
+     * unbind Framebuffer
+     */
+    unbindFramebuffer(): void;
+    /**
+     * create a RenderTargetTexture
+     * @param param0
+     * @returns
+     */
+    createRenderTargetTexture({ width, height, level, internalFormat, format, type, magFilter, minFilter, wrapS, wrapT, }: {
+        width: Size;
+        height: Size;
+        level: Index;
+        internalFormat: TextureParameterEnum | PixelFormatEnum;
+        format: PixelFormatEnum;
+        type: ComponentTypeEnum;
+        magFilter: TextureParameterEnum;
+        minFilter: TextureParameterEnum;
+        wrapS: TextureParameterEnum;
+        wrapT: TextureParameterEnum;
+    }): number;
+    /**
+     * create a CubeTexture
+     *
+     * @param mipLevelCount
+     * @param images
+     * @param width
+     * @param height
+     * @returns resource handle
+     */
+    createCubeTexture(mipLevelCount: Count, images: Array<{
+        posX: DirectTextureData;
+        negX: DirectTextureData;
+        posY: DirectTextureData;
+        negY: DirectTextureData;
+        posZ: DirectTextureData;
+        negZ: DirectTextureData;
+    }>, width: Size, height: Size): number;
+    /**
+     * Create Cube Texture from image files.
+     * @param baseUri the base uri to load images;
+     * @param mipLevelCount the number of mip levels (include root level). if no mipmap, the value should be 1;
+     * @returns the WebGLResourceHandle for the generated Cube Texture
+     */
+    createCubeTextureFromFiles(baseUri: string, mipLevelCount: Count, isNamePosNeg: boolean, hdriFormat: HdriFormatEnum): Promise<number>;
+    createCubeTextureFromBasis(basisFile: BasisFile, { magFilter, minFilter, wrapS, wrapT, border, }: {
+        magFilter?: import("../foundation/misc/EnumIO").EnumIO | undefined;
+        minFilter?: import("../foundation/misc/EnumIO").EnumIO | undefined;
+        wrapS?: import("../foundation/misc/EnumIO").EnumIO | undefined;
+        wrapT?: import("../foundation/misc/EnumIO").EnumIO | undefined;
+        border?: number | undefined;
+    }): number;
+    createDummyBlackCubeTexture(): number;
+    createDummyCubeTexture(rgbaStr?: string): number;
+    setWebGLTextureDirectly(webGLTexture: WebGLTexture): number;
+    createTextureFromDataUri(dataUri: string, { level, internalFormat, border, format, type, magFilter, minFilter, wrapS, wrapT, generateMipmap, anisotropy, isPremultipliedAlpha, }: {
+        level: Index;
+        internalFormat: TextureParameterEnum | PixelFormatEnum;
+        border: Size;
+        format: PixelFormatEnum;
+        type: ComponentTypeEnum;
+        magFilter: TextureParameterEnum;
+        minFilter: TextureParameterEnum;
+        wrapS: TextureParameterEnum;
+        wrapT: TextureParameterEnum;
+        generateMipmap: boolean;
+        anisotropy: boolean;
+        isPremultipliedAlpha: boolean;
+    }): Promise<WebGLResourceHandle>;
+    updateTexture(textureUid: WebGLResourceHandle, textureData: DirectTextureData, { level, xoffset, yoffset, width, height, format, type, }: {
+        level: Index;
+        xoffset: Size;
+        yoffset: Size;
+        width: Size;
+        height: Size;
+        format: PixelFormatEnum;
+        type: ComponentTypeEnum;
+    }): void;
+    deleteFrameBufferObject(frameBufferObjectHandle: WebGLResourceHandle): void;
+    deleteRenderBuffer(renderBufferUid: WebGLResourceHandle): void;
+    deleteTexture(textureHandle: WebGLResourceHandle): void;
+    createDummyTexture(rgbaStr?: string): number;
+    createDummyBlackTexture(): number;
+    createDummyWhiteTexture(): number;
+    createDummyNormalTexture(): number;
+    __createDummyTextureInner(base64: string): number;
+    createUniformBuffer(bufferView: TypedArray | DataView): number;
+    updateUniformBuffer(uboUid: WebGLResourceHandle, typedArray: TypedArray, offsetByte: Byte, byteLength: Byte): void;
+    bindUniformBlock(shaderProgramUid: WebGLResourceHandle, blockName: string, blockIndex: Index): void;
+    bindUniformBufferBase(blockIndex: Index, uboUid: WebGLResourceHandle): void;
+    deleteUniformBuffer(uboUid: WebGLResourceHandle): void;
+    setupUniformBufferDataArea(typedArray?: TypedArray): number;
+    getGlslDataUBODefinitionString(): string;
+    getGlslDataUBOVec4SizeString(): string;
+    createTransformFeedback(): number;
+    deleteTransformFeedback(transformFeedbackUid: WebGLResourceHandle): void;
+    setViewport(viewport?: Vector4): void;
+    clearFrameBuffer(renderPass: RenderPass): void;
+    deleteVertexDataResources(vertexHandles: VertexHandles): void;
+    deleteVertexArray(vaoHandle: WebGLResourceHandle): void;
+    deleteVertexBuffer(vboUid: WebGLResourceHandle): void;
+    resizeCanvas(width: Size, height: Size): void;
+    switchDepthTest(flag: boolean): void;
+    rebuildProgram(this: RnWebGLProgram, updatedVertexSourceCode: string, // The new vertex shader source
+    updatedFragmentSourceCode: string, // The new fragment shader source
+    onCompiled: (program: WebGLProgram) => void, // Callback triggered by your engine when the compilation is successful. It needs to send back the new linked program.
+    onError: (message: string) => void): boolean;
+}
+export {};

package/dist/esm/webgl/WebGLStrategy.d.ts

@@ -1,22 +1,27 @@
-import MeshComponent from '../foundation/components/MeshComponent';
-import WebGLContextWrapper from './WebGLContextWrapper';
-import Primitive from '../foundation/geometry/Primitive';
-import Matrix44 from '../foundation/math/Matrix44';
-import Matrix33 from '../foundation/math/Matrix33';
-import Entity from '../foundation/core/Entity';
-import CubeTexture from '../foundation/textures/CubeTexture';
-import Material from '../foundation/materials/core/Material';
-import RenderPass from '../foundation/renderer/RenderPass';
-import MeshRendererComponent from '../foundation/components/MeshRendererComponent';
-import { WebGLResourceHandle, Index, Count } from '../types/CommonTypes';
-import { IMatrix44 } from '../foundation/math/IMatrix';
-export default interface WebGLStrategy {
-    $load(meshComponent: MeshComponent): void;
-    $prerender(meshComponent: MeshComponent, meshRendererComponent: MeshRendererComponent, instanceIDBufferUid: WebGLResourceHandle): void;
-    $render?(i: Index, meshComponent: MeshComponent, worldMatrix: Matrix44, normalMatrix: Matrix33, entity: Entity, renderPass: RenderPass, renderPassTickCount: Count, diffuseCube?: CubeTexture, specularCube?: CubeTexture): void;
-    common_$prerender(): void;
-    common_$render(meshComponentSids: Int32Array, meshComponents: MeshComponent[], viewMatrix: IMatrix44, projectionMatrix: IMatrix44, renderPass: RenderPass, renderPassTickCount: Count): boolean;
-    attachGPUData(primitive: Primitive): void;
-    attachVertexData(i: number, primitive: Primitive, glw: WebGLContextWrapper, instanceIDBufferUid: WebGLResourceHandle): void;
-    attachShaderProgram(material: Material): void;
-}
+import MeshComponent from '../foundation/components/MeshComponent';
+import WebGLContextWrapper from './WebGLContextWrapper';
+import Primitive from '../foundation/geometry/Primitive';
+import Matrix44 from '../foundation/math/Matrix44';
+import Matrix33 from '../foundation/math/Matrix33';
+import Entity from '../foundation/core/Entity';
+import CubeTexture from '../foundation/textures/CubeTexture';
+import Material from '../foundation/materials/core/Material';
+import RenderPass from '../foundation/renderer/RenderPass';
+import MeshRendererComponent from '../foundation/components/MeshRendererComponent';
+import { WebGLResourceHandle, Index, Count, CGAPIResourceHandle } from '../types/CommonTypes';
+import { IMatrix44 } from '../foundation/math/IMatrix';
+export declare type ShaderSources = {
+    vertex: string;
+    pixel: string;
+};
+export default interface WebGLStrategy {
+    $load(meshComponent: MeshComponent): void;
+    $prerender(meshComponent: MeshComponent, meshRendererComponent: MeshRendererComponent, instanceIDBufferUid: WebGLResourceHandle): void;
+    $render?(i: Index, meshComponent: MeshComponent, worldMatrix: Matrix44, normalMatrix: Matrix33, entity: Entity, renderPass: RenderPass, renderPassTickCount: Count, diffuseCube?: CubeTexture, specularCube?: CubeTexture): void;
+    common_$prerender(): void;
+    common_$render(meshComponentSids: Int32Array, meshComponents: MeshComponent[], viewMatrix: IMatrix44, projectionMatrix: IMatrix44, renderPass: RenderPass, renderPassTickCount: Count): boolean;
+    attachGPUData(primitive: Primitive): void;
+    attachVertexData(i: number, primitive: Primitive, glw: WebGLContextWrapper, instanceIDBufferUid: WebGLResourceHandle): void;
+    attachShaderProgram(material: Material): void;
+    setupShaderForMaterial(material: Material, updatedShaderSources?: ShaderSources): CGAPIResourceHandle;
+}