@galacean/engine-rhi-webgl 0.9.0 → 1.0.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-rhi-webgl",
-  "version": "0.9.0",
+  "version": "1.0.0-beta.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,11 +15,11 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-core": "0.9.0",
-    "@galacean/engine-math": "0.9.0"
+    "@galacean/engine-core": "1.0.0-beta.0",
+    "@galacean/engine-math": "1.0.0-beta.0"
   },
   "devDependencies": {
-    "@galacean/engine-design": "0.9.0"
+    "@galacean/engine-design": "1.0.0-beta.0"
   },
   "scripts": {
     "b:types": "tsc"

package/types/GLBuffer.d.ts

@@ -0,0 +1,16 @@
+import { BufferBindFlag, BufferUsage, IPlatformBuffer, SetDataOptions } from "@galacean/engine-core";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
+export declare class GLBuffer implements IPlatformBuffer {
+    private _gl;
+    private _glBindTarget;
+    private _glBufferUsage;
+    private _glBuffer;
+    private _isWebGL2;
+    constructor(rhi: WebGLGraphicDevice, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, data?: ArrayBuffer | ArrayBufferView);
+    bind(): void;
+    setData(byteLength: number, data: ArrayBuffer | ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number, options?: SetDataOptions): void;
+    getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void;
+    resize(byteLength: number): void;
+    destroy(): void;
+    private _getGLBufferUsage;
+}

package/types/GLCapability.d.ts

@@ -1,6 +1,6 @@
 import { GLCapabilityType } from "@galacean/engine-core";
 import { GLCompressedTextureInternalFormat } from "./type";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * GL capability.
  */
@@ -8,7 +8,7 @@ export declare class GLCapability {
     private _maxDrawBuffers;
     private _maxAnisoLevel;
     private _maxAntiAliasing;
-    _rhi: WebGLRenderer;
+    _rhi: WebGLGraphicDevice;
     capabilityList: Map<GLCapabilityType, boolean>;
     get maxTextureSize(): boolean;
     get canUseFloatTextureBlendShape(): boolean;
@@ -25,8 +25,8 @@ export declare class GLCapability {
      * Max MSAA count.
      */
     get maxAntiAliasing(): number;
-    get rhi(): WebGLRenderer;
-    constructor(rhi: WebGLRenderer);
+    get rhi(): WebGLGraphicDevice;
+    constructor(rhi: WebGLGraphicDevice);
     /**
      * Check device capabilities.
      */

package/types/GLExtensions.d.ts

@@ -1,4 +1,4 @@
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 import { GLCapabilityType } from "@galacean/engine-core";
 /**
  * GLContext extension.
@@ -6,7 +6,7 @@ import { GLCapabilityType } from "@galacean/engine-core";
 export declare class GLExtensions {
     private rhi;
     private _requireResult;
-    constructor(rhi: WebGLRenderer);
+    constructor(rhi: WebGLGraphicDevice);
     /**
      * Require an extension.
      */

package/types/GLRenderTarget.d.ts

@@ -1,5 +1,5 @@
 import { IPlatformRenderTarget, RenderTarget, TextureCubeFace } from "@galacean/engine-core";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * The render target in WebGL platform is used for off-screen rendering.
  */
@@ -18,7 +18,7 @@ export declare class GLRenderTarget implements IPlatformRenderTarget {
     /**
      * Create render target in WebGL platform.
      */
-    constructor(rhi: WebGLRenderer, target: RenderTarget);
+    constructor(rhi: WebGLGraphicDevice, target: RenderTarget);
     /**
      * Set which face and mipLevel of the cube texture to render to.
      * @param faceIndex - Cube texture face

package/types/GLTexture.d.ts

@@ -1,5 +1,5 @@
 import { IPlatformTexture, Texture, TextureCubeFace, TextureDepthCompareFunction, TextureFilterMode, TextureWrapMode } from "@galacean/engine-core";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * Texture in WebGL platform.
  */
@@ -24,7 +24,7 @@ export declare class GLTexture implements IPlatformTexture {
     /**
      * Create texture in WebGL platform.
      */
-    constructor(rhi: WebGLRenderer, texture: Texture, target: GLenum);
+    constructor(rhi: WebGLGraphicDevice, texture: Texture, target: GLenum);
     /**
      * Destroy texture.
      */

package/types/GLTexture2D.d.ts

@@ -1,13 +1,13 @@
 import { IPlatformTexture2D, Texture2D } from "@galacean/engine-core";
 import { GLTexture } from "./GLTexture";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * Texture 2d in WebGL platform.
  */
 export declare class GLTexture2D extends GLTexture implements IPlatformTexture2D {
     /** Backward compatible with WebGL1.0. */
     private _compressedMipFilled;
-    constructor(rhi: WebGLRenderer, texture2D: Texture2D);
+    constructor(rhi: WebGLGraphicDevice, texture2D: Texture2D);
     /**
      * {@inheritDoc IPlatformTexture2D.setPixelBuffer}
      */

package/types/GLTexture2DArray.d.ts

@@ -1,11 +1,11 @@
 import { IPlatformTexture2DArray, Texture2DArray } from "@galacean/engine-core";
 import { GLTexture } from "./GLTexture";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * Texture 2D array in WebGL platform.
  */
 export declare class GLTexture2DArray extends GLTexture implements IPlatformTexture2DArray {
-    constructor(rhi: WebGLRenderer, texture2DArray: Texture2DArray);
+    constructor(rhi: WebGLGraphicDevice, texture2DArray: Texture2DArray);
     /**
      * {@inheritDoc IPlatformTexture2DArray.setPixelBuffer}
      */

package/types/GLTextureCube.d.ts

@@ -1,13 +1,13 @@
 import { IPlatformTextureCube, TextureCube, TextureCubeFace } from "@galacean/engine-core";
 import { GLTexture } from "./GLTexture";
-import { WebGLRenderer } from "./WebGLRenderer";
+import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
 /**
  * Cube texture in WebGL platform.
  */
 export declare class GLTextureCube extends GLTexture implements IPlatformTextureCube {
     /** Backward compatible with WebGL1.0. */
     private _compressedFaceFilled;
-    constructor(rhi: WebGLRenderer, textureCube: TextureCube);
+    constructor(rhi: WebGLGraphicDevice, textureCube: TextureCube);
     /**
      * {@inheritDoc IPlatformTextureCube.setPixelBuffer}
      */

package/types/WebGLEngine.d.ts

@@ -1,20 +1,27 @@
-import { Engine } from "@galacean/engine-core";
+import { Engine, EngineConfiguration } from "@galacean/engine-core";
 import { WebCanvas } from "./WebCanvas";
-import { WebGLRendererOptions } from "./WebGLRenderer";
-type OffscreenCanvas = any;
+import { WebGLGraphicDeviceOptions } from "./";
 /**
  * WebGL platform engine,support includes WebGL1.0 and WebGL2.0.
  */
 export declare class WebGLEngine extends Engine {
     /**
-     * Create an engine suitable for the WebGL platform.
-     * @param canvas - Native web canvas
-     * @param webGLRendererOptions - WebGL renderer options
+     * Create a WebGL engine.
+     * @param configuration - WebGL engine configuration
+     * @returns A promise that will resolve when the engine is created
      */
-    constructor(canvas: string | HTMLCanvasElement | OffscreenCanvas, webGLRendererOptions?: WebGLRendererOptions);
+    static create(configuration: WebGLEngineConfiguration): Promise<WebGLEngine>;
     /**
      * Web canvas.
      */
     get canvas(): WebCanvas;
 }
-export {};
+/**
+ * WebGL engine configuration.
+ */
+export interface WebGLEngineConfiguration extends EngineConfiguration {
+    /** Canvas element or canvas id. */
+    canvas: HTMLCanvasElement | string;
+    /** Graphic device options. */
+    graphicDeviceOptions?: WebGLGraphicDeviceOptions;
+}

package/types/{WebGLRenderer.d.ts → WebGLGraphicDevice.d.ts}

@@ -1,4 +1,4 @@
-import { CameraClearFlags, Canvas, Engine, GLCapabilityType, IHardwareRenderer, IPlatformRenderTarget, IPlatformTexture2D, IPlatformTextureCube, Mesh, RenderTarget, SubMesh, Texture2D, Texture2DArray, TextureCube } from "@galacean/engine-core";
+import { BufferBindFlag, BufferUsage, CameraClearFlags, Canvas, Engine, GLCapabilityType, IHardwareRenderer, IPlatformBuffer, IPlatformRenderTarget, IPlatformTexture2D, IPlatformTextureCube, Mesh, RenderTarget, SubMesh, Texture2D, Texture2DArray, TextureCube } from "@galacean/engine-core";
 import { IPlatformPrimitive } from "@galacean/engine-design";
 import { Color, Vector4 } from "@galacean/engine-math";
 import { GLCapability } from "./GLCapability";
@@ -18,17 +18,16 @@ export declare enum WebGLMode {
     WebGL1 = 2
 }
 /**
- * WebGL renderer options.
+ * WebGL graphic device options.
  */
-export interface WebGLRendererOptions extends WebGLContextAttributes {
+export interface WebGLGraphicDeviceOptions extends WebGLContextAttributes {
     /** WebGL mode.*/
     webGLMode?: WebGLMode;
 }
 /**
- * WebGL renderer, including WebGL1.0 and WebGL2.0.
+ * WebGL graphic device, including WebGL1.0 and WebGL2.0.
  */
-export declare class WebGLRenderer implements IHardwareRenderer {
-    _currentBind: any;
+export declare class WebGLGraphicDevice implements IHardwareRenderer {
     private _options;
     private _gl;
     private _renderStates;
@@ -43,6 +42,8 @@ export declare class WebGLRenderer implements IHardwareRenderer {
     private _lastScissor;
     private _lastClearColor;
     private _scissorEnable;
+    private _onDeviceLost;
+    private _onDeviceRestored;
     get isWebGL2(): boolean;
     get renderer(): string;
     /**
@@ -53,19 +54,20 @@ export declare class WebGLRenderer implements IHardwareRenderer {
     get renderStates(): GLRenderStates;
     get capability(): GLCapability;
     get canIUseMoreJoints(): boolean;
-    constructor(initializeOptions?: WebGLRendererOptions);
-    init(canvas: Canvas): void;
+    constructor(initializeOptions?: WebGLGraphicDeviceOptions);
+    init(canvas: Canvas, onDeviceLost: () => void, onDeviceRestored: () => void): void;
     createPlatformPrimitive(primitive: Mesh): IPlatformPrimitive;
     createPlatformTexture2D(texture2D: Texture2D): IPlatformTexture2D;
     createPlatformTexture2DArray(texture2D: Texture2DArray): GLTexture2DArray;
     createPlatformTextureCube(textureCube: TextureCube): IPlatformTextureCube;
     createPlatformRenderTarget(target: RenderTarget): IPlatformRenderTarget;
+    createPlatformBuffer(type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, data?: ArrayBuffer | ArrayBufferView): IPlatformBuffer;
     requireExtension(ext: any): any;
     canIUse(capabilityType: GLCapabilityType): boolean;
     canIUseCompressedTextureInternalFormat(type: number): boolean;
     viewport(x: number, y: number, width: number, height: number): void;
     scissor(x: number, y: number, width: number, height: number): void;
-    colorMask(r: any, g: any, b: any, a: any): void;
+    colorMask(r: boolean, g: boolean, b: boolean, a: boolean): void;
     clearRenderTarget(engine: Engine, clearFlags: CameraClearFlags, clearColor: Color): void;
     drawPrimitive(primitive: Mesh, subPrimitive: SubMesh, shaderProgram: any): void;
     activeRenderTarget(renderTarget: RenderTarget, viewport: Vector4, mipLevel: number): void;
@@ -73,5 +75,12 @@ export declare class WebGLRenderer implements IHardwareRenderer {
     bindTexture(texture: GLTexture): void;
     setGlobalDepthBias(bias: number, slopeBias: number): void;
     flush(): void;
+    forceLoseDevice(): void;
+    forceRestoreDevice(): void;
+    resetState(): void;
+    protected _initGLState(gl: (WebGLRenderingContext & WebGLExtension) | WebGL2RenderingContext): void;
     destroy(): void;
+    private _onContextCreationError;
+    private _onWebGLContextLost;
+    private _onWebGLContextRestored;
 }

package/types/index.d.ts

@@ -1,5 +1,6 @@
 export { GLCompressedTextureInternalFormat } from "./type";
 export { WebCanvas } from "./WebCanvas";
 export { WebGLEngine } from "./WebGLEngine";
-export { WebGLMode, WebGLRenderer } from "./WebGLRenderer";
-export type { WebGLRendererOptions } from "./WebGLRenderer";
+export type { WebGLEngineConfiguration } from "./WebGLEngine";
+export { WebGLMode, WebGLGraphicDevice } from "./WebGLGraphicDevice";
+export type { WebGLGraphicDeviceOptions } from "./WebGLGraphicDevice";