@galacean/engine-rhi-webgl 2.0.0-alpha.5 → 2.0.0-alpha.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@galacean/engine-rhi-webgl",
3
- "version": "2.0.0-alpha.5",
3
+ "version": "2.0.0-alpha.51",
4
4
  "repository": {
5
5
  "url": "https://github.com/galacean/engine.git"
6
6
  },
@@ -18,11 +18,11 @@
18
18
  "types/**/*"
19
19
  ],
20
20
  "dependencies": {
21
- "@galacean/engine-core": "2.0.0-alpha.5",
22
- "@galacean/engine-math": "2.0.0-alpha.5"
21
+ "@galacean/engine-core": "2.0.0-alpha.51",
22
+ "@galacean/engine-math": "2.0.0-alpha.51"
23
23
  },
24
24
  "devDependencies": {
25
- "@galacean/engine-design": "2.0.0-alpha.5"
25
+ "@galacean/engine-design": "2.0.0-alpha.51"
26
26
  },
27
27
  "scripts": {
28
28
  "b:types": "tsc"
@@ -1,15 +1,17 @@
1
1
  import { BufferBindFlag, BufferUsage, IPlatformBuffer, SetDataOptions } from "@galacean/engine-core";
2
2
  import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
3
3
  export declare class GLBuffer implements IPlatformBuffer {
4
+ /** @internal */
5
+ _glBuffer: WebGLBuffer | null;
4
6
  private _gl;
5
7
  private _glBindTarget;
6
8
  private _glBufferUsage;
7
- private _glBuffer;
8
9
  private _isWebGL2;
9
10
  constructor(rhi: WebGLGraphicDevice, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, data?: ArrayBuffer | ArrayBufferView);
10
11
  bind(): void;
11
12
  setData(byteLength: number, data: ArrayBuffer | ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number, options?: SetDataOptions): void;
12
13
  getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void;
14
+ copyFromBuffer(srcBuffer: IPlatformBuffer, srcByteOffset: number, dstByteOffset: number, byteLength: number): void;
13
15
  destroy(): void;
14
16
  private _getGLBufferUsage;
15
17
  }
@@ -1 +1,33 @@
1
- export {};
1
+ import { Primitive } from "@galacean/engine-core";
2
+ import { SubPrimitive } from "@galacean/engine-core/types/graphic/SubPrimitive";
3
+ import { IPlatformPrimitive, IPlatformShaderProgram } from "@galacean/engine-design";
4
+ import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
5
+ /**
6
+ * Improvement of VAO:
7
+ * 1) WebGL2.0 must support VAO, almost all devices support vao extensions in webgl1.0, we can use PollyFill,only keep VAO mode.
8
+ */
9
+ /**
10
+ * @internal
11
+ * GL platform primitive.
12
+ */
13
+ export declare class GLPrimitive implements IPlatformPrimitive {
14
+ private _attribLocArray;
15
+ private readonly _primitive;
16
+ private readonly _canUseInstancedArrays;
17
+ private _gl;
18
+ private _vaoMap;
19
+ private readonly _isSupportVAO;
20
+ constructor(rhi: WebGLGraphicDevice, primitive: Primitive);
21
+ /**
22
+ * Draw the primitive.
23
+ */
24
+ draw(shaderProgram: IPlatformShaderProgram, subMesh: SubPrimitive): void;
25
+ destroy(): void;
26
+ /**
27
+ * Bind buffer and attribute.
28
+ */
29
+ private _bindBufferAndAttrib;
30
+ private _disableAttrib;
31
+ private _registerVAO;
32
+ private _clearVAO;
33
+ }
@@ -36,5 +36,6 @@ export declare class GLRenderTarget implements IPlatformRenderTarget {
36
36
  destroy(): void;
37
37
  private _bindMainFBO;
38
38
  private _bindMSAAFBO;
39
+ private _createRenderBuffer;
39
40
  private _checkFrameBuffer;
40
41
  }
@@ -1,9 +1,42 @@
1
- import { IPlatformTexture, Texture, TextureCubeFace, TextureDepthCompareFunction, TextureFilterMode, TextureWrapMode } from "@galacean/engine-core";
1
+ import { IPlatformTexture, Texture, TextureCubeFace, TextureDepthCompareFunction, TextureFilterMode, TextureFormat, TextureWrapMode } from "@galacean/engine-core";
2
2
  import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
3
+ import { TextureFormatDetail } from "./type";
3
4
  /**
4
5
  * Texture in WebGL platform.
5
6
  */
6
7
  export declare class GLTexture implements IPlatformTexture {
8
+ /**
9
+ * Get more texture info from TextureFormat.
10
+ * @internal
11
+ */
12
+ static _getFormatDetail(format: TextureFormat, isSRGBColorSpace: boolean, gl: WebGLRenderingContext & WebGL2RenderingContext, isWebGL2: boolean): TextureFormatDetail;
13
+ /**
14
+ * In WebGL 1, internalformat must be the same as baseFormat when call texImage2D.
15
+ * @internal
16
+ */
17
+ static _getRenderBufferDepthFormatDetail(format: TextureFormat, gl: WebGLRenderingContext & WebGL2RenderingContext, isWebGL2: boolean): TextureFormatDetail;
18
+ /**
19
+ * @internal
20
+ */
21
+ static _supportRenderBufferColorFormat(format: TextureFormat, rhi: WebGLGraphicDevice): boolean;
22
+ /**
23
+ * @internal
24
+ */
25
+ static _supportRenderBufferDepthFormat(format: TextureFormat, rhi: WebGLGraphicDevice): boolean;
26
+ /** @internal */
27
+ _texture: Texture;
28
+ /** @internal */
29
+ _glTexture: WebGLTexture | null;
30
+ /** @internal */
31
+ _rhi: WebGLGraphicDevice;
32
+ /** @internal */
33
+ _gl: WebGLRenderingContext & WebGL2RenderingContext;
34
+ /** @internal */
35
+ _isWebGL2: boolean;
36
+ /** @internal */
37
+ _target: GLenum;
38
+ /** @internal */
39
+ _formatDetail: TextureFormatDetail;
7
40
  /**
8
41
  * Wrapping mode for texture coordinate S.
9
42
  */
@@ -29,6 +62,10 @@ export declare class GLTexture implements IPlatformTexture {
29
62
  * Destroy texture.
30
63
  */
31
64
  destroy(): void;
65
+ /**
66
+ * @internal
67
+ */
68
+ setUseDepthCompareMode(value: boolean): void;
32
69
  /**
33
70
  * Generate multi-level textures based on the 0th level data.
34
71
  */
@@ -49,7 +86,7 @@ export declare class GLTexture implements IPlatformTexture {
49
86
  * @param mipLevel - Set mip level the data want to get from
50
87
  */
51
88
  protected _getPixelBuffer(face: TextureCubeFace | null, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
52
- protected _getReadFrameBuffer(): WebGLFramebuffer;
89
+ protected _getReadFrameBuffer(): WebGLFramebuffer | null;
53
90
  protected _validate(texture: Texture, rhi: WebGLGraphicDevice): void;
54
91
  private _setWrapMode;
55
92
  }
@@ -11,7 +11,7 @@ export declare class GLTexture2D extends GLTexture implements IPlatformTexture2D
11
11
  /**
12
12
  * {@inheritDoc IPlatformTexture2D.setPixelBuffer}
13
13
  */
14
- setPixelBuffer(colorBuffer: ArrayBufferView, mipLevel: number, x: number, y: number, width?: number, height?: number): void;
14
+ setPixelBuffer(colorBuffer: ArrayBufferView, mipLevel: number | undefined, x: number, y: number, width?: number, height?: number): void;
15
15
  /**
16
16
  * {@inheritDoc IPlatformTexture2D.setImageSource}
17
17
  */
@@ -0,0 +1,18 @@
1
+ import { IPlatformTransformFeedback, IPlatformBuffer } from "@galacean/engine-core";
2
+ import { WebGLGraphicDevice } from "./WebGLGraphicDevice";
3
+ /**
4
+ * @internal
5
+ * WebGL2 implementation of Transform Feedback.
6
+ */
7
+ export declare class GLTransformFeedback implements IPlatformTransformFeedback {
8
+ private _gl;
9
+ private _glTransformFeedback;
10
+ constructor(rhi: WebGLGraphicDevice);
11
+ bindBufferRange(index: number, buffer: IPlatformBuffer, byteOffset: number, byteSize: number): void;
12
+ unbindBuffer(index: number): void;
13
+ begin(primitiveMode: number): void;
14
+ end(): void;
15
+ bind(): void;
16
+ unbind(): void;
17
+ destroy(): void;
18
+ }
@@ -0,0 +1,22 @@
1
+ import { IPlatformTransformFeedbackPrimitive, VertexElement, VertexBufferBinding } from "@galacean/engine-core";
2
+ /**
3
+ * @internal
4
+ * WebGL2 implementation of Transform Feedback primitive.
5
+ * Maintains two VAOs (one per read direction), auto-rebuilds when program changes.
6
+ */
7
+ export declare class GLTransformFeedbackPrimitive implements IPlatformTransformFeedbackPrimitive {
8
+ private _gl;
9
+ private _vaoA;
10
+ private _vaoB;
11
+ private _lastProgramId;
12
+ constructor(gl: WebGL2RenderingContext);
13
+ updateVertexLayout(program: any, readBinding: VertexBufferBinding, writeBinding: VertexBufferBinding, feedbackElements: VertexElement[], inputBinding: VertexBufferBinding, inputElements: VertexElement[]): void;
14
+ bind(readIsA: boolean): void;
15
+ unbind(): void;
16
+ draw(mode: number, first: number, count: number): void;
17
+ invalidate(): void;
18
+ destroy(): void;
19
+ private _deleteVAOs;
20
+ private _createVAO;
21
+ private _bindElements;
22
+ }
@@ -1,35 +1,44 @@
1
1
  import { Canvas } from "@galacean/engine-core";
2
- import { Vector2 } from "@galacean/engine-math";
3
2
  type OffscreenCanvas = any;
4
3
  /**
5
4
  * The canvas used on the web, which can support HTMLCanvasElement and OffscreenCanvas.
6
5
  */
7
6
  export declare class WebCanvas extends Canvas {
7
+ private static _devicePixelContentBoxSupported?;
8
+ private static _supportsDevicePixelContentBox;
9
+ /** @internal */
8
10
  _webCanvas: HTMLCanvasElement | OffscreenCanvas;
9
- private _scale;
11
+ private _resizeObserver?;
12
+ private _autoResolutionScale;
13
+ private _resolutionDirty;
14
+ private _pendingDevicePixelWidth;
15
+ private _pendingDevicePixelHeight;
10
16
  /**
11
- * The scale of canvas, the value is visible width/height divide the render width/height.
12
- * @remarks Need to re-assign after modification to ensure that the modification takes effect.
17
+ * @inheritdoc
18
+ *
19
+ * @remarks
20
+ * The canvas must have a CSS-constrained display size; otherwise auto-resolution disables itself.
13
21
  */
14
- get scale(): Vector2;
15
- set scale(value: Vector2);
16
- /**
17
- * Resize the rendering size according to the clientWidth and clientHeight of the canvas.
18
- * @param pixelRatio - Pixel ratio
19
- */
20
- resizeByClientSize(pixelRatio?: number): void;
22
+ setAutoResolution(scale?: number): void;
21
23
  /**
22
24
  * Create a web canvas.
23
25
  * @param webCanvas - Web native canvas
24
26
  */
25
27
  constructor(webCanvas: HTMLCanvasElement | OffscreenCanvas);
26
28
  /**
27
- * Set scale.
28
- * @param x - Scale along the X axis
29
- * @param y - Scale along the Y axis
29
+ * @internal
30
+ */
31
+ _isOffscreenCanvas(): boolean;
32
+ /**
33
+ * @internal
34
+ */
35
+ _pumpPendingResolution(): void;
36
+ private _setResolutionByClientSizeFallback;
37
+ /**
38
+ * @internal
30
39
  */
31
- setScale(x: number, y: number): void;
32
- protected _onWidthChanged(value: number): void;
33
- protected _onHeightChange(value: number): void;
40
+ _destroy(): void;
41
+ protected _exitAutoResolution(): void;
42
+ protected _onResolutionChanged(width: number, height: number): void;
34
43
  }
35
44
  export {};
@@ -2,7 +2,7 @@ import { Engine, EngineConfiguration } from "@galacean/engine-core";
2
2
  import { WebGLGraphicDeviceOptions } from "./";
3
3
  import { WebCanvas } from "./WebCanvas";
4
4
  /**
5
- * WebGL platform engine,support includes WebGL1.0 and WebGL2.0.
5
+ * WebGL platform engine, supports WebGL 1.0 and WebGL 2.0.
6
6
  */
7
7
  export declare class WebGLEngine extends Engine {
8
8
  /**
@@ -12,12 +12,12 @@ export declare class WebGLEngine extends Engine {
12
12
  */
13
13
  static create(configuration: WebGLEngineConfiguration): Promise<WebGLEngine>;
14
14
  /**
15
- * Web canvas.
15
+ * The web canvas the engine renders to.
16
16
  */
17
17
  get canvas(): WebCanvas;
18
18
  }
19
19
  /**
20
- * WebGL engine configuration.
20
+ * Options for `WebGLEngine.create()`.
21
21
  */
22
22
  export interface WebGLEngineConfiguration extends EngineConfiguration {
23
23
  /** Canvas element or canvas id. */
@@ -1,4 +1,4 @@
1
- import { BufferBindFlag, BufferUsage, CameraClearFlags, Canvas, Engine, GLCapabilityType, IPlatformBuffer, IPlatformRenderTarget, IPlatformTexture2D, IPlatformTextureCube, Mesh, RenderTarget, SubMesh, Texture2D, Texture2DArray, TextureCube, TextureCubeFace } from "@galacean/engine-core";
1
+ import { BufferBindFlag, BufferUsage, CameraClearFlags, Canvas, Engine, GLCapabilityType, IPlatformBuffer, IPlatformRenderTarget, IPlatformTexture2D, IPlatformTextureCube, IPlatformTransformFeedback, IPlatformTransformFeedbackPrimitive, Primitive, RenderTarget, SubMesh, Texture2D, Texture2DArray, TextureCube, TextureCubeFace } from "@galacean/engine-core";
2
2
  import { IHardwareRenderer, IPlatformPrimitive, IPlatformShaderProgram } from "@galacean/engine-design";
3
3
  import { Color, Vector4 } from "@galacean/engine-math";
4
4
  import { GLCapability } from "./GLCapability";
@@ -24,6 +24,18 @@ export declare enum WebGLMode {
24
24
  export interface WebGLGraphicDeviceOptions {
25
25
  /** WebGL mode.*/
26
26
  webGLMode?: WebGLMode;
27
+ /**
28
+ * @internal
29
+ * iOS 15 webgl implement has bug, maybe should force call flush command buffer, for example iPhone13(iOS 15.4.1).
30
+ */
31
+ _forceFlush?: boolean;
32
+ /**
33
+ * @internal
34
+ * Max allow skin uniform vectors count, default is 256
35
+ *
36
+ * @remarks large count maybe cause performance issue.
37
+ */
38
+ _maxAllowSkinUniformVectorCount?: number;
27
39
  alpha?: boolean;
28
40
  depth?: boolean;
29
41
  desynchronized?: boolean;
@@ -38,6 +50,19 @@ export interface WebGLGraphicDeviceOptions {
38
50
  * WebGL graphic device, including WebGL1.0 and WebGL2.0.
39
51
  */
40
52
  export declare class WebGLGraphicDevice implements IHardwareRenderer {
53
+ maxUniformBlockSize: number;
54
+ /** @internal */
55
+ _readFrameBuffer: WebGLFramebuffer | null;
56
+ /** @internal */
57
+ _mainFrameBuffer: WebGLFramebuffer | null;
58
+ /** @internal */
59
+ _mainFrameWidth: number;
60
+ /** @internal */
61
+ _mainFrameHeight: number;
62
+ /** @internal */
63
+ _enableGlobalDepthBias: boolean;
64
+ /** @internal */
65
+ _currentBindShaderProgram: any;
41
66
  private _options;
42
67
  private _webGLOptions;
43
68
  private _gl;
@@ -67,12 +92,29 @@ export declare class WebGLGraphicDevice implements IHardwareRenderer {
67
92
  get canIUseMoreJoints(): boolean;
68
93
  constructor(initializeOptions?: WebGLGraphicDeviceOptions);
69
94
  init(canvas: Canvas, onDeviceLost: () => void, onDeviceRestored: () => void): void;
70
- createPlatformPrimitive(primitive: Mesh): IPlatformPrimitive;
95
+ createPlatformPrimitive(primitive: Primitive): IPlatformPrimitive;
71
96
  createPlatformTexture2D(texture2D: Texture2D): IPlatformTexture2D;
72
97
  createPlatformTexture2DArray(texture2D: Texture2DArray): GLTexture2DArray;
73
98
  createPlatformTextureCube(textureCube: TextureCube): IPlatformTextureCube;
74
99
  createPlatformRenderTarget(target: RenderTarget): IPlatformRenderTarget;
75
100
  createPlatformBuffer(type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, data?: ArrayBuffer | ArrayBufferView): IPlatformBuffer;
101
+ createPlatformTransformFeedback(): IPlatformTransformFeedback;
102
+ createPlatformTransformFeedbackPrimitive(): IPlatformTransformFeedbackPrimitive;
103
+ bindUniformBufferBase(bindingPoint: number, buffer: IPlatformBuffer): void;
104
+ bindUniformBlock(program: WebGLProgram, blockName: string, bindingPoint: number): number;
105
+ /**
106
+ * Enable GL_RASTERIZER_DISCARD (WebGL2 only).
107
+ */
108
+ enableRasterizerDiscard(): void;
109
+ /**
110
+ * Disable GL_RASTERIZER_DISCARD (WebGL2 only).
111
+ */
112
+ disableRasterizerDiscard(): void;
113
+ /**
114
+ * Invalidate the cached shader program state.
115
+ * Call this after using a custom program (e.g., Transform Feedback) outside the engine's pipeline.
116
+ */
117
+ invalidateShaderProgramState(): void;
76
118
  requireExtension(ext: any): any;
77
119
  canIUse(capabilityType: GLCapabilityType): boolean;
78
120
  canIUseCompressedTextureInternalFormat(type: number): boolean;
@@ -83,9 +125,9 @@ export declare class WebGLGraphicDevice implements IHardwareRenderer {
83
125
  drawPrimitive(primitive: GLPrimitive, subPrimitive: SubMesh, shaderProgram: IPlatformShaderProgram): void;
84
126
  getMainFrameBufferWidth(): number;
85
127
  getMainFrameBufferHeight(): number;
86
- activeRenderTarget(renderTarget: RenderTarget, viewport: Vector4, isFlipProjection: boolean, mipLevel?: number, faceIndex?: TextureCubeFace): void;
87
- blitInternalRTByBlitFrameBuffer(srcRT: RenderTarget, destRT: RenderTarget, clearFlags: CameraClearFlags, viewport: Vector4): void;
88
- copyRenderTargetToSubTexture(srcRT: RenderTarget, grabTexture: Texture2D, viewport: Vector4): void;
128
+ activeRenderTarget(renderTarget: RenderTarget | null, viewport: Vector4, isFlipProjection: boolean, mipLevel?: number, faceIndex?: TextureCubeFace): void;
129
+ blitInternalRTByBlitFrameBuffer(srcRT: RenderTarget | null, destRT: RenderTarget, clearFlags: CameraClearFlags, viewport: Vector4): void;
130
+ copyRenderTargetToSubTexture(srcRT: RenderTarget | null, grabTexture: Texture2D, viewport: Vector4): void;
89
131
  activeTexture(textureID: number): void;
90
132
  bindTexture(texture: GLTexture): void;
91
133
  setGlobalDepthBias(bias: number, slopeBias: number): void;