diff --git a/docs/en/core/engine.mdx b/docs/en/core/engine.mdx index bc912464ba..a22d35b807 100644 --- a/docs/en/core/engine.mdx +++ b/docs/en/core/engine.mdx @@ -31,7 +31,7 @@ Below is a description of the [configuration](/apis/galacean/#WebGLEngineConfigu | Configuration | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | | canvas | Can be a canvas ID (`string`) or a canvas object (`HTMLCanvasElement | OffscreenCanvas`) | -| [graphicDeviceOptions](/apis/galacean/#WebGLGraphicDeviceOptions) | Configuration related to the graphics device, e.g., `webGLMode` can control WebGL1/2. Properties other than `webGLMode` will be passed to the context, more details can be found in [getContext parameters explanation](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext#parameters). | +| [graphicDeviceOptions](/apis/galacean/#WebGLGraphicDeviceOptions) | WebGL context creation attributes. | | [colorSpace](/apis/galacean/#ColorSpace) | Color space, `ColorSpace.Gamma` or `ColorSpace.Linear`. | | gltf | GLTF Loader configuration, `workerCount` is used to configure the number of workers for meshOpt: `{ meshOpt: { workerCount: number } }`. | | ktx2Loader | KTX2 Loader configuration, `workerCount` is used to configure the number of workers for the ktx2 decoder: `{ priorityFormats: Array; transcoder: KTX2Transcoder; workerCount: number }`. If workerCount is greater than 0, worker threads will be created; if it equals 0, only the main thread will be used. | diff --git a/docs/zh/core/engine.mdx b/docs/zh/core/engine.mdx index 59e74e59e7..a17e5d0e58 100644 --- a/docs/zh/core/engine.mdx +++ b/docs/zh/core/engine.mdx @@ -31,7 +31,7 @@ const engine = await WebGLEngine.create({ | 配置 | 解释 | | ------------------------------------------------------------ | ------------------------------------------------------------ | | canvas | 可以是画布 ID( `string`) 或画布对象(`HTMLCanvasElement |OffscreenCanvas`)。 | -| [graphicDeviceOptions](/apis/galacean/#WebGLGraphicDeviceOptions) | 图形设备相关配置,比如 `webGLMode` 可以用 控制 WebGL1/2。除 `webGLMode` 外的属性将透传给上下文,详情可参考 [getContext 参数释义](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext#parameters)。 | +| [graphicDeviceOptions](/apis/galacean/#WebGLGraphicDeviceOptions) | 传给 WebGL 上下文的创建参数。 | | [colorSpace](/apis/galacean/#ColorSpace) | 颜色空间, `ColorSpace.Gamma` 或 `ColorSpace.Linear`。 | | gltf | gltf Loader 配置,`workerCount` 用来配置 meshOpt 的 worker 数量:`{ meshOpt: { workerCount: number } }` 。 | | ktx2Loader | KTX2 Loader 配置,`workerCount` 用来配置 ktx2 解码器的worker 数量:`{ priorityFormats: Array; transcoder: KTX2Transcoder; workerCount: number }`。如果 workCount 大于 0,将会创建 worker 线程,等于 0 则只用主线程。 | diff --git a/e2e/case/camera-ssao.ts b/e2e/case/camera-ssao.ts index 8fbdfeb6f8..0b97c7dddc 100644 --- a/e2e/case/camera-ssao.ts +++ b/e2e/case/camera-ssao.ts @@ -16,8 +16,7 @@ import { PrimitiveMesh, SkyBoxMaterial, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; @@ -27,8 +26,7 @@ Logger.enable(); // Create engine WebGLEngine.create({ canvas: "canvas", - shaderCompiler: new ShaderCompiler(), - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL1 } + shaderCompiler: new ShaderCompiler() }).then((engine) => { engine.canvas.setAutoResolution(2); diff --git a/e2e/case/multi-camera-no-clear.ts b/e2e/case/multi-camera-no-clear.ts index 2bec9eefd4..7a4636ed91 100644 --- a/e2e/case/multi-camera-no-clear.ts +++ b/e2e/case/multi-camera-no-clear.ts @@ -16,8 +16,7 @@ import { PrimitiveMesh, Scene, TonemappingEffect, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; @@ -25,7 +24,6 @@ Logger.enable(); WebGLEngine.create({ canvas: "canvas", graphicDeviceOptions: { - webGLMode: WebGLMode.WebGL2, antialias: false } }).then((engine) => { diff --git a/e2e/case/multi-scene-no-clear.ts b/e2e/case/multi-scene-no-clear.ts index 976e67e8ae..7284cfac36 100644 --- a/e2e/case/multi-scene-no-clear.ts +++ b/e2e/case/multi-scene-no-clear.ts @@ -15,17 +15,13 @@ import { PrimitiveMesh, Scene, TonemappingEffect, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; Logger.enable(); WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { - webGLMode: WebGLMode.WebGL2 - } + canvas: "canvas" }).then((engine) => { const firstCamera = initFirstScene(engine); const secondCamera = initSecondScene(engine); diff --git a/e2e/case/particleRenderer-emissive.ts b/e2e/case/particleRenderer-emissive.ts index 2de9f66fbe..02b0478d3c 100644 --- a/e2e/case/particleRenderer-emissive.ts +++ b/e2e/case/particleRenderer-emissive.ts @@ -18,15 +18,13 @@ import { ParticleRenderer, Texture2D, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; // Create engine WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.Auto } + canvas: "canvas" }).then((engine) => { Logger.enable(); diff --git a/e2e/case/particleRenderer-force.ts b/e2e/case/particleRenderer-force.ts index 3456f2c34b..6ef7568df5 100644 --- a/e2e/case/particleRenderer-force.ts +++ b/e2e/case/particleRenderer-force.ts @@ -21,8 +21,7 @@ import { Scene, Texture2D, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; diff --git a/e2e/case/particleRenderer-inherit-velocity-stretched.ts b/e2e/case/particleRenderer-inherit-velocity-stretched.ts index c5b87d20bc..7017ddb07f 100644 --- a/e2e/case/particleRenderer-inherit-velocity-stretched.ts +++ b/e2e/case/particleRenderer-inherit-velocity-stretched.ts @@ -19,14 +19,12 @@ import { ParticleRenderMode, ParticleSimulationSpace, Script, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } + canvas: "canvas" }).then((engine) => { const scene = engine.sceneManager.activeScene; scene.background.solidColor = new Color(0.01, 0.01, 0.015, 1); diff --git a/e2e/case/particleRenderer-shape-mesh.ts b/e2e/case/particleRenderer-shape-mesh.ts index 5fd658231e..f778a21c14 100644 --- a/e2e/case/particleRenderer-shape-mesh.ts +++ b/e2e/case/particleRenderer-shape-mesh.ts @@ -18,15 +18,13 @@ import { ParticleRenderer, Texture2D, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; // Create engine WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.Auto } + canvas: "canvas" }).then((engine) => { Logger.enable(); diff --git a/e2e/case/particleRenderer-sub-emitter.ts b/e2e/case/particleRenderer-sub-emitter.ts index e4a5ff8b77..faeba2a3f8 100644 --- a/e2e/case/particleRenderer-sub-emitter.ts +++ b/e2e/case/particleRenderer-sub-emitter.ts @@ -27,14 +27,12 @@ import { ParticleSubEmitterType, SphereShape, Texture2D, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } + canvas: "canvas" }).then((engine) => { const scene = engine.sceneManager.activeScene; const rootEntity = scene.createRootEntity(); diff --git a/e2e/case/particleRenderer-velocity-orbital-constant.ts b/e2e/case/particleRenderer-velocity-orbital-constant.ts index 9bb1b38ed2..dd59dd019e 100644 --- a/e2e/case/particleRenderer-velocity-orbital-constant.ts +++ b/e2e/case/particleRenderer-velocity-orbital-constant.ts @@ -16,14 +16,12 @@ import { ParticleSimulationSpace, Texture2D, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } + canvas: "canvas" }).then((engine) => { const scene = engine.sceneManager.activeScene; const rootEntity = scene.createRootEntity(); diff --git a/e2e/case/shadow-transparent.ts b/e2e/case/shadow-transparent.ts index 8b03ecb580..76c896095b 100644 --- a/e2e/case/shadow-transparent.ts +++ b/e2e/case/shadow-transparent.ts @@ -14,17 +14,13 @@ import { ShadowResolution, ShadowType, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { initScreenshot, updateForE2E } from "./.mockForE2E"; Logger.enable(); WebGLEngine.create({ - canvas: "canvas", - graphicDeviceOptions: { - webGLMode: WebGLMode.WebGL2 - } + canvas: "canvas" }).then((engine) => { const scene = engine.sceneManager.activeScene; const rootEntity = scene.createRootEntity(); diff --git a/examples/src/CSS-DOM.ts b/examples/src/CSS-DOM.ts index 192b998265..29b777b04a 100644 --- a/examples/src/CSS-DOM.ts +++ b/examples/src/CSS-DOM.ts @@ -12,8 +12,7 @@ import { Logger, Script, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { OrbitControl } from "@galacean/engine-toolkit"; @@ -21,8 +20,7 @@ async function main() { // Create engine const htmlCanvas = document.getElementById("canvas") as HTMLCanvasElement; const engine = await WebGLEngine.create({ - canvas: htmlCanvas, - graphicDeviceOptions: { webGLMode: WebGLMode.Auto } + canvas: htmlCanvas }); // Create root entity diff --git a/examples/src/gpu-instancing-auto-batch.ts b/examples/src/gpu-instancing-auto-batch.ts index ce27044161..481615b45f 100644 --- a/examples/src/gpu-instancing-auto-batch.ts +++ b/examples/src/gpu-instancing-auto-batch.ts @@ -20,8 +20,7 @@ import { ShaderProperty, Vector3, Vector4, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; @@ -122,7 +121,6 @@ const customInstanceShaderSource = `Shader "CustomInstanceShader" { Logger.enable(); WebGLEngine.create({ canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 }, shaderCompiler }).then(async (engine) => { Shader.create(customInstanceShaderSource); diff --git a/examples/src/gpu-instancing-custom-data.ts b/examples/src/gpu-instancing-custom-data.ts index 52b0ea89a3..c2c9977131 100644 --- a/examples/src/gpu-instancing-custom-data.ts +++ b/examples/src/gpu-instancing-custom-data.ts @@ -17,8 +17,7 @@ import { ShaderProperty, Vector3, Vector4, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; @@ -107,7 +106,6 @@ const customInstanceShaderSource = `Shader "CustomInstanceShader" { WebGLEngine.create({ canvas: "canvas", - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 }, shaderCompiler }).then((engine) => { Shader.create(customInstanceShaderSource); diff --git a/packages/core/src/2d/atlas/FontAtlas.ts b/packages/core/src/2d/atlas/FontAtlas.ts index 4ad59f8adc..1bf3eb2a10 100644 --- a/packages/core/src/2d/atlas/FontAtlas.ts +++ b/packages/core/src/2d/atlas/FontAtlas.ts @@ -20,11 +20,14 @@ export class FontAtlas extends ReferResource { constructor(engine: Engine) { super(engine); this.isGCIgnored = true; - const format = engine._hardwareRenderer.isWebGL2 ? TextureFormat.R8 : TextureFormat.Alpha8; - const texture = new Texture2D(engine, 512, 512, format, false, false); + this.texture = this._createTexture(engine); + } + + private _createTexture(engine: Engine): Texture2D { + const texture = new Texture2D(engine, 512, 512, TextureFormat.R8, false, false); texture.filterMode = TextureFilterMode.Bilinear; texture.isGCIgnored = true; - this.texture = texture; + return texture; } uploadCharTexture(charInfo: CharInfo): boolean { diff --git a/packages/core/src/2d/index.ts b/packages/core/src/2d/index.ts index 47be64ccfc..183439b608 100644 --- a/packages/core/src/2d/index.ts +++ b/packages/core/src/2d/index.ts @@ -14,3 +14,5 @@ export { OverflowMode } from "./enums/TextOverflow"; export * from "./sprite/index"; export * from "./text/index"; export type { ITextRenderer } from "./text/ITextRenderer"; +/** @internal */ +export { FontAtlas } from "./atlas/FontAtlas"; diff --git a/packages/core/src/BasicResources.ts b/packages/core/src/BasicResources.ts index 00c1978c81..57ac80275d 100644 --- a/packages/core/src/BasicResources.ts +++ b/packages/core/src/BasicResources.ts @@ -183,25 +183,7 @@ export class BasicResources { true ); - const isWebGL2 = engine._hardwareRenderer.isWebGL2; - if (isWebGL2) { - this.whiteTexture2DArray = this._create1x1Texture( - engine, - TextureType.Texture2DArray, - TextureFormat.R8G8B8A8, - whitePixel, - true - ); - - const whitePixel32 = new Uint32Array([255, 255, 255, 255]); - this.uintWhiteTexture2D = this._create1x1Texture( - engine, - TextureType.Texture2D, - TextureFormat.R32G32B32A32_UInt, - whitePixel32, - false - ); - } + [this.whiteTexture2DArray, this.uintWhiteTexture2D] = this._createDefaultArrayTextures(engine, whitePixel); this.spriteDefaultMaterial = this._create2DMaterial(engine, shaders.sprite); this.textDefaultMaterial = this._create2DMaterial(engine, shaders.text); @@ -211,6 +193,27 @@ export class BasicResources { this.particleMagentaMaterial = this._createMagentaMaterial(engine, shaders.particle); } + private _createDefaultArrayTextures(engine: Engine, whitePixel: Uint8Array): [Texture2DArray, Texture2D] { + const arrayTexture = this._create1x1Texture( + engine, + TextureType.Texture2DArray, + TextureFormat.R8G8B8A8, + whitePixel, + true + ); + + const whitePixel32 = new Uint32Array([255, 255, 255, 255]); + const uintTexture = this._create1x1Texture( + engine, + TextureType.Texture2D, + TextureFormat.R32G32B32A32_UInt, + whitePixel32, + false + ); + + return [arrayTexture, uintTexture]; + } + /** * @internal */ diff --git a/packages/core/src/Camera.ts b/packages/core/src/Camera.ts index 29c683a285..8afe43e186 100644 --- a/packages/core/src/Camera.ts +++ b/packages/core/src/Camera.ts @@ -8,7 +8,7 @@ import { BasicRenderPipeline } from "./RenderPipeline/BasicRenderPipeline"; import { Transform } from "./Transform"; import { UpdateFlagManager } from "./UpdateFlagManager"; import { VirtualCamera } from "./VirtualCamera"; -import { GLCapabilityType, Logger } from "./base"; +import { Logger } from "./base"; import { ignoreClone } from "./clone/CloneDecorators"; import { AntiAliasing } from "./enums/AntiAliasing"; import { CameraClearFlags } from "./enums/CameraClearFlags"; @@ -378,12 +378,6 @@ export class Camera extends Component { set enableHDR(value: boolean) { if (this.enableHDR !== value) { - const rhi = this.engine._hardwareRenderer; - const supportHDR = rhi.isWebGL2 || rhi.canIUse(GLCapabilityType.textureHalfFloat); - if (value && !supportHDR) { - Logger.warn("Can't enable HDR in this device."); - return; - } this._enableHDR = value; } } @@ -659,10 +653,6 @@ export class Camera extends Component { this._globalShaderMacro ); - if (mipLevel > 0 && !engine._hardwareRenderer.isWebGL2) { - mipLevel = 0; - Logger.error("mipLevel only take effect in WebGL2.0"); - } let ignoreClearFlags: CameraClearFlags | undefined; if (this._cameraType !== CameraType.Normal && !this._renderTarget) { ignoreClearFlags = engine.xrManager._getCameraIgnoreClearFlags(this._cameraType); @@ -769,7 +759,7 @@ export class Camera extends Component { */ _getInternalColorTextureFormat(): TextureFormat { return this._enableHDR - ? this.engine._hardwareRenderer.isWebGL2 && !this.isAlphaOutputRequired + ? !this.isAlphaOutputRequired ? TextureFormat.R11G11B10_UFloat : TextureFormat.R16G16B16A16 : TextureFormat.R8G8B8A8; diff --git a/packages/core/src/Engine.ts b/packages/core/src/Engine.ts index b039a46d43..9cb5381224 100644 --- a/packages/core/src/Engine.ts +++ b/packages/core/src/Engine.ts @@ -23,7 +23,6 @@ import { SceneManager } from "./SceneManager"; import { RenderingStatistics } from "./asset/RenderingStatistics"; import { ResourceManager } from "./asset/ResourceManager"; import { EngineObject, EventDispatcher, Logger, Time } from "./base"; -import { GLCapabilityType } from "./base/Constant"; import { InputManager } from "./input"; import { ParticleBufferUtils } from "./particle/ParticleBufferUtils"; import { ColliderShape } from "./physics/shape/ColliderShape"; @@ -49,10 +48,6 @@ export class Engine extends EventDispatcher { /** @internal */ static _builtinShaders: BuiltinShaders; - /** @internal */ - static _noDepthTextureMacro = ShaderMacro.getByName("ENGINE_NO_DEPTH_TEXTURE"); - /** @internal */ - static _noSRGBSupportMacro = ShaderMacro.getByName("ENGINE_NO_SRGB"); /** @internal */ static _outputSRGBCorrectMacro = ShaderMacro.getByName("ENGINE_OUTPUT_SRGB_CORRECT"); /** @internal Conversion of space units to pixel units for 2D. */ @@ -270,17 +265,7 @@ export class Engine extends EventDispatcher { this.xrManager._initialize(this, xrDevice); } - if (!hardwareRenderer.canIUse(GLCapabilityType.depthTexture)) { - this._macroCollection.enable(Engine._noDepthTextureMacro); - } else { - const depthTexture2D = new Texture2D(this, 1, 1, TextureFormat.Depth16, false, false); - depthTexture2D.isGCIgnored = true; - this._depthTexture2D = depthTexture2D; - } - - if (!hardwareRenderer.canIUse(GLCapabilityType.sRGB)) { - this._macroCollection.enable(Engine._noSRGBSupportMacro); - } + this._initializeDefaultTextures(); this._basicResources = new BasicResources(this, Engine._builtinShaders); this._particleBufferUtils = new ParticleBufferUtils(this); @@ -289,6 +274,12 @@ export class Engine extends EventDispatcher { this.addPostProcessPass(uberPass); } + private _initializeDefaultTextures(): void { + const depthTexture = new Texture2D(this, 1, 1, TextureFormat.Depth16, false, false); + depthTexture.isGCIgnored = true; + this._depthTexture2D = depthTexture; + } + /** * Create an entity. * @param name - The name of the entity diff --git a/packages/core/src/RenderPipeline/BasicRenderPipeline.ts b/packages/core/src/RenderPipeline/BasicRenderPipeline.ts index f86a119eda..e9093cfcda 100644 --- a/packages/core/src/RenderPipeline/BasicRenderPipeline.ts +++ b/packages/core/src/RenderPipeline/BasicRenderPipeline.ts @@ -120,7 +120,7 @@ export class BasicRenderPipeline { // 1. Only support blitFramebuffer in webgl2 context // 2. Can't blit normal FBO to MSAA FBO // 3. Can't blit screen MSAA FBO to normal FBO in mac safari platform and mobile, but mac chrome and firfox is OK - this._canUseBlitFrameBuffer = rhi.isWebGL2 && msaaSamples === 1; + this._canUseBlitFrameBuffer = msaaSamples === 1; // Because internal render target is linear color space, so we should convert srgb background color to linear color space const isSRGBBackground = !renderTarget || renderTarget.getColorTexture(0)!.isSRGBColorSpace; diff --git a/packages/core/src/RenderPipeline/DepthOnlyPass.ts b/packages/core/src/RenderPipeline/DepthOnlyPass.ts index 6129808491..ec25dad4f5 100644 --- a/packages/core/src/RenderPipeline/DepthOnlyPass.ts +++ b/packages/core/src/RenderPipeline/DepthOnlyPass.ts @@ -1,7 +1,6 @@ import { Camera } from "../Camera"; import { Engine } from "../Engine"; import { PipelinePass } from "../RenderPipeline/PipelinePass"; -import { GLCapabilityType } from "../base/Constant"; import { CameraClearFlags } from "../enums/CameraClearFlags"; import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../texture"; import { RenderTarget } from "../texture/RenderTarget"; @@ -15,12 +14,13 @@ import { PipelineStage } from "./enums/PipelineStage"; * Depth only pass. */ export class DepthOnlyPass extends PipelinePass { - readonly supportDepthTexture: boolean; + get supportDepthTexture(): boolean { + return true; + } renderTarget: RenderTarget | null; constructor(engine: Engine) { super(engine); - this.supportDepthTexture = engine._hardwareRenderer.canIUse(GLCapabilityType.depthTexture); } onConfig(camera: Camera): void { @@ -33,7 +33,7 @@ export class DepthOnlyPass extends PipelinePass { width, height, null, - engine._hardwareRenderer.isWebGL2 ? TextureFormat.Depth24 : TextureFormat.Depth24Stencil8, + TextureFormat.Depth24, true, false, false, diff --git a/packages/core/src/RenderPipeline/index.ts b/packages/core/src/RenderPipeline/index.ts index c08732fbcb..0a9699506b 100644 --- a/packages/core/src/RenderPipeline/index.ts +++ b/packages/core/src/RenderPipeline/index.ts @@ -6,3 +6,7 @@ export { Blitter } from "./Blitter"; export { RenderElement } from "./RenderElement"; export { RenderQueue } from "./RenderQueue"; export { PipelineStage } from "./enums/PipelineStage"; +/** @internal */ +export { DepthOnlyPass } from "./DepthOnlyPass"; +/** @internal */ +export { PipelineUtils } from "./PipelineUtils"; diff --git a/packages/core/src/SystemInfo.ts b/packages/core/src/SystemInfo.ts index 016fe51583..376afdb959 100644 --- a/packages/core/src/SystemInfo.ts +++ b/packages/core/src/SystemInfo.ts @@ -1,5 +1,4 @@ import { AssetPromise } from "./asset/AssetPromise"; -import { GLCapabilityType } from "./base/Constant"; import { Engine } from "./Engine"; import { Platform } from "./Platform"; import { TextureFormat } from "./texture"; @@ -126,37 +125,6 @@ export class SystemInfo { * @returns Whether support the texture format */ static supportsTextureFormat(engine: Engine, format: TextureFormat): boolean { - const rhi = engine._hardwareRenderer; - rhi.canIUse(GLCapabilityType.depthTexture); - switch (format) { - case TextureFormat.R16G16B16A16: - if (!rhi.canIUse(GLCapabilityType.textureHalfFloat)) { - return false; - } - break; - case TextureFormat.R32G32B32A32: - if (!rhi.canIUse(GLCapabilityType.textureFloat)) { - return false; - } - break; - case TextureFormat.Depth16: - case TextureFormat.Depth24Stencil8: - case TextureFormat.Depth: - case TextureFormat.DepthStencil: - if (!rhi.canIUse(GLCapabilityType.depthTexture)) { - return false; - } - break; - case TextureFormat.R11G11B10_UFloat: - case TextureFormat.R32G32B32A32_UInt: - case TextureFormat.Depth24: - case TextureFormat.Depth32: - case TextureFormat.Depth32Stencil8: - case TextureFormat.R8: - case TextureFormat.R8G8: - return rhi.isWebGL2; - } - return true; } } diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index e95af2aeba..d0376eb8b1 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -1,5 +1,7 @@ export { Platform } from "./Platform"; export { Engine } from "./Engine"; +/** @internal */ +export { BasicResources } from "./BasicResources"; export { SystemInfo } from "./SystemInfo"; export { Canvas } from "./Canvas"; diff --git a/packages/core/src/mesh/MeshRenderer.ts b/packages/core/src/mesh/MeshRenderer.ts index ea621c5a5f..fbd4de5830 100644 --- a/packages/core/src/mesh/MeshRenderer.ts +++ b/packages/core/src/mesh/MeshRenderer.ts @@ -178,7 +178,6 @@ export class MeshRenderer extends Renderer { * @internal */ override _canBatch(preElement: RenderElement, curElement: RenderElement): boolean { - if (!this._engine._hardwareRenderer.isWebGL2) return false; const curShaderData = curElement.component.shaderData; return ( preElement.primitive === curElement.primitive && diff --git a/packages/core/src/mesh/PrimitiveMesh.ts b/packages/core/src/mesh/PrimitiveMesh.ts index d073ae5396..3866fc4faf 100644 --- a/packages/core/src/mesh/PrimitiveMesh.ts +++ b/packages/core/src/mesh/PrimitiveMesh.ts @@ -1,6 +1,5 @@ import { MathUtil, Vector2, Vector3 } from "@galacean/engine-math"; import { Engine } from "../Engine"; -import { GLCapabilityType } from "../base/Constant"; import { BufferBindFlag, BufferUsage, VertexElement, VertexElementFormat } from "../graphic"; import { Buffer } from "../graphic/Buffer"; import { ModelMesh } from "./ModelMesh"; @@ -2042,9 +2041,7 @@ export class PrimitiveMesh { } const data = generate(...args); data.trim(); - if (data.vertexCount > 65535 && !engine._hardwareRenderer.canIUse(GLCapabilityType.elementIndexUint)) { - throw new Error("The vertex count is over limit."); - } + PrimitiveMesh._validateIndexFormat(engine, data.vertexCount); const mesh = new ModelMesh(engine); const vertices = data.vertices; const indices = data.indices; @@ -2073,6 +2070,8 @@ export class PrimitiveMesh { return mesh; } + private static _validateIndexFormat(_engine: Engine, _vertexCount: number): void {} + private static _polygons( input: readonly Vector2[] | PolygonShape | readonly PolygonShape[] ): readonly PolygonShape[] { diff --git a/packages/core/src/particle/ParticleGenerator.ts b/packages/core/src/particle/ParticleGenerator.ts index fa128ef749..b7c8971c1b 100644 --- a/packages/core/src/particle/ParticleGenerator.ts +++ b/packages/core/src/particle/ParticleGenerator.ts @@ -641,18 +641,15 @@ export class ParticleGenerator extends DataObject implements ICloneHook = Object.create(null); - static readonly shaderExtension = [ - "GL_EXT_shader_texture_lod", - "GL_OES_standard_derivatives", - "GL_EXT_draw_buffers", - "GL_EXT_frag_depth" - ] - .map((e) => `#extension ${e} : enable\n`) - .join(""); + static readonly shaderExtension: string = ""; private static readonly _std140TypeInfoMap: Record = { float: { size: 4, align: 4 }, diff --git a/packages/core/src/shader/ShaderPass.ts b/packages/core/src/shader/ShaderPass.ts index f83c30a5c5..e67a3c1383 100644 --- a/packages/core/src/shader/ShaderPass.ts +++ b/packages/core/src/shader/ShaderPass.ts @@ -2,7 +2,6 @@ import type { ShaderInstruction } from "@galacean/engine-design"; import { Engine } from "../Engine"; import { InstanceBuffer } from "../RenderPipeline/InstanceBuffer"; import { PipelineStage } from "../RenderPipeline/enums/PipelineStage"; -import { GLCapabilityType } from "../base/Constant"; import { InstanceBufferLayout, ShaderFactory } from "./ShaderFactory"; import { ShaderMacro } from "./ShaderMacro"; import { ShaderMacroCollection } from "./ShaderMacroCollection"; @@ -148,17 +147,12 @@ export class ShaderPass extends ShaderPart { macroCollection: ShaderMacroCollection, isGPUInstance: boolean ): { vertexSource: string; fragmentSource: string; instanceLayout: InstanceBufferLayout | null } { - const isWebGL2: boolean = engine._hardwareRenderer.isWebGL2; const shaderMacroList = ShaderPass._shaderMacroList; shaderMacroList.length = 0; ShaderMacro._getMacrosElements(macroCollection, shaderMacroList); - shaderMacroList.push(ShaderMacro.getByName(isWebGL2 ? "GRAPHICS_API_WEBGL2" : "GRAPHICS_API_WEBGL1")); - if (engine._hardwareRenderer.canIUse(GLCapabilityType.shaderTextureLod)) { - shaderMacroList.push(ShaderMacro.getByName("HAS_TEX_LOD")); - } - if (engine._hardwareRenderer.canIUse(GLCapabilityType.standardDerivatives)) { - shaderMacroList.push(ShaderMacro.getByName("HAS_DERIVATIVES")); - } + shaderMacroList.push(ShaderMacro.getByName("GRAPHICS_API_WEBGL2")); + shaderMacroList.push(ShaderMacro.getByName("HAS_TEX_LOD")); + shaderMacroList.push(ShaderMacro.getByName("HAS_DERIVATIVES")); const macroMap = ShaderPass._macroMap; macroMap.clear(); @@ -177,19 +171,18 @@ export class ShaderPass extends ShaderPart { instanceLayout = injected.instanceLayout; } - if (isWebGL2 && this._platformTarget === ShaderLanguage.GLSLES100) { + if (this._platformTarget === ShaderLanguage.GLSLES100) { vertexSource = ShaderFactory.convertTo300(vertexSource); fragmentSource = ShaderFactory.convertTo300(fragmentSource, true); } - const versionStr = isWebGL2 ? "#version 300 es" : "#version 100"; + const versionStr = "#version 300 es"; return { vertexSource: ` ${versionStr} ${vertexSource} `, fragmentSource: ` ${versionStr} - ${isWebGL2 ? "" : ShaderFactory.shaderExtension} ${precisionStr} ${fragmentSource} `, diff --git a/packages/core/src/shader/ShaderProgram.ts b/packages/core/src/shader/ShaderProgram.ts index 815ab13ad2..8ef9c147b2 100644 --- a/packages/core/src/shader/ShaderProgram.ts +++ b/packages/core/src/shader/ShaderProgram.ts @@ -510,18 +510,22 @@ export class ShaderProgram { this.attributeLocation[name] = gl.getAttribLocation(program, name); }); - // Record uniform block indices and bind binding points (WebGL2 only) - if (this._engine._hardwareRenderer.isWebGL2) { - const gl2 = gl; - const bindingMap = ShaderFactory.uniformBlockBindingMap; - const blockCount = gl2.getProgramParameter(program, gl2.ACTIVE_UNIFORM_BLOCKS) ?? 0; - for (let i = 0; i < blockCount; i++) { - const id = ShaderBlockProperty.getByName(gl2.getActiveUniformBlockName(program, i)!)._uniqueId; - this.uniformBlockIds[i] = id; - const bindingPoint = bindingMap[id]; - if (bindingPoint !== undefined) { - gl2.uniformBlockBinding(program, i, bindingPoint); - } + this._recordUniformBlocks(); + } + + private _recordUniformBlocks(): void { + const gl = this._gl; + const program = this._glProgram!; + + const gl2 = gl; + const bindingMap = ShaderFactory.uniformBlockBindingMap; + const blockCount = gl2.getProgramParameter(program, gl2.ACTIVE_UNIFORM_BLOCKS) ?? 0; + for (let i = 0; i < blockCount; i++) { + const id = ShaderBlockProperty.getByName(gl2.getActiveUniformBlockName(program, i)!)._uniqueId; + this.uniformBlockIds[i] = id; + const bindingPoint = bindingMap[id]; + if (bindingPoint !== undefined) { + gl2.uniformBlockBinding(program, i, bindingPoint); } } } diff --git a/packages/core/src/shader/index.ts b/packages/core/src/shader/index.ts index 94633e10a9..01e365f857 100644 --- a/packages/core/src/shader/index.ts +++ b/packages/core/src/shader/index.ts @@ -19,3 +19,9 @@ export { ShaderPass } from "./ShaderPass"; export { ShaderProperty } from "./ShaderProperty"; export { ShaderTagKey } from "./ShaderTagKey"; export { SubShader } from "./SubShader"; +/** @internal */ +export { BlendState } from "./state/BlendState"; +/** @internal */ +export { ShaderProgram } from "./ShaderProgram"; +/** @internal */ +export { ShaderMacroProcessor } from "./ShaderMacroProcessor"; diff --git a/packages/core/src/shader/state/BlendState.ts b/packages/core/src/shader/state/BlendState.ts index 09b0d1742f..bb4d0e4d5d 100644 --- a/packages/core/src/shader/state/BlendState.ts +++ b/packages/core/src/shader/state/BlendState.ts @@ -61,15 +61,9 @@ export class BlendState extends DataObject { case BlendOperation.ReverseSubtract: return gl.FUNC_REVERSE_SUBTRACT; case BlendOperation.Min: - if (!rhi.canIUse(GLCapabilityType.blendMinMax)) { - throw new Error("BlendOperation.Min is not supported in this context"); - } - return gl.MIN; // in webgl1.0 is an extension + return gl.MIN; case BlendOperation.Max: - if (!rhi.canIUse(GLCapabilityType.blendMinMax)) { - throw new Error("BlendOperation.Max is not supported in this context"); - } - return gl.MAX; // in webgl1.0 is an extension + return gl.MAX; } } diff --git a/packages/core/src/shadow/CascadedShadowCasterPass.ts b/packages/core/src/shadow/CascadedShadowCasterPass.ts index 63b8ed4000..5a86637ff9 100644 --- a/packages/core/src/shadow/CascadedShadowCasterPass.ts +++ b/packages/core/src/shadow/CascadedShadowCasterPass.ts @@ -41,7 +41,6 @@ export class CascadedShadowCasterPass extends PipelinePass { private static _tempMatrix0 = new Matrix(); private readonly _camera: Camera; - private readonly _supportDepthTexture: boolean; private _shadowMapResolution: number; private _shadowMapSize: Vector4 = new Vector4(); @@ -66,7 +65,6 @@ export class CascadedShadowCasterPass extends PipelinePass { super(camera.engine); this._camera = camera; - this._supportDepthTexture = camera.engine._hardwareRenderer.canIUse(GLCapabilityType.depthTexture); this._shadowSliceData.virtualCamera.isOrthographic = true; } @@ -79,6 +77,33 @@ export class CascadedShadowCasterPass extends PipelinePass { this._renderDirectShadowMap(context, light); this._updateReceiversShaderData(light); } + private _prepareShadowMap(context: RenderContext): void { + const { z: width, w: height } = this._shadowMapSize; + const target = PipelineUtils.recreateRenderTargetIfNeeded( + this.engine, + this._renderTarget, + width, + height, + null, + this._shadowMapFormat, + true, + false, + false, + 1, + TextureWrapMode.Clamp, + TextureFilterMode.Bilinear + ); + const texture = target.depthTexture as Texture2D; + texture.depthCompareFunction = TextureDepthCompareFunction.Less; + this._renderTarget = target; + this._depthTexture = texture; + context.setRenderTarget(target, CascadedShadowCasterPass._viewport, 0); + this.engine._hardwareRenderer.clearRenderTarget(this.engine, CameraClearFlags.Depth, null); + } + + private _getShadowFormat(): TextureFormat { + return TextureFormat.Depth16; + } private _renderDirectShadowMap(context: RenderContext, light: DirectLight): void { const { @@ -104,59 +129,8 @@ export class CascadedShadowCasterPass extends PipelinePass { const lightSide = this._lightSide; const lightForward = shadowSliceData.virtualCamera.forward; - // Prepare render target const { z: width, w: height } = this._shadowMapSize; - const format = this._shadowMapFormat; - let renderTarget: RenderTarget; - let shadowTexture: Texture2D; - if (this._supportDepthTexture) { - renderTarget = PipelineUtils.recreateRenderTargetIfNeeded( - engine, - this._renderTarget, - width, - height, - null, - format, - true, - false, - false, - 1, - TextureWrapMode.Clamp, - TextureFilterMode.Bilinear - ); - shadowTexture = renderTarget.depthTexture; - } else { - renderTarget = PipelineUtils.recreateRenderTargetIfNeeded( - engine, - this._renderTarget, - width, - height, - format, - null, - false, - false, - false, - 1, - TextureWrapMode.Clamp, - TextureFilterMode.Bilinear - ); - shadowTexture = renderTarget.getColorTexture(0); - } - - if (engine._hardwareRenderer._isWebGL2) { - shadowTexture.depthCompareFunction = TextureDepthCompareFunction.Less; - } - - this._renderTarget = renderTarget; - this._depthTexture = shadowTexture; - - // @todo: shouldn't set viewport and scissor in activeRenderTarget - context.setRenderTarget(renderTarget, CascadedShadowCasterPass._viewport, 0); - if (this._supportDepthTexture) { - rhi.clearRenderTarget(engine, CameraClearFlags.Depth, null); - } else { - rhi.clearRenderTarget(engine, CameraClearFlags.All, CascadedShadowCasterPass._clearColor); - } + this._prepareShadowMap(context); // prepare light and camera direction Matrix.rotationQuaternion(light.entity.transform.worldRotationQuaternion, lightWorld); @@ -321,7 +295,7 @@ export class CascadedShadowCasterPass extends PipelinePass { private _updateShadowSettings(): void { const camera = this._camera; const scene = camera.scene!; - const shadowFormat = ShadowUtils.shadowDepthFormat(scene.shadowResolution, this._supportDepthTexture); + const shadowFormat = this._getShadowFormat(); const shadowResolution = ShadowUtils.shadowResolution(scene.shadowResolution); const shadowCascades = scene.shadowCascades; const shadowFar = Math.min(scene.shadowDistance, camera.farClipPlane); diff --git a/packages/core/src/shadow/ShadowUtils.ts b/packages/core/src/shadow/ShadowUtils.ts index 0ef660757a..49bafca1eb 100644 --- a/packages/core/src/shadow/ShadowUtils.ts +++ b/packages/core/src/shadow/ShadowUtils.ts @@ -149,11 +149,7 @@ export class ShadowUtils { } static shadowDepthFormat(value: ShadowResolution, supportDepthTexture: boolean): TextureFormat { - if (supportDepthTexture) { - return TextureFormat.Depth16; - } else { - return TextureFormat.R8G8B8A8; - } + return TextureFormat.Depth16; } static cullingRenderBounds(bounds: BoundingBox, cullPlaneCount: number, cullPlanes: Plane[]): boolean { diff --git a/packages/core/src/shadow/index.ts b/packages/core/src/shadow/index.ts index cb09a192e8..98d7da35e5 100644 --- a/packages/core/src/shadow/index.ts +++ b/packages/core/src/shadow/index.ts @@ -1,3 +1,5 @@ export { ShadowCascadesMode } from "./enum/ShadowCascadesMode"; export { ShadowResolution } from "./enum/ShadowResolution"; export { ShadowType } from "./enum/ShadowType"; +/** @internal */ +export { CascadedShadowCasterPass } from "./CascadedShadowCasterPass"; diff --git a/packages/core/src/texture/Texture.ts b/packages/core/src/texture/Texture.ts index efded7ecad..7837a39bed 100644 --- a/packages/core/src/texture/Texture.ts +++ b/packages/core/src/texture/Texture.ts @@ -165,11 +165,6 @@ export abstract class Texture extends GraphicsResource { } set depthCompareFunction(value: TextureDepthCompareFunction) { - if (!this._engine._hardwareRenderer._isWebGL2) { - console.warn("depthCompareFunction only support WebGL2"); - return; - } - if (value !== this._depthCompareFunction) { this._depthCompareFunction = value; this._platformTexture.depthCompareFunction = value; @@ -227,10 +222,8 @@ export abstract class Texture extends GraphicsResource { platformTexture.wrapModeV = this._wrapModeV; platformTexture.filterMode = this._filterMode; platformTexture.anisoLevel = this._anisoLevel; - if (this._engine._hardwareRenderer._isWebGL2) { - platformTexture.depthCompareFunction = this._depthCompareFunction; - platformTexture.setUseDepthCompareMode(this._useDepthCompareMode); - } + platformTexture.depthCompareFunction = this._depthCompareFunction; + platformTexture.setUseDepthCompareMode(this._useDepthCompareMode); } /** diff --git a/packages/core/src/texture/Texture2DArray.ts b/packages/core/src/texture/Texture2DArray.ts index 332d7319e3..01bfa165a8 100644 --- a/packages/core/src/texture/Texture2DArray.ts +++ b/packages/core/src/texture/Texture2DArray.ts @@ -38,10 +38,6 @@ export class Texture2DArray extends Texture { mipmap: boolean = true, isSRGBColorSpace = true ) { - if (!engine._hardwareRenderer.isWebGL2) { - throw new Error(`Texture2D Array is not supported in WebGL1.0`); - } - super(engine, width, height, format, mipmap, isSRGBColorSpace); this._length = length; diff --git a/packages/core/src/texture/TextureUtils.ts b/packages/core/src/texture/TextureUtils.ts index d217f5c4cd..587af370d1 100644 --- a/packages/core/src/texture/TextureUtils.ts +++ b/packages/core/src/texture/TextureUtils.ts @@ -17,7 +17,6 @@ export class TextureUtils { mipmap: boolean, isSRGBColorSpace: boolean ): boolean { - const isWebGL2 = engine._hardwareRenderer._isWebGL2; if (!mipmap) { return false; } @@ -26,11 +25,7 @@ export class TextureUtils { isSRGBColorSpace = false; } - if (!TextureUtils.supportMipmaps(width, height, isWebGL2)) { - mipmap = false; - } - - return TextureUtils.supportGenerateMipmaps(format, mipmap, isSRGBColorSpace, isWebGL2); + return TextureUtils.supportGenerateMipmaps(format, mipmap, isSRGBColorSpace, true); } static supportSRGB(format: TextureFormat) { @@ -55,18 +50,18 @@ export class TextureUtils { } } - static supportMipmaps(width: number, height, isWebGL2: boolean): boolean { - return isWebGL2 || (MathUtil.isPowerOf2(width) && MathUtil.isPowerOf2(height)); + static supportMipmaps(width: number, height: number, unrestrictedNPOT: boolean): boolean { + return true; } static supportGenerateMipmaps( format: TextureFormat, mipmap: boolean, isSRGBColorSpace: boolean, - isWebGL2: boolean + autoSRGBMipmaps: boolean ): boolean { // Auto generating mipmaps for sRGB textures is only supported in [WebGL2 + RGBA] - if (mipmap && isSRGBColorSpace && !(isWebGL2 && format === TextureFormat.R8G8B8A8)) { + if (mipmap && isSRGBColorSpace && !(format === TextureFormat.R8G8B8A8)) { return false; } diff --git a/packages/loader/src/ktx2/KTX2Loader.ts b/packages/loader/src/ktx2/KTX2Loader.ts index c568346087..853fc2a6cb 100644 --- a/packages/loader/src/ktx2/KTX2Loader.ts +++ b/packages/loader/src/ktx2/KTX2Loader.ts @@ -1,4 +1,5 @@ import { + SystemInfo, AssetPromise, AssetType, ContentRestorer, @@ -144,9 +145,8 @@ export class KTX2Loader extends Loader { ktx2Container: KTX2Container, priorityFormats?: KTX2TargetFormat[] ): KTX2TargetFormat { - const renderer = (engine as any)._hardwareRenderer; const { isSRGB, pixelWidth, pixelHeight } = ktx2Container; - const targetFormat = this._detectSupportedFormat(renderer, priorityFormats!, isSRGB) as KTX2TargetFormat; + const targetFormat = this._detectSupportedFormat(engine, priorityFormats!, isSRGB) as KTX2TargetFormat; if ( targetFormat === KTX2TargetFormat.PVRTC && @@ -164,7 +164,7 @@ export class KTX2Loader extends Loader { } private static _detectSupportedFormat( - renderer: any, + engine: Engine, priorityFormats: KTX2TargetFormat[], isSRGB: boolean ): KTX2TargetFormat | null { @@ -174,7 +174,7 @@ export class KTX2Loader extends Loader { this._capabilityMap[format]?.[isSRGB ? DFDTransferFunction.sRGB : DFDTransferFunction.linear]; if (capabilities) { for (let j = 0; j < capabilities.length; j++) { - if (renderer.canIUse(capabilities[j])) { + if (engine._hardwareRenderer.canIUse(capabilities[j])) { return format; } } @@ -183,8 +183,11 @@ export class KTX2Loader extends Loader { case KTX2TargetFormat.R8G8B8A8: return format; case KTX2TargetFormat.R8: + if (SystemInfo.supportsTextureFormat(engine, TextureFormat.R8)) return format; + break; case KTX2TargetFormat.R8G8: - if (renderer.isWebGL2) return format; + if (SystemInfo.supportsTextureFormat(engine, TextureFormat.R8G8)) return format; + break; } } } diff --git a/packages/rhi-webgl/src/GLBuffer.ts b/packages/rhi-webgl/src/GLBuffer.ts index 04a924cd0b..2d2376292b 100644 --- a/packages/rhi-webgl/src/GLBuffer.ts +++ b/packages/rhi-webgl/src/GLBuffer.ts @@ -9,7 +9,6 @@ export class GLBuffer implements IPlatformBuffer { private _gl: (WebGLRenderingContext & WebGLExtension) | WebGL2RenderingContext; private _glBindTarget: number; private _glBufferUsage: number; - private _isWebGL2: boolean; constructor( rhi: WebGLGraphicDevice, @@ -37,7 +36,6 @@ export class GLBuffer implements IPlatformBuffer { this._glBuffer = glBuffer; this._glBufferUsage = glBufferUsage; this._glBindTarget = glBindTarget; - this._isWebGL2 = rhi.isWebGL2; this.bind(); @@ -76,20 +74,16 @@ export class GLBuffer implements IPlatformBuffer { if (dataOffset !== 0 || dataByteLength < data.byteLength) { const isArrayBufferView = (data).byteOffset !== undefined; - if (this._isWebGL2 && isArrayBufferView) { + if (isArrayBufferView) { gl.bufferSubData( glBindTarget, bufferByteOffset!, - data, + data as ArrayBufferView, dataOffset!, dataByteLength / byteSize ); } else { - const subData = new Uint8Array( - isArrayBufferView ? (data).buffer : data, - dataOffset! * byteSize, - dataByteLength - ); + const subData = new Uint8Array(data as ArrayBuffer, dataOffset!, dataByteLength); gl.bufferSubData(glBindTarget, bufferByteOffset!, subData); } } else { @@ -99,13 +93,9 @@ export class GLBuffer implements IPlatformBuffer { } getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void { - if (this._isWebGL2) { - const gl = this._gl; - this.bind(); - gl.getBufferSubData(this._glBindTarget, bufferByteOffset!, data, dataOffset, dataLength); - } else { - throw "Buffer is write-only on WebGL1.0 platforms."; - } + const gl = this._gl; + this.bind(); + gl.getBufferSubData(this._glBindTarget, bufferByteOffset!, data, dataOffset, dataLength); } copyFromBuffer(srcBuffer: IPlatformBuffer, srcByteOffset: number, dstByteOffset: number, byteLength: number): void { diff --git a/packages/rhi-webgl/src/GLCapability.ts b/packages/rhi-webgl/src/GLCapability.ts index 42fea157a9..2862f1a726 100644 --- a/packages/rhi-webgl/src/GLCapability.ts +++ b/packages/rhi-webgl/src/GLCapability.ts @@ -2,8 +2,6 @@ import { GLCapabilityType } from "@galacean/engine-core"; import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; import { GLCompressedTextureInternalFormat } from "./type"; -type extensionKey = string; - /** * GL capability. */ @@ -39,11 +37,7 @@ export class GLCapability { get maxDrawBuffers() { if (!this._maxDrawBuffers) { - if (this.canIUse(GLCapabilityType.drawBuffers)) { - this._maxDrawBuffers = this._rhi.gl.getParameter(this._rhi.gl.MAX_DRAW_BUFFERS); - } else { - this._maxDrawBuffers = 1; - } + this._maxDrawBuffers = this._rhi.gl.getParameter(this._rhi.gl.MAX_DRAW_BUFFERS); } return this._maxDrawBuffers; } @@ -65,9 +59,7 @@ export class GLCapability { get maxAntiAliasing(): number { if (!this._maxAntiAliasing) { const gl = this._rhi.gl; - const canMSAA = this.canIUse(GLCapabilityType.multipleSample); - - this._maxAntiAliasing = canMSAA ? gl.getParameter(gl.MAX_SAMPLES) : 1; + this._maxAntiAliasing = gl.getParameter(gl.MAX_SAMPLES); } return this._maxAntiAliasing; } @@ -86,7 +78,6 @@ export class GLCapability { this.capabilityList = new Map(); this._init(); - this._compatibleAllInterface(); } /** @@ -146,7 +137,6 @@ export class GLCapability { */ private _init() { const cap = this.capabilityList; - const { isWebGL2 } = this.rhi; const requireExtension = this.rhi.requireExtension.bind(this.rhi); const { @@ -179,7 +169,6 @@ export class GLCapability { textureHalfFloat, textureFloatLinear, textureHalfFloatLinear, - WEBGL_colorBufferFloat, colorBufferFloat, colorBufferHalfFloat, textureFilterAnisotropic, @@ -187,30 +176,32 @@ export class GLCapability { sRGB } = GLCapabilityType; - cap.set(shaderVertexID, isWebGL2); - cap.set(standardDerivatives, isWebGL2 || !!requireExtension(standardDerivatives)); - cap.set(shaderTextureLod, isWebGL2 || !!requireExtension(shaderTextureLod)); - cap.set(elementIndexUint, isWebGL2 || !!requireExtension(elementIndexUint)); - cap.set(depthTexture, isWebGL2 || !!requireExtension(depthTexture)); - cap.set(vertexArrayObject, isWebGL2 || !!requireExtension(vertexArrayObject)); - cap.set(instancedArrays, isWebGL2 || !!requireExtension(instancedArrays)); - cap.set(multipleSample, isWebGL2); - cap.set(drawBuffers, isWebGL2 || !!requireExtension(drawBuffers)); - cap.set(blendMinMax, isWebGL2 || !!requireExtension(blendMinMax)); - cap.set(textureFloat, isWebGL2 || !!requireExtension(textureFloat)); - cap.set(textureHalfFloat, isWebGL2 || !!requireExtension(textureHalfFloat)); + cap.set(shaderVertexID, true); + cap.set(standardDerivatives, true); + cap.set(shaderTextureLod, true); + cap.set(elementIndexUint, true); + cap.set(depthTexture, true); + cap.set(vertexArrayObject, true); + cap.set(instancedArrays, true); + cap.set(multipleSample, true); + cap.set(drawBuffers, true); + cap.set(blendMinMax, true); + cap.set(textureFloat, true); + cap.set(textureHalfFloat, true); cap.set(textureFloatLinear, !!requireExtension(textureFloatLinear)); - cap.set(textureHalfFloatLinear, isWebGL2 || !!requireExtension(textureHalfFloatLinear)); - cap.set( - colorBufferFloat, - (isWebGL2 && !!requireExtension(colorBufferFloat)) || !!requireExtension(WEBGL_colorBufferFloat) - ); - cap.set( - colorBufferHalfFloat, - (isWebGL2 && !!requireExtension(colorBufferFloat)) || !!requireExtension(colorBufferHalfFloat) - ); + cap.set(textureHalfFloatLinear, true); + const floatRenderTarget = !!requireExtension(colorBufferFloat); + cap.set(colorBufferFloat, floatRenderTarget); + cap.set(colorBufferHalfFloat, floatRenderTarget); cap.set(textureFilterAnisotropic, !!requireExtension(textureFilterAnisotropic)); - cap.set(fragDepth, isWebGL2 || !!requireExtension(fragDepth)); + cap.set(fragDepth, true); + const anisotropic = requireExtension(textureFilterAnisotropic); + if (anisotropic) { + const gl = this.rhi.gl as WebGL2RenderingContext & { + TEXTURE_MAX_ANISOTROPY_EXT: number; + }; + gl.TEXTURE_MAX_ANISOTROPY_EXT = anisotropic.TEXTURE_MAX_ANISOTROPY_EXT; + } cap.set(etc, !!(requireExtension(etc) || requireExtension(etc_webkit))); cap.set(etc1, !!(requireExtension(etc1) || requireExtension(etc1_webkit))); @@ -226,103 +217,6 @@ export class GLCapability { typeof astcExtension?.getSupportedProfiles === "function" && astcExtension.getSupportedProfiles().includes("hdr") ); - cap.set(sRGB, isWebGL2 || !!requireExtension(sRGB)); - } - - /** - * If there are extensions that can supplement this ability, smooth out the difference. - * @example - * compatible(GLCapabilityType.depthTexture,{ - * UNSIGNED_INT_24_8: "UNSIGNED_INT_24_8_WEBGL" - * }) - * gl.UNSIGNED_INT_24_8 = ext.UNSIGNED_INT_24_8_WEBGL - */ - private _compatibleInterface(capabilityType: GLCapabilityType, flatItem: { [glKey: string]: extensionKey }) { - const rhi = this.rhi; - const gl = rhi.gl; - const ext = rhi.requireExtension(capabilityType); - - if (ext) { - for (const glKey in flatItem) { - const extensionKey = flatItem[glKey]; - const extensionVal = ext[extensionKey]; - - // Mini game hack the native function,use “.bind” to smooth out if is “Funcion”. - if (extensionVal?.bind) { - gl[glKey] = extensionVal.bind(ext); - } else { - gl[glKey] = extensionVal; - } - } - } - } - - private _compatibleAllInterface() { - const { - depthTexture, - vertexArrayObject, - instancedArrays, - drawBuffers, - textureFilterAnisotropic, - textureHalfFloat, - colorBufferHalfFloat, - WEBGL_colorBufferFloat, - blendMinMax, - sRGB - } = GLCapabilityType; - const { isWebGL2 } = this.rhi; - - if (!isWebGL2) { - this._compatibleInterface(blendMinMax, { - MIN: "MIN_EXT", - MAX: "MAX_EXT" - }); - this._compatibleInterface(depthTexture, { - UNSIGNED_INT_24_8: "UNSIGNED_INT_24_8_WEBGL" - }); - this._compatibleInterface(vertexArrayObject, { - createVertexArray: "createVertexArrayOES", - deleteVertexArray: "deleteVertexArrayOES", - isVertexArray: "isVertexArrayOES", - bindVertexArray: "bindVertexArrayOES" - }); - this._compatibleInterface(instancedArrays, { - drawArraysInstanced: "drawArraysInstancedANGLE", - drawElementsInstanced: "drawElementsInstancedANGLE", - vertexAttribDivisor: "vertexAttribDivisorANGLE" - }); - this._compatibleInterface(drawBuffers, { - MAX_DRAW_BUFFERS: "MAX_DRAW_BUFFERS_WEBGL" - }); - const items = {}; - if (this.canIUse(GLCapabilityType.drawBuffers)) { - const maxDrawBuffers = this.maxDrawBuffers; - for (let i = 0; i < maxDrawBuffers; i++) { - i != 0 && (items[`COLOR_ATTACHMENT${i}`] = `COLOR_ATTACHMENT${i}_WEBGL`); - items[`DRAW_BUFFER${i}`] = `DRAW_BUFFER${i}_WEBGL`; - } - this._compatibleInterface(drawBuffers, { - drawBuffers: "drawBuffersWEBGL", - ...items - }); - } - this._compatibleInterface(textureHalfFloat, { - HALF_FLOAT: "HALF_FLOAT_OES" - }); - this._compatibleInterface(colorBufferHalfFloat, { - RGBA16F: "RBGA16F_EXT" - }); - this._compatibleInterface(WEBGL_colorBufferFloat, { - RGBA32F: "RBGA32F_EXT" - }); - this._compatibleInterface(sRGB, { - SRGB8: "SRGB_EXT", - SRGB8_ALPHA8: "SRGB_ALPHA_EXT" - }); - } - - this._compatibleInterface(textureFilterAnisotropic, { - TEXTURE_MAX_ANISOTROPY_EXT: "TEXTURE_MAX_ANISOTROPY_EXT" - }); + cap.set(sRGB, true); } } diff --git a/packages/rhi-webgl/src/GLPrimitive.ts b/packages/rhi-webgl/src/GLPrimitive.ts index 9f8992fb94..053039163f 100644 --- a/packages/rhi-webgl/src/GLPrimitive.ts +++ b/packages/rhi-webgl/src/GLPrimitive.ts @@ -1,4 +1,4 @@ -import { GLCapabilityType, Logger, Primitive } from "@galacean/engine-core"; +import { Logger, Primitive } from "@galacean/engine-core"; import { SubPrimitive } from "@galacean/engine-core/types/graphic/SubPrimitive"; import { IPlatformPrimitive, IPlatformShaderProgram } from "@galacean/engine-design"; import { GLBuffer } from "./GLBuffer"; @@ -17,16 +17,12 @@ import { WebGLExtension } from "./type"; export class GLPrimitive implements IPlatformPrimitive { private _attribLocArray: number[] = []; private readonly _primitive: Primitive; - private readonly _canUseInstancedArrays: boolean; private _gl: (WebGLRenderingContext & WebGLExtension) | WebGL2RenderingContext; private _vaoMap: Map = new Map(); - private readonly _isSupportVAO: boolean; constructor(rhi: WebGLGraphicDevice, primitive: Primitive) { this._primitive = primitive; - this._canUseInstancedArrays = rhi.canIUse(GLCapabilityType.instancedArrays); - this._isSupportVAO = rhi.canIUse(GLCapabilityType.vertexArrayObject); this._gl = rhi.gl; } @@ -36,7 +32,7 @@ export class GLPrimitive implements IPlatformPrimitive { draw(shaderProgram: IPlatformShaderProgram, subMesh: SubPrimitive): void { const gl = this._gl; const primitive = this._primitive; - const useVao = this._isSupportVAO && primitive.enableVAO; + const useVao = primitive.enableVAO; if (useVao) { if (primitive._bufferStructChanged) { @@ -68,21 +64,17 @@ export class GLPrimitive implements IPlatformPrimitive { gl.drawArrays(topology, start, count); } } else { - if (this._canUseInstancedArrays) { - if (indexBufferBinding) { - if (useVao) { - gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); - } else { - const { _glBuffer } = indexBufferBinding.buffer._platformBuffer; - gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, _glBuffer); - gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); - gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, null); - } + if (indexBufferBinding) { + if (useVao) { + gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); } else { - gl.drawArraysInstanced(topology, start, count, instanceCount); + const { _glBuffer } = indexBufferBinding.buffer._platformBuffer; + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, _glBuffer); + gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, null); } } else { - Logger.error("ANGLE_instanced_arrays extension is not supported"); + gl.drawArraysInstanced(topology, start, count, instanceCount); } } @@ -95,7 +87,7 @@ export class GLPrimitive implements IPlatformPrimitive { } destroy(): void { - this._isSupportVAO && this._clearVAO(); + this._clearVAO(); } /** @@ -130,9 +122,7 @@ export class GLPrimitive implements IPlatformPrimitive { gl.enableVertexAttribArray(loc); const elementInfo = element._formatMetaInfo; gl.vertexAttribPointer(loc, elementInfo.size, elementInfo.type, elementInfo.normalized, stride, element.offset); - if (this._canUseInstancedArrays) { - gl.vertexAttribDivisor(loc, element.instanceStepRate); - } + gl.vertexAttribDivisor(loc, element.instanceStepRate); this._attribLocArray.push(loc); } else { Logger.warn("vertex attribute not found: " + name); diff --git a/packages/rhi-webgl/src/GLRenderTarget.ts b/packages/rhi-webgl/src/GLRenderTarget.ts index 2c4036a7b2..a171393a4e 100644 --- a/packages/rhi-webgl/src/GLRenderTarget.ts +++ b/packages/rhi-webgl/src/GLRenderTarget.ts @@ -15,7 +15,7 @@ import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; */ export class GLRenderTarget implements IPlatformRenderTarget { private _gl: WebGLRenderingContext & WebGL2RenderingContext; - private _isWebGL2: boolean; + private _rhi: WebGLGraphicDevice; private _target: RenderTarget; private _frameBuffer: WebGLFramebuffer | null; private _MSAAFrameBuffer: WebGLFramebuffer | null; @@ -32,7 +32,7 @@ export class GLRenderTarget implements IPlatformRenderTarget { */ constructor(rhi: WebGLGraphicDevice, target: RenderTarget) { this._gl = rhi.gl as WebGLRenderingContext & WebGL2RenderingContext; - this._isWebGL2 = rhi.isWebGL2; + this._rhi = rhi; this._target = target; /** @ts-ignore */ @@ -58,10 +58,6 @@ export class GLRenderTarget implements IPlatformRenderTarget { throw new Error(`TextureFormat is not supported:${TextureFormat[_depth]} in RenderTarget`); } - if (_colorTextures.length > 1 && !rhi.canIUse(GLCapabilityType.drawBuffers)) { - throw new Error("MRT is not supported"); - } - if (_colorTextures.some((v: Texture) => v.width !== width || v.height !== height)) { throw new Error("ColorTexture's size must as same as RenderTarget"); } @@ -131,7 +127,7 @@ export class GLRenderTarget implements IPlatformRenderTarget { } else { if (mipChanged) { // @ts-ignore - const { internalFormat } = GLTexture._getRenderBufferDepthFormatDetail(target._depth, gl, this._isWebGL2); + const { internalFormat } = GLTexture._getRenderBufferDepthFormatDetail(target._depth, gl, this._rhi); gl.bindRenderbuffer(gl.RENDERBUFFER, this._depthRenderBuffer); gl.renderbufferStorage(gl.RENDERBUFFER, internalFormat, target.width >> mipLevel, target.height >> mipLevel); } @@ -197,7 +193,6 @@ export class GLRenderTarget implements IPlatformRenderTarget { private _bindMainFBO(): void { const gl = this._gl; - const isWebGL2: boolean = this._isWebGL2; const { _depth, colorTextureCount, width, height } = this._target; const drawBuffers = new Array(colorTextureCount); @@ -241,7 +236,7 @@ export class GLRenderTarget implements IPlatformRenderTarget { ); } } else if (this._target.antiAliasing <= 1) { - const { internalFormat, attachment } = GLTexture._getRenderBufferDepthFormatDetail(_depth, gl, isWebGL2); + const { internalFormat, attachment } = GLTexture._getRenderBufferDepthFormatDetail(_depth, gl, this._rhi); this._depthRenderBuffer = this._createRenderBuffer(internalFormat, attachment!); } } @@ -252,7 +247,6 @@ export class GLRenderTarget implements IPlatformRenderTarget { private _bindMSAAFBO(): void { const gl = this._gl; - const isWebGL2 = this._isWebGL2; const { _depth, colorTextureCount } = this._target; @@ -276,7 +270,7 @@ export class GLRenderTarget implements IPlatformRenderTarget { const { internalFormat, attachment } = _depth instanceof Texture ? (_depth._platformTexture as GLTexture)._formatDetail - : GLTexture._getRenderBufferDepthFormatDetail(_depth, gl, isWebGL2); + : GLTexture._getRenderBufferDepthFormatDetail(_depth, gl, this._rhi); this._MSAADepthRenderBuffer = this._createRenderBuffer(internalFormat, attachment!); } diff --git a/packages/rhi-webgl/src/GLTexture.ts b/packages/rhi-webgl/src/GLTexture.ts index bd8c6a6b40..8306006828 100644 --- a/packages/rhi-webgl/src/GLTexture.ts +++ b/packages/rhi-webgl/src/GLTexture.ts @@ -11,7 +11,6 @@ import { TextureUtils, TextureWrapMode } from "@galacean/engine-core"; -import { MathUtil } from "@galacean/engine-math"; import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; import { GLCompressedTextureInternalFormat, TextureFormatDetail } from "./type"; @@ -27,22 +26,22 @@ export class GLTexture implements IPlatformTexture { format: TextureFormat, isSRGBColorSpace: boolean, gl: WebGLRenderingContext & WebGL2RenderingContext, - isWebGL2: boolean + rhi: WebGLGraphicDevice ): TextureFormatDetail { switch (format) { case TextureFormat.R8G8B8: return { - internalFormat: isSRGBColorSpace ? gl.SRGB8 : isWebGL2 ? gl.RGB8 : gl.RGB, - baseFormat: isSRGBColorSpace ? (isWebGL2 ? gl.RGB : gl.SRGB8) : gl.RGB, - readFormat: isWebGL2 ? gl.RGBA : gl.RGB, + internalFormat: isSRGBColorSpace ? gl.SRGB8 : gl.RGB8, + baseFormat: gl.RGB, + readFormat: gl.RGBA, dataType: gl.UNSIGNED_BYTE, isCompressed: false, alignment: 1 }; case TextureFormat.R8G8B8A8: return { - internalFormat: isSRGBColorSpace ? gl.SRGB8_ALPHA8 : isWebGL2 ? gl.RGBA8 : gl.RGBA, - baseFormat: isSRGBColorSpace ? (isWebGL2 ? gl.RGBA : gl.SRGB8_ALPHA8) : gl.RGBA, + internalFormat: isSRGBColorSpace ? gl.SRGB8_ALPHA8 : gl.RGBA8, + baseFormat: gl.RGBA, readFormat: gl.RGBA, dataType: gl.UNSIGNED_BYTE, isCompressed: false, @@ -50,7 +49,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.R4G4B4A4: return { - internalFormat: isWebGL2 ? gl.RGBA4 : gl.RGBA, + internalFormat: gl.RGBA4, baseFormat: gl.RGBA, dataType: gl.UNSIGNED_SHORT_4_4_4_4, isCompressed: false, @@ -58,7 +57,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.R5G5B5A1: return { - internalFormat: isWebGL2 ? gl.RGB5_A1 : gl.RGBA, + internalFormat: gl.RGB5_A1, baseFormat: gl.RGBA, dataType: gl.UNSIGNED_SHORT_5_5_5_1, isCompressed: false, @@ -66,7 +65,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.R5G6B5: return { - internalFormat: isWebGL2 ? gl.RGB565 : gl.RGB, + internalFormat: gl.RGB565, baseFormat: gl.RGB, dataType: gl.UNSIGNED_SHORT_5_6_5, isCompressed: false, @@ -90,7 +89,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.R16G16B16A16: return { - internalFormat: isWebGL2 ? gl.RGBA16F : gl.RGBA, + internalFormat: gl.RGBA16F, baseFormat: gl.RGBA, dataType: gl.HALF_FLOAT, isCompressed: false, @@ -98,7 +97,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.R32G32B32A32: return { - internalFormat: isWebGL2 ? gl.RGBA32F : gl.RGBA, + internalFormat: gl.RGBA32F, baseFormat: gl.RGBA, dataType: gl.FLOAT, isCompressed: false, @@ -258,23 +257,23 @@ export class GLTexture implements IPlatformTexture { case TextureFormat.Depth: return { - internalFormat: isWebGL2 ? gl.DEPTH_COMPONENT32F : gl.DEPTH_COMPONENT, + internalFormat: gl.DEPTH_COMPONENT32F, baseFormat: gl.DEPTH_COMPONENT, - dataType: isWebGL2 ? gl.FLOAT : gl.UNSIGNED_SHORT, + dataType: gl.FLOAT, isCompressed: false, attachment: gl.DEPTH_ATTACHMENT }; case TextureFormat.DepthStencil: return { - internalFormat: isWebGL2 ? gl.DEPTH32F_STENCIL8 : gl.DEPTH_STENCIL, + internalFormat: gl.DEPTH32F_STENCIL8, baseFormat: gl.DEPTH_STENCIL, - dataType: isWebGL2 ? gl.FLOAT_32_UNSIGNED_INT_24_8_REV : gl.UNSIGNED_INT_24_8, + dataType: gl.FLOAT_32_UNSIGNED_INT_24_8_REV, isCompressed: false, attachment: gl.DEPTH_STENCIL_ATTACHMENT }; case TextureFormat.Depth16: return { - internalFormat: isWebGL2 ? gl.DEPTH_COMPONENT16 : gl.DEPTH_COMPONENT, + internalFormat: gl.DEPTH_COMPONENT16, baseFormat: gl.DEPTH_COMPONENT, dataType: gl.UNSIGNED_SHORT, isCompressed: false, @@ -282,7 +281,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.Depth24Stencil8: return { - internalFormat: isWebGL2 ? gl.DEPTH24_STENCIL8 : gl.DEPTH_STENCIL, + internalFormat: gl.DEPTH24_STENCIL8, baseFormat: gl.DEPTH_STENCIL, dataType: gl.UNSIGNED_INT_24_8, isCompressed: false, @@ -327,22 +326,22 @@ export class GLTexture implements IPlatformTexture { static _getRenderBufferDepthFormatDetail( format: TextureFormat, gl: WebGLRenderingContext & WebGL2RenderingContext, - isWebGL2: boolean + rhi: WebGLGraphicDevice ): TextureFormatDetail { switch (format) { case TextureFormat.Depth: return { - internalFormat: isWebGL2 ? gl.DEPTH_COMPONENT32F : gl.DEPTH_COMPONENT16, + internalFormat: gl.DEPTH_COMPONENT32F, baseFormat: gl.DEPTH_COMPONENT, - dataType: isWebGL2 ? gl.FLOAT : gl.UNSIGNED_SHORT, + dataType: gl.FLOAT, isCompressed: false, attachment: gl.DEPTH_ATTACHMENT }; case TextureFormat.DepthStencil: return { - internalFormat: isWebGL2 ? gl.DEPTH32F_STENCIL8 : gl.DEPTH_STENCIL, + internalFormat: gl.DEPTH32F_STENCIL8, baseFormat: gl.DEPTH_STENCIL, - dataType: isWebGL2 ? gl.FLOAT_32_UNSIGNED_INT_24_8_REV : gl.UNSIGNED_INT_24_8, + dataType: gl.FLOAT_32_UNSIGNED_INT_24_8_REV, isCompressed: false, attachment: gl.DEPTH_STENCIL_ATTACHMENT }; @@ -364,7 +363,7 @@ export class GLTexture implements IPlatformTexture { }; case TextureFormat.Depth24Stencil8: return { - internalFormat: isWebGL2 ? gl.DEPTH24_STENCIL8 : gl.DEPTH_STENCIL, + internalFormat: gl.DEPTH24_STENCIL8, baseFormat: gl.DEPTH_STENCIL, dataType: gl.UNSIGNED_INT_24_8, isCompressed: false, @@ -424,7 +423,7 @@ export class GLTexture implements IPlatformTexture { case TextureFormat.R11G11B10_UFloat: { - isSupported = rhi.isWebGL2; + isSupported = true; } break; } @@ -436,15 +435,6 @@ export class GLTexture implements IPlatformTexture { * @internal */ static _supportRenderBufferDepthFormat(format: TextureFormat, rhi: WebGLGraphicDevice): boolean { - if (!rhi.isWebGL2) { - switch (format) { - case TextureFormat.Depth24: - case TextureFormat.Depth32: - case TextureFormat.Depth32Stencil8: - return false; - } - } - return true; } @@ -457,7 +447,6 @@ export class GLTexture implements IPlatformTexture { /** @internal */ _gl: WebGLRenderingContext & WebGL2RenderingContext; /** @internal */ - _isWebGL2: boolean; /** @internal */ _target: GLenum; // gl.TEXTURE_2D | gl.TEXTURE_CUBE_MAP /** @internal */ @@ -552,7 +541,6 @@ export class GLTexture implements IPlatformTexture { this._texture = texture; this._rhi = rhi; this._gl = rhi.gl as WebGLRenderingContext & WebGL2RenderingContext; - this._isWebGL2 = rhi.isWebGL2; this._target = target; this._glTexture = this._gl.createTexture(); } @@ -582,7 +570,7 @@ export class GLTexture implements IPlatformTexture { const texture = this._texture; const mipmap = texture._mipmap; - if (!TextureUtils.supportGenerateMipmaps(texture.format, mipmap, texture.isSRGBColorSpace, this._isWebGL2)) { + if (!TextureUtils.supportGenerateMipmaps(texture.format, mipmap, texture.isSRGBColorSpace, true)) { Logger.warn( "Auto-generating mipmaps for sRGB textures is only supported in [WebGL2 + R8G8B8A8], you must generate mipmaps manually." ); @@ -605,13 +593,12 @@ export class GLTexture implements IPlatformTexture { */ protected _init(isCube: boolean): void { const gl = this._gl; - const isWebGL2 = this._isWebGL2; const { internalFormat, baseFormat, dataType } = this._formatDetail; const { mipmapCount, width, height, usage, _isDepthTexture } = this._texture; this._bind(); - if (isWebGL2 && !(baseFormat === gl.LUMINANCE_ALPHA || baseFormat === gl.ALPHA) && usage !== TextureUsage.Dynamic) { + if (!(baseFormat === gl.LUMINANCE_ALPHA || baseFormat === gl.ALPHA) && usage !== TextureUsage.Dynamic) { gl.texStorage2D(this._target, mipmapCount, internalFormat, width, height); } else { if (!isCube) { @@ -669,11 +656,6 @@ export class GLTexture implements IPlatformTexture { gl.bindFramebuffer(gl.FRAMEBUFFER, this._getReadFrameBuffer()); - if (mipLevel > 0 && !this._isWebGL2) { - mipLevel = 0; - Logger.error("mipLevel only take effect in WebGL2.0"); - } - if (face != null) { gl.framebufferTexture2D( gl.FRAMEBUFFER, @@ -712,34 +694,13 @@ export class GLTexture implements IPlatformTexture { // @ts-ignore texture._isSRGBColorSpace = false; } - - const isWebGL2 = rhi.isWebGL2; - - // Validate mipmap - const mipmap = texture._mipmap; - if (mipmap && !TextureUtils.supportMipmaps(width, height, isWebGL2)) { - Logger.warn( - "Non-power-2 texture is not supported for mipmap in WebGL1, and has automatically downgraded to non-mipmap" - ); - texture._mipmap = false; - /** @ts-ignore */ - texture._mipmapCount = texture._getMipmapCount(); - } } private _setWrapMode(value: TextureWrapMode, pname: GLenum): void { const gl = this._gl; - const isWebGL2 = this._isWebGL2; const target = this._target; const { width, height } = this._texture; - if (!isWebGL2 && value !== TextureWrapMode.Clamp && (!MathUtil.isPowerOf2(width) || !MathUtil.isPowerOf2(height))) { - Logger.warn( - "non-power-2 texture is not supported for REPEAT or MIRRORED_REPEAT in WebGL1,and has automatically downgraded to CLAMP_TO_EDGE" - ); - value = TextureWrapMode.Clamp; - } - switch (value) { case TextureWrapMode.Clamp: gl.texParameteri(target, pname, gl.CLAMP_TO_EDGE); diff --git a/packages/rhi-webgl/src/GLTexture2D.ts b/packages/rhi-webgl/src/GLTexture2D.ts index 2568d62165..6d4aba52d1 100644 --- a/packages/rhi-webgl/src/GLTexture2D.ts +++ b/packages/rhi-webgl/src/GLTexture2D.ts @@ -6,18 +6,14 @@ import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; * Texture 2d in WebGL platform. */ export class GLTexture2D extends GLTexture implements IPlatformTexture2D { - /** Backward compatible with WebGL1.0. */ - private _compressedMipFilled: number = 0; - constructor(rhi: WebGLGraphicDevice, texture2D: Texture2D) { super(rhi, texture2D, rhi.gl.TEXTURE_2D); this._validate(texture2D, rhi); const { format, isSRGBColorSpace } = texture2D; - const isWebGL2 = this._isWebGL2; - this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, isWebGL2); - (this._formatDetail.isCompressed && !isWebGL2) || this._init(false); + this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, rhi); + this._init(false); } /** @@ -43,15 +39,8 @@ export class GLTexture2D extends GLTexture implements IPlatformTexture2D { this._bind(); if (formatDetail.isCompressed) { - const isWebGL2 = this._isWebGL2; const { internalFormat } = formatDetail; - const mipBit = 1 << mipLevel; - if (isWebGL2 || this._compressedMipFilled & mipBit) { - gl.compressedTexSubImage2D(this._target, mipLevel, x, y, width, height, internalFormat, colorBuffer); - } else { - gl.compressedTexImage2D(this._target, mipLevel, internalFormat, width, height, 0, colorBuffer); - this._compressedMipFilled |= mipBit; - } + gl.compressedTexSubImage2D(this._target, mipLevel, x, y, width, height, internalFormat, colorBuffer); } else { const { baseFormat, dataType } = formatDetail; gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, 0); diff --git a/packages/rhi-webgl/src/GLTexture2DArray.ts b/packages/rhi-webgl/src/GLTexture2DArray.ts index ba33336484..6f0bc9d43e 100644 --- a/packages/rhi-webgl/src/GLTexture2DArray.ts +++ b/packages/rhi-webgl/src/GLTexture2DArray.ts @@ -13,7 +13,7 @@ export class GLTexture2DArray extends GLTexture implements IPlatformTexture2DArr const { format, width, height, length, mipmapCount, isSRGBColorSpace } = texture2DArray; this._bind(); - this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, true); + this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, rhi); this._gl.texStorage3D(this._target, mipmapCount, this._formatDetail.internalFormat, width, height, length); } diff --git a/packages/rhi-webgl/src/GLTextureCube.ts b/packages/rhi-webgl/src/GLTextureCube.ts index 3a96027161..99e45fd020 100644 --- a/packages/rhi-webgl/src/GLTextureCube.ts +++ b/packages/rhi-webgl/src/GLTextureCube.ts @@ -6,18 +6,14 @@ import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; * Cube texture in WebGL platform. */ export class GLTextureCube extends GLTexture implements IPlatformTextureCube { - /** Backward compatible with WebGL1.0. */ - private _compressedFaceFilled: number[] = [0, 0, 0, 0, 0, 0]; - constructor(rhi: WebGLGraphicDevice, textureCube: TextureCube) { super(rhi, textureCube, rhi.gl.TEXTURE_CUBE_MAP); this._validate(textureCube, rhi); const { format, isSRGBColorSpace } = textureCube; - const isWebGL2 = this._isWebGL2; - this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, isWebGL2); - (this._formatDetail.isCompressed && !isWebGL2) || this._init(true); + this._formatDetail = GLTexture._getFormatDetail(format, isSRGBColorSpace, this._gl, rhi); + this._init(true); } /** @@ -33,7 +29,6 @@ export class GLTextureCube extends GLTexture implements IPlatformTextureCube { height?: number ): void { const gl = this._gl; - const isWebGL2 = this._isWebGL2; const formatDetail = this._formatDetail; const { internalFormat, baseFormat, dataType, isCompressed } = formatDetail; const mipSize = Math.max(1, this._texture.width >> mipLevel); @@ -44,30 +39,16 @@ export class GLTextureCube extends GLTexture implements IPlatformTextureCube { this._bind(); if (isCompressed) { - const mipBit = 1 << mipLevel; - if (isWebGL2 || this._compressedFaceFilled[face] & mipBit) { - gl.compressedTexSubImage2D( - gl.TEXTURE_CUBE_MAP_POSITIVE_X + face, - mipLevel, - x, - y, - width, - height, - internalFormat, - colorBuffer - ); - } else { - gl.compressedTexImage2D( - gl.TEXTURE_CUBE_MAP_POSITIVE_X + face, - mipLevel, - internalFormat, - width, - height, - 0, - colorBuffer - ); - this._compressedFaceFilled[face] |= mipBit; - } + gl.compressedTexSubImage2D( + gl.TEXTURE_CUBE_MAP_POSITIVE_X + face, + mipLevel, + x, + y, + width, + height, + internalFormat, + colorBuffer + ); } else { gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, 0); gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, 0); diff --git a/packages/rhi-webgl/src/WebGLEngine.ts b/packages/rhi-webgl/src/WebGLEngine.ts index 8edd65b963..81bcc3079f 100644 --- a/packages/rhi-webgl/src/WebGLEngine.ts +++ b/packages/rhi-webgl/src/WebGLEngine.ts @@ -1,5 +1,52 @@ -import { Engine, EngineConfiguration, Scene } from "@galacean/engine-core"; -import { WebGLGraphicDevice, WebGLGraphicDeviceOptions } from "./"; +import { + Engine, + EngineConfiguration, + Scene, + ShaderPass, + ShaderMacro, + ShaderFactory, + BasicRenderPipeline, + Camera, + CameraClearFlags, + MeshRenderer, + Texture, + Texture2D, + TextureUtils, + TextureFormat, + TextureFilterMode, + TextureWrapMode, + SystemInfo, + PrimitiveMesh, + BlendOperation, + Logger, + GLCapabilityType, + ParticleGenerator, + ParticleRenderer, + NoiseModule, + LimitVelocityOverLifetimeModule, + VelocityOverLifetimeModule, + SubEmittersModule, + InheritVelocityModule, + ParticleInheritVelocityMode, + BlendState, + CascadedShadowCasterPass, + ShaderProgram, + BasicResources, + FontAtlas, + DepthOnlyPass, + ShaderMacroProcessor, + PipelineUtils +} from "@galacean/engine-core"; +import { MathUtil } from "@galacean/engine-math"; +import { GLPrimitive } from "./GLPrimitive"; +import { GLCapability } from "./GLCapability"; +import { GLExtensions } from "./GLExtensions"; +import { GLRenderStates } from "./GLRenderStates"; +import { GLTexture } from "./GLTexture"; +import { GLTexture2D } from "./GLTexture2D"; +import { GLTextureCube } from "./GLTextureCube"; +import { WebGLGraphicDevice } from "./WebGLGraphicDevice"; +import type { WebGLGraphicDeviceOptions } from "./WebGLGraphicDevice"; import { WebCanvas } from "./WebCanvas"; /** @@ -12,16 +59,51 @@ export class WebGLEngine extends Engine { * @returns A promise that will resolve when the engine is created */ static create(configuration: WebGLEngineConfiguration): Promise { - const canvas = configuration.canvas; - const webCanvas = new WebCanvas(typeof canvas === "string" ? document.getElementById(canvas) : canvas); - const webGLGraphicDevice = new WebGLGraphicDevice(configuration.graphicDeviceOptions); - const engine = new WebGLEngine(webCanvas, webGLGraphicDevice, configuration); - webCanvas.setAutoResolution(); - const promise = engine._initialize(configuration) as Promise; - return promise.then(() => { - engine.sceneManager.addScene(new Scene(engine, "DefaultScene")); - return engine; - }); + try { + const canvas = configuration.canvas; + const webCanvas = new WebCanvas(typeof canvas === "string" ? document.getElementById(canvas) : canvas); + const device = new WebGLGraphicDevice(configuration.graphicDeviceOptions); + const gl = device._getWebGL2Context(webCanvas); + if (gl?.deleteQuery) { + device._setContext(webCanvas._webCanvas, gl); + return WebGLEngine._createWithContext(webCanvas, device, configuration); + } + return loadRendererFallback().then((polyfill) => { + polyfill(device, webCanvas); + return WebGLEngine._createWithContext(webCanvas, device, configuration); + }); + } catch (error) { + return Promise.reject(error); + } + } + + private static _createWithContext( + canvas: WebCanvas, + device: WebGLGraphicDevice, + configuration: WebGLEngineConfiguration + ): Promise { + let engine: WebGLEngine | undefined; + try { + const created = (engine = new WebGLEngine(canvas, device, configuration)); + canvas.setAutoResolution(); + return created + ._initialize(configuration) + .then(() => { + created.sceneManager.addScene(new Scene(created, "DefaultScene")); + return created; + }) + .catch((error) => { + created.destroy(); + throw error; + }); + } catch (error) { + if (engine) { + engine.destroy(); + } else { + device.destroy(); + } + return Promise.reject(error); + } } /** @@ -41,3 +123,72 @@ export interface WebGLEngineConfiguration extends EngineConfiguration { /** Graphic device options. */ graphicDeviceOptions?: WebGLGraphicDeviceOptions; } + +// Update the CDN pin when the compatibility package integration changes. +const fallbackModuleURL = `https://cdn.jsdelivr.net/npm/@galacean/engine-webgl1-polyfill@2.0.0-alpha.57/dist/module.js`; +let pendingFallback: Promise<(device: WebGLGraphicDevice, canvas: WebCanvas) => void> | undefined; +let fallbackRetry = 0; + +function loadRendererFallback() { + if (!pendingFallback) { + const url = fallbackRetry ? fallbackModuleURL + "?retry=" + fallbackRetry : fallbackModuleURL; + pendingFallback = import(/* @vite-ignore */ url) + .then((module) => { + if (typeof module.bind !== "function") { + throw new Error("Invalid renderer fallback module."); + } + return module.bind({ + Engine, + ShaderPass, + ShaderMacro, + ShaderFactory, + BasicRenderPipeline, + Camera, + CameraClearFlags, + MeshRenderer, + Texture, + Texture2D, + TextureUtils, + TextureFormat, + TextureFilterMode, + TextureWrapMode, + SystemInfo, + PrimitiveMesh, + BlendOperation, + Logger, + GLCapabilityType, + ParticleGenerator, + ParticleRenderer, + NoiseModule, + LimitVelocityOverLifetimeModule, + VelocityOverLifetimeModule, + SubEmittersModule, + InheritVelocityModule, + ParticleInheritVelocityMode, + GLPrimitive, + GLCapability, + GLExtensions, + GLRenderStates, + GLTexture, + GLTexture2D, + GLTextureCube, + MathUtil, + WebGLGraphicDevice, + BlendState, + CascadedShadowCasterPass, + ShaderProgram, + BasicResources, + FontAtlas, + DepthOnlyPass, + ShaderMacroProcessor, + PipelineUtils + }); + }) + .catch((cause: unknown) => { + pendingFallback = undefined; + fallbackRetry++; + throw new Error("Could not load renderer fallback.", { cause }); + }); + } + return pendingFallback; +} diff --git a/packages/rhi-webgl/src/WebGLGraphicDevice.ts b/packages/rhi-webgl/src/WebGLGraphicDevice.ts index 1545662181..33320fbabb 100644 --- a/packages/rhi-webgl/src/WebGLGraphicDevice.ts +++ b/packages/rhi-webgl/src/WebGLGraphicDevice.ts @@ -41,25 +41,10 @@ import { GLTransformFeedbackPrimitive } from "./GLTransformFeedbackPrimitive"; import { WebCanvas } from "./WebCanvas"; import { WebGLExtension } from "./type"; -/** - * WebGL mode. - */ -export enum WebGLMode { - /** Auto, use WebGL2.0 if support, or will fallback to WebGL1.0. */ - Auto = 0, - /** WebGL2.0. */ - WebGL2 = 1, - /** WebGL1.0, */ - WebGL1 = 2 -} - /** * WebGL graphic device options. */ export interface WebGLGraphicDeviceOptions { - /** WebGL mode.*/ - webGLMode?: WebGLMode; - /** * @internal * iOS 15 webgl implement has bug, maybe should force call flush command buffer, for example iPhone13(iOS 15.4.1). @@ -111,6 +96,7 @@ export class WebGLGraphicDevice implements IHardwareRenderer { private _extensions; private _capability: GLCapability; private _isWebGL2: boolean; + private _contextPrepared = false; private _renderer: string; private _webCanvas: HTMLCanvasElement | OffscreenCanvas; @@ -155,7 +141,6 @@ export class WebGLGraphicDevice implements IHardwareRenderer { constructor(initializeOptions: WebGLGraphicDeviceOptions = {}) { const options = { - webGLMode: WebGLMode.Auto, _forceFlush: false, _maxAllowSkinUniformVectorCount: 256, alpha: true, @@ -202,7 +187,15 @@ export class WebGLGraphicDevice implements IHardwareRenderer { init(canvas: Canvas, onDeviceLost: () => void, onDeviceRestored: () => void): void { const webCanvas = (canvas as WebCanvas)._webCanvas; - const webGLMode = this._options.webGLMode; + if (!this._contextPrepared || this._webCanvas !== webCanvas) { + const gl2 = this._getWebGL2Context(canvas as WebCanvas); + if (gl2?.deleteQuery) { + this._setContext(webCanvas, gl2, true); + } else { + throw new Error("WebGL2 is unavailable. Use WebGLEngine.create() to load a renderer fallback."); + } + } + this._contextPrepared = false; this._onDeviceLost = onDeviceLost; this._onDeviceRestored = onDeviceRestored; @@ -210,39 +203,48 @@ export class WebGLGraphicDevice implements IHardwareRenderer { webCanvas.addEventListener("webglcontextrestored", this._onWebGLContextRestored, false); webCanvas.addEventListener("webglcontextcreationerror", this._onContextCreationError, false); - this._webCanvas = webCanvas; - - const webGLOptions = this._webGLOptions; - let gl: (WebGLRenderingContext & WebGLExtension) | WebGL2RenderingContext | undefined; - if (webGLMode == WebGLMode.Auto || webGLMode == WebGLMode.WebGL2) { - gl = webCanvas.getContext("webgl2", webGLOptions); - if (!gl && !(canvas as WebCanvas)._isOffscreenCanvas()) { - gl = webCanvas.getContext("experimental-webgl2", webGLOptions); - } - this._isWebGL2 = true; - - // Prevent weird browsers to lie (such as safari!)ƒ - if (gl && !(gl).deleteQuery) { - this._isWebGL2 = false; - } - } - - if (!gl) { - if (webGLMode == WebGLMode.Auto || webGLMode == WebGLMode.WebGL1) { - gl = webCanvas.getContext("webgl", webGLOptions); - if (!gl && !(canvas as WebCanvas)._isOffscreenCanvas()) { - gl = webCanvas.getContext("experimental-webgl", webGLOptions); - } - this._isWebGL2 = false; - } + try { + this._initGLState(this._gl); + } catch (error) { + this.destroy(); + throw error; } - - if (!gl) { - throw new Error("Get GL Context FAILED."); + } + /** @internal */ + _getWebGL2Context(canvas: WebCanvas): WebGL2RenderingContext | null { + const nativeCanvas = canvas._webCanvas; + return ( + nativeCanvas.getContext("webgl2", this._webGLOptions) || + (!canvas._isOffscreenCanvas() + ? (nativeCanvas.getContext("experimental-webgl2", this._webGLOptions) as WebGL2RenderingContext | null) + : null) + ); + } + /** @internal */ + _setContext(canvas: HTMLCanvasElement | OffscreenCanvas, gl: WebGL2RenderingContext, isWebGL2 = true): void { + this._webCanvas = canvas; + this._gl = gl; + this._isWebGL2 = isWebGL2; + this._contextPrepared = true; + } + /** @internal */ + _createXRLayer(session: XRSession, scaleFactor: number): XRWebGLLayer { + if (session.renderState.layers === undefined) { + const attributes = this._gl.getContextAttributes()!; + const layer = new XRWebGLLayer(session, this._gl, { + antialias: attributes.antialias, + alpha: true, + depth: attributes.depth, + stencil: attributes.stencil, + framebufferScaleFactor: scaleFactor + }); + session.updateRenderState({ baseLayer: layer }); + return layer; } - this._gl = gl; - this._initGLState(gl); + const layer = new XRWebGLLayer(session, this._gl); + session.updateRenderState({ layers: [layer] }); + return layer; } createPlatformPrimitive(primitive: Primitive): IPlatformPrimitive { @@ -300,20 +302,16 @@ export class WebGLGraphicDevice implements IHardwareRenderer { * Enable GL_RASTERIZER_DISCARD (WebGL2 only). */ enableRasterizerDiscard(): void { - if (this._isWebGL2) { - const gl = this._gl; - gl.enable(gl.RASTERIZER_DISCARD); - } + const gl = this._gl; + gl.enable(gl.RASTERIZER_DISCARD); } /** * Disable GL_RASTERIZER_DISCARD (WebGL2 only). */ disableRasterizerDiscard(): void { - if (this._isWebGL2) { - const gl = this._gl; - gl.disable(gl.RASTERIZER_DISCARD); - } + const gl = this._gl; + gl.disable(gl.RASTERIZER_DISCARD); } /** @@ -466,10 +464,6 @@ export class WebGLGraphicDevice implements IHardwareRenderer { clearFlags: CameraClearFlags, viewport: Vector4 ) { - if (!this._isWebGL2) { - Logger.warn("WebGL1.0 not support blit frame buffer."); - return; - } const gl = this._gl; // @ts-ignore const srcFrameBuffer = srcRT ? srcRT._platformRenderTarget._frameBuffer : null; @@ -633,18 +627,16 @@ export class WebGLGraphicDevice implements IHardwareRenderer { if (debugRenderInfo != null) { this._renderer = gl.getParameter(debugRenderInfo.UNMASKED_RENDERER_WEBGL); } - if (this._isWebGL2) { - this.maxUniformBlockSize = (gl).getParameter( - (gl).MAX_UNIFORM_BLOCK_SIZE - ); - } + this.maxUniformBlockSize = (gl).getParameter( + (gl).MAX_UNIFORM_BLOCK_SIZE + ); } destroy(): void { const webCanvas = this._webCanvas; - webCanvas.removeEventListener("webglcontextcreationerror", this._onContextCreationError, false); - webCanvas.removeEventListener("webglcontextlost", this._onWebGLContextLost, false); - webCanvas.removeEventListener("webglcontextrestored", this._onWebGLContextRestored, false); + webCanvas?.removeEventListener("webglcontextcreationerror", this._onContextCreationError, false); + webCanvas?.removeEventListener("webglcontextlost", this._onWebGLContextLost, false); + webCanvas?.removeEventListener("webglcontextrestored", this._onWebGLContextRestored, false); } private _onContextCreationError(event: WebGLContextEvent) { diff --git a/packages/rhi-webgl/src/index.ts b/packages/rhi-webgl/src/index.ts index a71bf9e714..3962283d86 100644 --- a/packages/rhi-webgl/src/index.ts +++ b/packages/rhi-webgl/src/index.ts @@ -2,5 +2,19 @@ export { GLCompressedTextureInternalFormat } from "./type"; export { WebCanvas } from "./WebCanvas"; export { WebGLEngine } from "./WebGLEngine"; export type { WebGLEngineConfiguration } from "./WebGLEngine"; -export { WebGLMode, WebGLGraphicDevice } from "./WebGLGraphicDevice"; +export { WebGLGraphicDevice } from "./WebGLGraphicDevice"; export type { WebGLGraphicDeviceOptions } from "./WebGLGraphicDevice"; +/** @internal */ +export { GLPrimitive } from "./GLPrimitive"; +/** @internal */ +export { GLCapability } from "./GLCapability"; +/** @internal */ +export { GLExtensions } from "./GLExtensions"; +/** @internal */ +export { GLRenderStates } from "./GLRenderStates"; +/** @internal */ +export { GLTexture } from "./GLTexture"; +/** @internal */ +export { GLTexture2D } from "./GLTexture2D"; +/** @internal */ +export { GLTextureCube } from "./GLTextureCube"; diff --git a/packages/webgl1-polyfill/README.md b/packages/webgl1-polyfill/README.md new file mode 100644 index 0000000000..4e54f2f619 --- /dev/null +++ b/packages/webgl1-polyfill/README.md @@ -0,0 +1,7 @@ +# WebGL1 compatibility + +`WebGLEngine.create()` first attempts WebGL2. When it is unavailable, it dynamically imports a pinned release of this package from jsDelivr. The public engine creation API does not change. No compatibility implementation is imported by the core, WebGL RHI, or umbrella engine distributions. + +The CDN entry receives implementation identities from the calling engine. It does not import or bundle another engine. It patches the existing WebGL1 context and overrides the required engine methods. Overrides select by owning device; native WebGL2 engines retain their implementations and shader variants. Unsupported transform-feedback particle modules retain their previous WebGL1 behavior. + +Direct calls to `WebGLGraphicDevice.init()` require WebGL2. Use `WebGLEngine.create()` for automatic fallback. diff --git a/packages/webgl1-polyfill/package.json b/packages/webgl1-polyfill/package.json new file mode 100644 index 0000000000..4ab5ca84cd --- /dev/null +++ b/packages/webgl1-polyfill/package.json @@ -0,0 +1,58 @@ +{ + "name": "@galacean/engine-webgl1-polyfill", + "version": "2.0.0-alpha.57", + "repository": { + "url": "https://github.com/galacean/engine.git" + }, + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org" + }, + "license": "MIT", + "main": "dist/main.js", + "module": "dist/npm.module.js", + "debug": "src/index.ts", + "scripts": { + "b:types": "tsc" + }, + "types": "types/index.d.ts", + "files": [ + "dist/**/*", + "types/**/*" + ], + "dependencies": {}, + "devDependencies": { + "@galacean/engine-core": "workspace:*", + "@galacean/engine-rhi-webgl": "workspace:*", + "@galacean/engine-math": "workspace:*" + }, + "exports": { + ".": { + "types": "./types/index.d.ts", + "import": "./dist/npm.module.js", + "require": "./dist/main.js" + } + }, + "peerDependencies": { + "@galacean/engine-core": "workspace:*", + "@galacean/engine-math": "workspace:*", + "@galacean/engine-rhi-webgl": "workspace:*" + }, + "rollup": { + "output": [ + { + "file": "dist/module.js", + "format": "iife", + "name": "polyfill", + "sourcemap": true, + "globals": { + "@galacean/engine-core": "bindings", + "@galacean/engine-math": "bindings", + "@galacean/engine-rhi-webgl": "bindings" + }, + "banner": "const registry = { devices: new WeakMap(), installedMembers: new WeakMap() };\nexport function bind(bindings) {", + "footer": "return polyfill.bind(bindings, registry);\n}" + } + ] + } +} diff --git a/packages/webgl1-polyfill/src/core/2d/atlas/FontAtlas.ts b/packages/webgl1-polyfill/src/core/2d/atlas/FontAtlas.ts new file mode 100644 index 0000000000..7a68f3c038 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/2d/atlas/FontAtlas.ts @@ -0,0 +1,13 @@ +import { type Engine, Texture2D, TextureFilterMode, TextureFormat } from "@galacean/engine-core"; +import { Mixin, Overwrite } from "@/override"; + +@Mixin("FontAtlas") +export class FontAtlas { + @Overwrite + _createTexture(engine: Engine) { + const texture = new Texture2D(engine, 512, 512, TextureFormat.Alpha8, false, false); + texture.filterMode = TextureFilterMode.Bilinear; + texture.isGCIgnored = true; + return texture; + } +} diff --git a/packages/webgl1-polyfill/src/core/BasicResources.ts b/packages/webgl1-polyfill/src/core/BasicResources.ts new file mode 100644 index 0000000000..e5daf722bf --- /dev/null +++ b/packages/webgl1-polyfill/src/core/BasicResources.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("BasicResources") +export class BasicResources { + @Overwrite + _createDefaultArrayTextures() { + return [undefined, undefined]; + } +} diff --git a/packages/webgl1-polyfill/src/core/Camera.ts b/packages/webgl1-polyfill/src/core/Camera.ts new file mode 100644 index 0000000000..4e06887fb9 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/Camera.ts @@ -0,0 +1,29 @@ +import { type Engine, GLCapabilityType, Logger, type TextureCubeFace, TextureFormat } from "@galacean/engine-core"; +import { Mixin, Overwrite, Shadow, callOriginal } from "@/override"; + +@Mixin("Camera") +export class Camera { + @Shadow declare _enableHDR: boolean; + declare engine: Engine; + + @Overwrite + set enableHDR(value: boolean) { + if (value && !this.engine._hardwareRenderer.canIUse(GLCapabilityType.textureHalfFloat)) { + Logger.warn("Can't enable HDR in this device."); + return; + } + callOriginal(this, value); + } + @Overwrite + _getInternalColorTextureFormat() { + return this._enableHDR ? TextureFormat.R16G16B16A16 : TextureFormat.R8G8B8A8; + } + @Overwrite + render(cubeFace?: TextureCubeFace, mipLevel?: number) { + if (mipLevel !== undefined && mipLevel > 0) { + Logger.error("mipLevel only take effect in WebGL2.0"); + mipLevel = 0; + } + return callOriginal(this, cubeFace, mipLevel); + } +} diff --git a/packages/webgl1-polyfill/src/core/Engine.ts b/packages/webgl1-polyfill/src/core/Engine.ts new file mode 100644 index 0000000000..98df5f2d68 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/Engine.ts @@ -0,0 +1,21 @@ +import { + type Engine as HostEngine, + GLCapabilityType, + ShaderMacro, + type ShaderMacroCollection +} from "@galacean/engine-core"; +import { Mixin, Overwrite, Shadow, callOriginal } from "@/override"; + +@Mixin("Engine") +export class Engine { + @Shadow declare _hardwareRenderer: HostEngine["_hardwareRenderer"]; + @Shadow declare _macroCollection: ShaderMacroCollection; + + @Overwrite + _initializeDefaultTextures() { + const rhi = this._hardwareRenderer; + if (rhi.canIUse(GLCapabilityType.depthTexture)) callOriginal(this); + else this._macroCollection.enable(ShaderMacro.getByName("ENGINE_NO_DEPTH_TEXTURE")); + if (!rhi.canIUse(GLCapabilityType.sRGB)) this._macroCollection.enable(ShaderMacro.getByName("ENGINE_NO_SRGB")); + } +} diff --git a/packages/webgl1-polyfill/src/core/RenderPipeline/BasicRenderPipeline.ts b/packages/webgl1-polyfill/src/core/RenderPipeline/BasicRenderPipeline.ts new file mode 100644 index 0000000000..2c6cebb784 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/RenderPipeline/BasicRenderPipeline.ts @@ -0,0 +1,13 @@ +import type { BasicRenderPipeline as HostBasicRenderPipeline } from "@galacean/engine-core"; +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("BasicRenderPipeline") +export class BasicRenderPipeline { + @Overwrite + render(...args: Parameters) { + if (!Object.getOwnPropertyDescriptor(this, "_canUseBlitFrameBuffer")?.get) { + Object.defineProperty(this, "_canUseBlitFrameBuffer", { configurable: true, get: () => false, set() {} }); + } + return callOriginal(this, ...args); + } +} diff --git a/packages/webgl1-polyfill/src/core/RenderPipeline/DepthOnlyPass.ts b/packages/webgl1-polyfill/src/core/RenderPipeline/DepthOnlyPass.ts new file mode 100644 index 0000000000..bbebca4906 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/RenderPipeline/DepthOnlyPass.ts @@ -0,0 +1,40 @@ +import { + type Camera, + type Engine, + GLCapabilityType, + PipelineUtils, + type RenderTarget, + TextureFilterMode, + TextureFormat, + TextureWrapMode +} from "@galacean/engine-core"; +import { Mixin, Overwrite, Shadow } from "@/override"; + +@Mixin("DepthOnlyPass") +export class DepthOnlyPass { + @Shadow declare renderTarget: RenderTarget | null; + declare engine: Engine; + + @Overwrite + onConfig(camera: Camera) { + const { width, height } = camera.pixelViewport; + this.renderTarget = PipelineUtils.recreateRenderTargetIfNeeded( + this.engine, + this.renderTarget, + width, + height, + null, + TextureFormat.Depth24Stencil8, + true, + false, + false, + 1, + TextureWrapMode.Clamp, + TextureFilterMode.Point + ); + } + @Overwrite + get supportDepthTexture() { + return this.engine._hardwareRenderer.canIUse(GLCapabilityType.depthTexture); + } +} diff --git a/packages/webgl1-polyfill/src/core/SystemInfo.ts b/packages/webgl1-polyfill/src/core/SystemInfo.ts new file mode 100644 index 0000000000..9ab6338897 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/SystemInfo.ts @@ -0,0 +1,33 @@ +import { type Engine, GLCapabilityType, TextureFormat } from "@galacean/engine-core"; +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("SystemInfo") +export class SystemInfo { + @Overwrite + static supportsTextureFormat(engine: Engine, format: TextureFormat) { + const rhi = engine._hardwareRenderer; + switch (format) { + case TextureFormat.R11G11B10_UFloat: + case TextureFormat.R32G32B32A32_UInt: + case TextureFormat.Depth24: + case TextureFormat.Depth32: + case TextureFormat.Depth32Stencil8: + case TextureFormat.R8: + case TextureFormat.R8G8: + return false; + case TextureFormat.R16G16B16A16: + if (!rhi.canIUse(GLCapabilityType.textureHalfFloat)) return false; + break; + case TextureFormat.R32G32B32A32: + if (!rhi.canIUse(GLCapabilityType.textureFloat)) return false; + break; + case TextureFormat.Depth16: + case TextureFormat.Depth24Stencil8: + case TextureFormat.Depth: + case TextureFormat.DepthStencil: + if (!rhi.canIUse(GLCapabilityType.depthTexture)) return false; + break; + } + return callOriginal(this, engine, format); + } +} diff --git a/packages/webgl1-polyfill/src/core/mesh/MeshRenderer.ts b/packages/webgl1-polyfill/src/core/mesh/MeshRenderer.ts new file mode 100644 index 0000000000..046a42d251 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/mesh/MeshRenderer.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("MeshRenderer") +export class MeshRenderer { + @Overwrite + _canBatch() { + return false; + } +} diff --git a/packages/webgl1-polyfill/src/core/mesh/PrimitiveMesh.ts b/packages/webgl1-polyfill/src/core/mesh/PrimitiveMesh.ts new file mode 100644 index 0000000000..a22a00fce1 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/mesh/PrimitiveMesh.ts @@ -0,0 +1,11 @@ +import { type Engine, GLCapabilityType } from "@galacean/engine-core"; +import { Mixin, Overwrite } from "@/override"; + +@Mixin("PrimitiveMesh") +export class PrimitiveMesh { + @Overwrite + static _validateIndexFormat(engine: Engine, vertexCount: number): void { + if (vertexCount > 65535 && !engine._hardwareRenderer.canIUse(GLCapabilityType.elementIndexUint)) + throw new Error("The vertex count is over limit."); + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/ParticleGenerator.ts b/packages/webgl1-polyfill/src/core/particle/ParticleGenerator.ts new file mode 100644 index 0000000000..472484d469 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/ParticleGenerator.ts @@ -0,0 +1,7 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("ParticleGenerator") +export class ParticleGenerator { + @Overwrite + _setTransformFeedback() {} +} diff --git a/packages/webgl1-polyfill/src/core/particle/ParticleRenderer.ts b/packages/webgl1-polyfill/src/core/particle/ParticleRenderer.ts new file mode 100644 index 0000000000..30bf91c16a --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/ParticleRenderer.ts @@ -0,0 +1,16 @@ +import { type Engine, GLCapabilityType, ParticleRenderer as CoreParticleRenderer } from "@galacean/engine-core"; +import { Mixin, Overwrite } from "@/override"; + +@Mixin("ParticleRenderer", function () { + return !this.engine._hardwareRenderer.canIUse(GLCapabilityType.instancedArrays); +}) +export class ParticleRenderer { + declare engine: Engine; + @Overwrite + _prepareRender() {} + @Overwrite + _onEnableInScene() { + const particle = CoreParticleRenderer.prototype; + Object.getPrototypeOf(particle)._onEnableInScene.call(this); + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/modules/InheritVelocityModule.ts b/packages/webgl1-polyfill/src/core/particle/modules/InheritVelocityModule.ts new file mode 100644 index 0000000000..095e30a32c --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/modules/InheritVelocityModule.ts @@ -0,0 +1,20 @@ +import { ParticleInheritVelocityMode } from "@galacean/engine-core"; +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("InheritVelocityModule") +export class InheritVelocityModule { + declare mode: ParticleInheritVelocityMode; + declare _resyncEmitterVelocity: () => void; + @Overwrite + _needTransformFeedback() { + return false; + } + @Overwrite + _updateEmitterVelocity(elapsedTime: number) { + if (this.mode !== ParticleInheritVelocityMode.Initial) { + this._resyncEmitterVelocity(); + return; + } + callOriginal(this, elapsedTime); + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/modules/LimitVelocityOverLifetimeModule.ts b/packages/webgl1-polyfill/src/core/particle/modules/LimitVelocityOverLifetimeModule.ts new file mode 100644 index 0000000000..daca0b9fcf --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/modules/LimitVelocityOverLifetimeModule.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("LimitVelocityOverLifetimeModule") +export class LimitVelocityOverLifetimeModule { + @Overwrite + set enabled(value: boolean) { + if (!value) callOriginal(this, value); + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/modules/NoiseModule.ts b/packages/webgl1-polyfill/src/core/particle/modules/NoiseModule.ts new file mode 100644 index 0000000000..ce88c4c06b --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/modules/NoiseModule.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("NoiseModule") +export class NoiseModule { + @Overwrite + set enabled(value: boolean) { + if (!value) callOriginal(this, value); + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/modules/SubEmittersModule.ts b/packages/webgl1-polyfill/src/core/particle/modules/SubEmittersModule.ts new file mode 100644 index 0000000000..1287ed3e3d --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/modules/SubEmittersModule.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("SubEmittersModule") +export class SubEmittersModule { + @Overwrite + get enabled() { + return false; + } +} diff --git a/packages/webgl1-polyfill/src/core/particle/modules/VelocityOverLifetimeModule.ts b/packages/webgl1-polyfill/src/core/particle/modules/VelocityOverLifetimeModule.ts new file mode 100644 index 0000000000..54d9269c2f --- /dev/null +++ b/packages/webgl1-polyfill/src/core/particle/modules/VelocityOverLifetimeModule.ts @@ -0,0 +1,9 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("VelocityOverLifetimeModule") +export class VelocityOverLifetimeModule { + @Overwrite + _supportsTransformFeedback() { + return false; + } +} diff --git a/packages/webgl1-polyfill/src/core/shader/ShaderPass.ts b/packages/webgl1-polyfill/src/core/shader/ShaderPass.ts new file mode 100644 index 0000000000..8b0ef8fbc3 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/shader/ShaderPass.ts @@ -0,0 +1,72 @@ +import { + type Engine, + GLCapabilityType, + ShaderFactory, + ShaderMacro, + type ShaderMacroCollection, + ShaderMacroProcessor, + type ShaderPass as HostShaderPass +} from "@galacean/engine-core"; +import { Mixin, Overwrite, Shadow } from "@/override"; +const shaderExtension = [ + "GL_EXT_shader_texture_lod", + "GL_OES_standard_derivatives", + "GL_EXT_draw_buffers", + "GL_EXT_frag_depth" +] + .map((e) => `#extension ${e} : enable\n`) + .join(""); +const precisionStr = ` +#ifdef GL_FRAGMENT_PRECISION_HIGH +precision highp float; +precision highp int; +#else +precision mediump float; +precision mediump int; +#endif +`; + +@Mixin("ShaderPass") +export class ShaderPass { + @Shadow declare _vertexShaderInstructions: HostShaderPass["_vertexShaderInstructions"]; + @Shadow declare _fragmentShaderInstructions: HostShaderPass["_fragmentShaderInstructions"]; + + @Overwrite + _compileShaderSource(engine: Engine, macroCollection: ShaderMacroCollection, isGPUInstance: boolean) { + const shaderMacroList: ReturnType[] = []; + ShaderMacro._getMacrosElements(macroCollection, shaderMacroList); + shaderMacroList.push(ShaderMacro.getByName("GRAPHICS_API_WEBGL1")); + if (engine._hardwareRenderer.canIUse(GLCapabilityType.shaderTextureLod)) { + shaderMacroList.push(ShaderMacro.getByName("HAS_TEX_LOD")); + } + if (engine._hardwareRenderer.canIUse(GLCapabilityType.standardDerivatives)) { + shaderMacroList.push(ShaderMacro.getByName("HAS_DERIVATIVES")); + } + const macroMap = new Map(); + for (let i = 0, n = shaderMacroList.length; i < n; i++) { + const macro = shaderMacroList[i]; + macroMap.set(macro.name, macro.value ?? ""); + } + let vertexSource = ShaderMacroProcessor.evaluate(this._vertexShaderInstructions, macroMap); + let fragmentSource = ShaderMacroProcessor.evaluate(this._fragmentShaderInstructions, macroMap); + let instanceLayout: ReturnType["instanceLayout"] = null; + if (isGPUInstance) { + const injected = ShaderFactory.injectInstanceUBO(engine, vertexSource, fragmentSource); + vertexSource = injected.vertexSource; + fragmentSource = injected.fragmentSource; + instanceLayout = injected.instanceLayout; + } + const versionStr = "#version 100"; + return { + vertexSource: ` ${versionStr} + ${vertexSource} + `, + fragmentSource: ` ${versionStr} + ${shaderExtension} + ${precisionStr} + ${fragmentSource} + `, + instanceLayout + }; + } +} diff --git a/packages/webgl1-polyfill/src/core/shader/ShaderProgram.ts b/packages/webgl1-polyfill/src/core/shader/ShaderProgram.ts new file mode 100644 index 0000000000..4a4ef174eb --- /dev/null +++ b/packages/webgl1-polyfill/src/core/shader/ShaderProgram.ts @@ -0,0 +1,7 @@ +import { Mixin, Overwrite } from "@/override"; + +@Mixin("ShaderProgram") +export class ShaderProgram { + @Overwrite + _recordUniformBlocks() {} +} diff --git a/packages/webgl1-polyfill/src/core/shader/state/BlendState.ts b/packages/webgl1-polyfill/src/core/shader/state/BlendState.ts new file mode 100644 index 0000000000..38bd123a60 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/shader/state/BlendState.ts @@ -0,0 +1,16 @@ +import { BlendOperation, type Engine, GLCapabilityType } from "@galacean/engine-core"; +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("BlendState") +export class BlendState { + @Overwrite + static _getGLBlendOperation(rhi: Engine["_hardwareRenderer"], operation: BlendOperation) { + if ( + (operation === BlendOperation.Min || operation === BlendOperation.Max) && + !rhi.canIUse(GLCapabilityType.blendMinMax) + ) { + throw new Error(`BlendOperation.${BlendOperation[operation]} is not supported in this context`); + } + return callOriginal(this, rhi, operation); + } +} diff --git a/packages/webgl1-polyfill/src/core/shadow/CascadedShadowCasterPass.ts b/packages/webgl1-polyfill/src/core/shadow/CascadedShadowCasterPass.ts new file mode 100644 index 0000000000..c2fb72e8f4 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/shadow/CascadedShadowCasterPass.ts @@ -0,0 +1,58 @@ +import { + CameraClearFlags, + CascadedShadowCasterPass as CoreCascadedShadowCasterPass, + type CascadedShadowCasterPass as HostShadowPass, + type Engine, + GLCapabilityType, + PipelineUtils, + type RenderTarget, + type Texture, + TextureFilterMode, + TextureFormat, + TextureWrapMode +} from "@galacean/engine-core"; +import { Mixin, Overwrite, Shadow } from "@/override"; + +@Mixin("CascadedShadowCasterPass") +export class CascadedShadowCasterPass { + @Shadow declare _depthTexture: Texture | null; + @Shadow declare _renderTarget: RenderTarget | null; + @Shadow declare _shadowMapFormat: TextureFormat; + @Shadow declare _shadowMapSize: { z: number; w: number }; + declare engine: Engine; + + @Overwrite + _getShadowFormat() { + return this.engine._hardwareRenderer.canIUse(GLCapabilityType.depthTexture) + ? TextureFormat.Depth16 + : TextureFormat.R8G8B8A8; + } + @Overwrite + _prepareShadowMap(context: Parameters[0]) { + const shadow = CoreCascadedShadowCasterPass; + const depth = this.engine._hardwareRenderer.canIUse(GLCapabilityType.depthTexture); + const { z: width, w: height } = this._shadowMapSize; + const target = PipelineUtils.recreateRenderTargetIfNeeded( + this.engine, + this._renderTarget, + width, + height, + depth ? null : this._shadowMapFormat, + depth ? this._shadowMapFormat : null, + depth, + false, + false, + 1, + TextureWrapMode.Clamp, + TextureFilterMode.Bilinear + ); + this._renderTarget = target; + this._depthTexture = depth ? target.depthTexture : target.getColorTexture(0); + context.setRenderTarget(target, shadow["_viewport"], 0); + this.engine._hardwareRenderer.clearRenderTarget( + this.engine, + depth ? CameraClearFlags.Depth : CameraClearFlags.All, + depth ? null : shadow["_clearColor"] + ); + } +} diff --git a/packages/webgl1-polyfill/src/core/texture/Texture.ts b/packages/webgl1-polyfill/src/core/texture/Texture.ts new file mode 100644 index 0000000000..76ff7b5693 --- /dev/null +++ b/packages/webgl1-polyfill/src/core/texture/Texture.ts @@ -0,0 +1,10 @@ +import { Logger, type TextureDepthCompareFunction } from "@galacean/engine-core"; +import { Mixin, Overwrite } from "@/override"; + +@Mixin("Texture") +export class Texture { + @Overwrite + set depthCompareFunction(_value: TextureDepthCompareFunction) { + Logger.warn("depthCompareFunction only support WebGL2"); + } +} diff --git a/packages/webgl1-polyfill/src/core/texture/TextureUtils.ts b/packages/webgl1-polyfill/src/core/texture/TextureUtils.ts new file mode 100644 index 0000000000..3d7502b6dd --- /dev/null +++ b/packages/webgl1-polyfill/src/core/texture/TextureUtils.ts @@ -0,0 +1,22 @@ +import { type Engine, type TextureFormat, TextureUtils as CoreTextureUtils } from "@galacean/engine-core"; +import { MathUtil } from "@galacean/engine-math"; +import { Mixin, Overwrite } from "@/override"; + +@Mixin("TextureUtils") +export class TextureUtils { + @Overwrite + static supportGenerateMipmapsWithCorrection( + _engine: Engine, + width: number, + height: number, + format: TextureFormat, + mipmap: boolean, + srgb: boolean + ) { + const pot = (width: number, height: number) => MathUtil.isPowerOf2(width) && MathUtil.isPowerOf2(height); + if (!mipmap) return false; + if (srgb && !CoreTextureUtils.supportSRGB(format)) srgb = false; + if (!pot(width, height)) mipmap = false; + return !(mipmap && srgb); + } +} diff --git a/packages/webgl1-polyfill/src/index.ts b/packages/webgl1-polyfill/src/index.ts new file mode 100644 index 0000000000..900207e2c1 --- /dev/null +++ b/packages/webgl1-polyfill/src/index.ts @@ -0,0 +1,25 @@ +import "./overrides"; +import { bindOverrides, type Bindings, type Registry } from "@/override"; +import type { WebCanvas, WebGLGraphicDevice } from "@galacean/engine-rhi-webgl"; + +/** + * Bind the polyfill to the engine classes supplied by the caller. + * @param bindings - Classes used by the calling engine build + * @param registry - Shared installation state for the CDN output + * @returns A function that prepares a device with its WebGL1 context + */ +export function bind(bindings: Bindings, registry?: Registry): (device: WebGLGraphicDevice, canvas: WebCanvas) => void { + let registerDevice: ((device: WebGLGraphicDevice) => void) | undefined; + + return (device, canvas) => { + const nativeCanvas = canvas._webCanvas; + const gl = + nativeCanvas.getContext("webgl", device["_webGLOptions"]) || + (!canvas._isOffscreenCanvas() && nativeCanvas.getContext("experimental-webgl", device["_webGLOptions"])); + if (!gl) throw new Error("Get GL Context FAILED."); + registerDevice ??= bindOverrides(bindings, registry); + device._setContext(nativeCanvas, gl as WebGL2RenderingContext, false); + registerDevice(device); + bindings.Logger.warn("WebGL1 compatibility mode enabled."); + }; +} diff --git a/packages/webgl1-polyfill/src/override.ts b/packages/webgl1-polyfill/src/override.ts new file mode 100644 index 0000000000..211937f340 --- /dev/null +++ b/packages/webgl1-polyfill/src/override.ts @@ -0,0 +1,229 @@ +import type { WebGLGraphicDevice } from "@galacean/engine-rhi-webgl"; + +type Core = Pick< + typeof import("@galacean/engine-core"), + | "Engine" + | "ShaderPass" + | "ShaderMacro" + | "ShaderFactory" + | "BasicRenderPipeline" + | "Camera" + | "CameraClearFlags" + | "MeshRenderer" + | "Texture" + | "Texture2D" + | "TextureUtils" + | "TextureFormat" + | "TextureFilterMode" + | "TextureWrapMode" + | "SystemInfo" + | "PrimitiveMesh" + | "BlendOperation" + | "Logger" + | "GLCapabilityType" + | "ParticleGenerator" + | "ParticleRenderer" + | "NoiseModule" + | "LimitVelocityOverLifetimeModule" + | "VelocityOverLifetimeModule" + | "SubEmittersModule" + | "InheritVelocityModule" + | "ParticleInheritVelocityMode" + | "BlendState" + | "CascadedShadowCasterPass" + | "ShaderProgram" + | "BasicResources" + | "FontAtlas" + | "DepthOnlyPass" + | "ShaderMacroProcessor" + | "PipelineUtils" +>; +type RHI = Pick< + typeof import("@galacean/engine-rhi-webgl"), + | "WebGLGraphicDevice" + | "GLPrimitive" + | "GLCapability" + | "GLExtensions" + | "GLRenderStates" + | "GLTexture" + | "GLTexture2D" + | "GLTextureCube" +>; +export type Bindings = Core & RHI & Pick; +type Target = keyof Bindings; +type Selector = (this: any) => boolean; +type Members = { target: Target; implementation: Function; when?: Selector }; +type Patch = { + target: object; + key: PropertyKey; + original: PropertyDescriptor; + replacement: PropertyDescriptor; +}; +type MemberKind = "value" | "get" | "set"; +type Invoke = ( + target: object, + key: PropertyKey, + kind: MemberKind, + original: Function, + receiver: unknown, + args: IArguments +) => unknown; +type Replacement = { descriptor: PropertyDescriptor; when?: Selector }; + +export interface Registry { + devices: WeakMap; + installedMembers: WeakMap>; +} + +const classes: Members[] = []; +const overwrites = new WeakMap>(); +const shadows = new WeakMap>(); +let defaultRegistry: Registry | undefined; +let originalMethod: Function | undefined; + +export function callOriginal(receiver: any, ...args: any[]): any { + return originalMethod!.apply(receiver, args); +} + +/** Register a class containing WebGL1 replacements for the named engine class. */ +export function Mixin(target: Target, when?: Selector): ClassDecorator { + return (implementation) => { + classes.push({ target, implementation, when }); + }; +} + +/** Mark an existing method or accessor for replacement. */ +export function Overwrite(target: object, key: PropertyKey, _descriptor: PropertyDescriptor): void { + let members = overwrites.get(target); + if (!members) overwrites.set(target, (members = new Set())); + members.add(key); +} + +/** Declare an existing instance field. Its storage belongs to the original engine instance. */ +export function Shadow(target: object, key: PropertyKey): void { + let fields = shadows.get(target); + if (!fields) shadows.set(target, (fields = new Set())); + fields.add(key); +} + +export function bindOverrides( + bindings: Bindings, + registry: Registry = (defaultRegistry ??= { devices: new WeakMap(), installedMembers: new WeakMap() }) +): (device: WebGLGraphicDevice) => void { + const { devices, installedMembers } = registry; + const patches: Patch[] = []; + const replacements = new WeakMap>(); + + function prepare(target: object, source: object, key: PropertyKey, when?: Selector): void { + const descriptor = Object.getOwnPropertyDescriptor(source, key)!; + const patch = prepareMember(devices, target, key, descriptor); + if (!installedMembers.get(target)?.has(key)) patches.push(patch); + + let members = replacements.get(target); + if (!members) replacements.set(target, (members = new Map())); + members.set(key, { descriptor, when }); + } + + for (const { target, implementation, when } of classes) { + const original = bindings[target]; + if (typeof original !== "function") throw new Error(`Incompatible engine class: ${target}`); + + for (const field of shadows.get(implementation.prototype) ?? []) { + if ( + Object.prototype.hasOwnProperty.call(implementation.prototype, field) || + overwrites.get(implementation.prototype)?.has(field) + ) { + throw new Error(`@Shadow must declare an existing instance field: ${String(field)}`); + } + } + for (const key of overwrites.get(implementation.prototype) ?? []) { + prepare(original.prototype, implementation.prototype, key, when); + } + for (const key of overwrites.get(implementation) ?? []) { + prepare(original, implementation, key); + } + } + + let applied = 0; + try { + for (const { target, key, replacement } of patches) { + Object.defineProperty(target, key, replacement); + applied++; + } + } catch (error) { + for (let index = applied - 1; index >= 0; index--) { + const { target, key, original } = patches[index]; + Object.defineProperty(target, key, original); + } + throw error; + } + + for (const { target, key } of patches) { + let members = installedMembers.get(target); + if (!members) installedMembers.set(target, (members = new Set())); + members.add(key); + } + const invoke: Invoke = (target, key, kind, original, receiver, args) => { + const replacement = replacements.get(target)?.get(key); + const method = replacement?.descriptor[kind]; + if (!method) return original.apply(receiver, args); + + const callerOriginal = originalMethod; + originalMethod = original; + try { + if (replacement?.when && !replacement.when.call(receiver)) return original.apply(receiver, args); + return method.apply(receiver, args); + } finally { + originalMethod = callerOriginal; + } + }; + return (device) => devices.set(device, invoke); +} + +function owningDevice(value: any): object | undefined { + return ( + value?._camera?.engine?._hardwareRenderer ?? + value?._hardwareRenderer ?? + value?._rhi ?? + value?.rhi ?? + value?._engine?._hardwareRenderer ?? + value?.engine?._hardwareRenderer ?? + value?._primitive?.engine?._hardwareRenderer ?? + value?._generator?._renderer?.engine?._hardwareRenderer ?? + value?._renderer?.engine?._hardwareRenderer ?? + value + ); +} + +function prepareMember( + devices: Registry["devices"], + target: object, + key: PropertyKey, + replacement: PropertyDescriptor +): Patch { + const original = Object.getOwnPropertyDescriptor(target, key); + if (!original?.configurable) throw new Error(`Incompatible engine member: ${String(key)}`); + + const descriptor = { ...original }; + for (const kind of ["value", "get", "set"] as const) { + const method = replacement[kind]; + if (!method) continue; + const previous = original[kind]; + if (typeof method !== "function" || typeof previous !== "function") { + throw new Error(`Incompatible engine ${kind}: ${String(key)}`); + } + descriptor[kind] = function () { + const owner = owningDevice(this); + let invoke = devices.get(owner!); + // Shared shader passes and static methods receive the engine or RHI as an argument. + if (!invoke && owner === this) { + for (let index = 0; index < arguments.length; index++) { + invoke = devices.get(owningDevice(arguments[index])!); + if (invoke) break; + } + } + return invoke ? invoke(target, key, kind, previous, this, arguments) : previous.apply(this, arguments); + }; + } + return { target, key, original, replacement: descriptor }; +} diff --git a/packages/webgl1-polyfill/src/overrides.ts b/packages/webgl1-polyfill/src/overrides.ts new file mode 100644 index 0000000000..abd219480d --- /dev/null +++ b/packages/webgl1-polyfill/src/overrides.ts @@ -0,0 +1,28 @@ +import "./core/2d/atlas/FontAtlas"; +import "./core/BasicResources"; +import "./core/Camera"; +import "./core/Engine"; +import "./core/RenderPipeline/BasicRenderPipeline"; +import "./core/RenderPipeline/DepthOnlyPass"; +import "./core/SystemInfo"; +import "./core/mesh/MeshRenderer"; +import "./core/mesh/PrimitiveMesh"; +import "./core/particle/ParticleGenerator"; +import "./core/particle/ParticleRenderer"; +import "./core/particle/modules/InheritVelocityModule"; +import "./core/particle/modules/LimitVelocityOverLifetimeModule"; +import "./core/particle/modules/NoiseModule"; +import "./core/particle/modules/SubEmittersModule"; +import "./core/particle/modules/VelocityOverLifetimeModule"; +import "./core/shader/ShaderPass"; +import "./core/shader/ShaderProgram"; +import "./core/shader/state/BlendState"; +import "./core/shadow/CascadedShadowCasterPass"; +import "./core/texture/Texture"; +import "./core/texture/TextureUtils"; +import "./rhi-webgl/GLCapability"; +import "./rhi-webgl/GLPrimitive"; +import "./rhi-webgl/GLTexture"; +import "./rhi-webgl/GLTexture2D"; +import "./rhi-webgl/GLTextureCube"; +import "./rhi-webgl/WebGLGraphicDevice"; diff --git a/packages/webgl1-polyfill/src/rhi-webgl/GLCapability.ts b/packages/webgl1-polyfill/src/rhi-webgl/GLCapability.ts new file mode 100644 index 0000000000..f4ede65405 --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/GLCapability.ts @@ -0,0 +1,49 @@ +import { GLCapabilityType } from "@galacean/engine-core"; +import type { WebGLGraphicDevice } from "@galacean/engine-rhi-webgl"; +import { Mixin, Overwrite, Shadow, callOriginal } from "@/override"; +import { adaptContext } from "./context"; + +@Mixin("GLCapability") +export class GLCapability { + @Shadow declare capabilityList: Map; + declare readonly rhi: WebGLGraphicDevice; + declare canIUse: (type: GLCapabilityType) => boolean; + @Overwrite + _init() { + callOriginal(this); + const { rhi, capabilityList } = this; + const types = GLCapabilityType; + const extensionCapabilities = [ + types.standardDerivatives, + types.shaderTextureLod, + types.elementIndexUint, + types.depthTexture, + types.vertexArrayObject, + types.instancedArrays, + types.drawBuffers, + types.blendMinMax, + types.textureFloat, + types.textureHalfFloat, + types.textureHalfFloatLinear, + types.fragDepth, + types.sRGB + ]; + for (const type of extensionCapabilities) { + capabilityList.set(type, !!rhi.requireExtension(type)); + } + capabilityList.set(types.shaderVertexID, false); + capabilityList.set(types.multipleSample, false); + capabilityList.set(types.colorBufferFloat, !!rhi.requireExtension(types.WEBGL_colorBufferFloat)); + capabilityList.set(types.colorBufferHalfFloat, !!rhi.requireExtension(types.colorBufferHalfFloat)); + + adaptContext(this as any, types); + } + @Overwrite + get maxDrawBuffers() { + return this.canIUse(GLCapabilityType.drawBuffers) ? callOriginal(this) : 1; + } + @Overwrite + get maxAntiAliasing() { + return this.canIUse(GLCapabilityType.multipleSample) ? callOriginal(this) : 1; + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/GLPrimitive.ts b/packages/webgl1-polyfill/src/rhi-webgl/GLPrimitive.ts new file mode 100644 index 0000000000..99bddb75bc --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/GLPrimitive.ts @@ -0,0 +1,126 @@ +import { GLCapabilityType, Logger, type Primitive, type SubPrimitive } from "@galacean/engine-core"; +import type { GLPrimitive as HostGLPrimitive } from "@galacean/engine-rhi-webgl"; +import { Mixin, Overwrite, Shadow } from "@/override"; + +type ShaderProgram = Parameters[0]; + +@Mixin("GLPrimitive", function () { + const rhi = this._primitive.engine._hardwareRenderer; + return !rhi.canIUse(GLCapabilityType.vertexArrayObject) || !rhi.canIUse(GLCapabilityType.instancedArrays); +}) +export class GLPrimitive { + @Shadow declare _gl: WebGL2RenderingContext; + @Shadow declare _primitive: Primitive; + @Shadow declare _attribLocArray: number[]; + @Shadow declare _vaoMap: Map; + declare _registerVAO: (shaderProgram: ShaderProgram) => void; + declare _clearVAO: () => void; + declare _disableAttrib: () => void; + + @Overwrite + draw(shaderProgram: ShaderProgram, subMesh: SubPrimitive) { + const rhi = this._primitive.engine._hardwareRenderer; + const supportsVAO = rhi.canIUse(GLCapabilityType.vertexArrayObject); + const supportsInstancing = rhi.canIUse(GLCapabilityType.instancedArrays); + + const gl = this._gl; + const primitive = this._primitive; + const useVao = supportsVAO && primitive.enableVAO; + if (useVao) { + if (primitive._bufferStructChanged) { + this._clearVAO(); + } + if (!this._vaoMap.has(shaderProgram.id)) { + this._registerVAO(shaderProgram); + } + const vao = this._vaoMap.get(shaderProgram.id)!; + gl.bindVertexArray(vao); + } else { + this._bindBufferAndAttrib(shaderProgram); + } + const { indexBufferBinding, instanceCount, _glIndexType, _glIndexByteCount } = primitive; + const { topology, start, count } = subMesh; + if (!instanceCount) { + if (indexBufferBinding) { + if (useVao) { + gl.drawElements(topology, count, _glIndexType!, start * _glIndexByteCount); + } else { + const { _glBuffer } = indexBufferBinding.buffer._platformBuffer as unknown as { _glBuffer: WebGLBuffer }; + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, _glBuffer); + gl.drawElements(topology, count, _glIndexType!, start * _glIndexByteCount); + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, null); + } + } else { + gl.drawArrays(topology, start, count); + } + } else { + if (supportsInstancing) { + if (indexBufferBinding) { + if (useVao) { + gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); + } else { + const { _glBuffer } = indexBufferBinding.buffer._platformBuffer as unknown as { _glBuffer: WebGLBuffer }; + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, _glBuffer); + gl.drawElementsInstanced(topology, count, _glIndexType!, start * _glIndexByteCount, instanceCount); + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, null); + } + } else { + gl.drawArraysInstanced(topology, start, count, instanceCount); + } + } else { + Logger.error("ANGLE_instanced_arrays extension is not supported"); + } + } + // Unbind + if (useVao) { + gl.bindVertexArray(null); + } else { + this._disableAttrib(); + } + } + @Overwrite + _bindBufferAndAttrib(shaderProgram: ShaderProgram) { + const rhi = this._primitive.engine._hardwareRenderer; + const supportsInstancing = rhi.canIUse(GLCapabilityType.instancedArrays); + + const gl = this._gl; + const primitive = this._primitive; + const vertexBufferBindings = primitive.vertexBufferBindings; + this._attribLocArray.length = 0; + const attributeLocation = shaderProgram.attributeLocation; + const attributes = primitive._vertexElementMap; + let vbo; + let lastBoundVbo; + for (const name in attributeLocation) { + const loc = attributeLocation[name]; + if (loc === -1) continue; + const element = attributes[name]; + if (element) { + const { buffer, stride } = vertexBufferBindings[element.bindingIndex]!; + vbo = (buffer._platformBuffer as unknown as { _glBuffer: WebGLBuffer })._glBuffer; + // prevent binding the vbo which already bound at the last loop, e.g. a buffer with multiple attributes. + if (lastBoundVbo !== vbo) { + lastBoundVbo = vbo; + gl.bindBuffer(gl.ARRAY_BUFFER, vbo); + } + gl.enableVertexAttribArray(loc); + const elementInfo = element._formatMetaInfo; + gl.vertexAttribPointer(loc, elementInfo.size, elementInfo.type, elementInfo.normalized, stride, element.offset); + if (supportsInstancing) { + gl.vertexAttribDivisor(loc, element.instanceStepRate); + } + this._attribLocArray.push(loc); + } else { + Logger.warn("vertex attribute not found: " + name); + } + } + gl.bindBuffer(gl.ARRAY_BUFFER, null); + } + @Overwrite + destroy() { + const rhi = this._primitive.engine._hardwareRenderer; + const supportsVAO = rhi.canIUse(GLCapabilityType.vertexArrayObject); + + supportsVAO && this._clearVAO(); + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/GLTexture.ts b/packages/webgl1-polyfill/src/rhi-webgl/GLTexture.ts new file mode 100644 index 0000000000..a1f02b4f3e --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/GLTexture.ts @@ -0,0 +1,97 @@ +import { + GLCapabilityType, + Logger, + type Texture, + type TextureCubeFace, + type TextureDepthCompareFunction, + TextureFormat, + TextureWrapMode +} from "@galacean/engine-core"; +import { MathUtil } from "@galacean/engine-math"; +import type { WebGLGraphicDevice } from "@galacean/engine-rhi-webgl"; +import { textureFormat } from "./textureFormat"; +import { Mixin, Overwrite, Shadow, callOriginal } from "@/override"; +import { textureStorage } from "./textureStorage"; + +@Mixin("GLTexture") +export class GLTexture { + @Shadow declare _formatDetail: { isCompressed: boolean }; + @Shadow declare _texture: Texture; + + @Overwrite + setUseDepthCompareMode() {} + @Overwrite + static _supportRenderBufferColorFormat(format: TextureFormat, rhi: WebGLGraphicDevice) { + return format !== TextureFormat.R11G11B10_UFloat && callOriginal(this, format, rhi); + } + @Overwrite + static _supportRenderBufferDepthFormat(format: TextureFormat) { + return ![TextureFormat.Depth24, TextureFormat.Depth32, TextureFormat.Depth32Stencil8].includes(format); + } + @Overwrite + _init(cube: boolean) { + if (!this._formatDetail.isCompressed) textureStorage.call(this, cube); + } + @Overwrite + _validate(texture: Texture, rhi: WebGLGraphicDevice) { + const pot = (width: number, height: number) => MathUtil.isPowerOf2(width) && MathUtil.isPowerOf2(height); + callOriginal(this, texture, rhi); + if (texture._mipmap && !pot(texture.width, texture.height)) { + Logger.warn( + "Non-power-2 texture is not supported for mipmap in WebGL1, and has automatically downgraded to non-mipmap" + ); + texture._mipmap = false; + texture["_mipmapCount"] = texture["_getMipmapCount"](); + } + } + @Overwrite + _setWrapMode(value: TextureWrapMode, pname: GLenum) { + const pot = (width: number, height: number) => MathUtil.isPowerOf2(width) && MathUtil.isPowerOf2(height); + if (value !== TextureWrapMode.Clamp && !pot(this._texture.width, this._texture.height)) { + Logger.warn( + "non-power-2 texture is not supported for REPEAT or MIRRORED_REPEAT in WebGL1,and has automatically downgraded to CLAMP_TO_EDGE" + ); + value = TextureWrapMode.Clamp; + } + callOriginal(this, value, pname); + } + @Overwrite + generateMipmaps() { + if (this._texture._mipmap && this._texture.isSRGBColorSpace) { + Logger.warn( + "Auto-generating mipmaps for sRGB textures is only supported in [WebGL2 + R8G8B8A8], you must generate mipmaps manually." + ); + return; + } + callOriginal(this); + } + @Overwrite + _getPixelBuffer( + face: TextureCubeFace | null, + x: number, + y: number, + width: number, + height: number, + mipLevel: number, + out: ArrayBufferView + ) { + if (mipLevel > 0) { + mipLevel = 0; + Logger.error("mipLevel only take effect in WebGL2.0"); + } + callOriginal(this, face, x, y, width, height, mipLevel, out); + } + @Overwrite + set depthCompareFunction(_value: TextureDepthCompareFunction) {} + @Overwrite + static _getFormatDetail(format: TextureFormat, srgb: boolean, gl: WebGLRenderingContext, rhi: WebGLGraphicDevice) { + return ( + textureFormat(format, srgb && rhi.canIUse(GLCapabilityType.sRGB), gl, TextureFormat) ?? + callOriginal(this, format, srgb, gl, rhi) + ); + } + @Overwrite + static _getRenderBufferDepthFormatDetail(format: TextureFormat, gl: WebGLRenderingContext, rhi: WebGLGraphicDevice) { + return textureFormat(format, false, gl, TextureFormat, true) ?? callOriginal(this, format, gl, rhi); + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/GLTexture2D.ts b/packages/webgl1-polyfill/src/rhi-webgl/GLTexture2D.ts new file mode 100644 index 0000000000..010891a44b --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/GLTexture2D.ts @@ -0,0 +1,11 @@ +import type { GLTexture2D as HostTexture } from "@galacean/engine-rhi-webgl"; +import { Mixin, Overwrite } from "@/override"; +import { setCompressedPixels } from "./compressedTexture"; + +@Mixin("GLTexture2D") +export class GLTexture2D { + @Overwrite + setPixelBuffer(...args: Parameters) { + return setCompressedPixels(this, false, args); + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/GLTextureCube.ts b/packages/webgl1-polyfill/src/rhi-webgl/GLTextureCube.ts new file mode 100644 index 0000000000..c41fe2b4cf --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/GLTextureCube.ts @@ -0,0 +1,11 @@ +import type { GLTextureCube as HostTexture } from "@galacean/engine-rhi-webgl"; +import { Mixin, Overwrite } from "@/override"; +import { setCompressedPixels } from "./compressedTexture"; + +@Mixin("GLTextureCube") +export class GLTextureCube { + @Overwrite + setPixelBuffer(...args: Parameters) { + return setCompressedPixels(this, true, args); + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/WebGLGraphicDevice.ts b/packages/webgl1-polyfill/src/rhi-webgl/WebGLGraphicDevice.ts new file mode 100644 index 0000000000..a516c45a58 --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/WebGLGraphicDevice.ts @@ -0,0 +1,89 @@ +import { GLCapabilityType, Logger, type RenderTarget, type Texture, type Texture2DArray } from "@galacean/engine-core"; +import { + GLCapability, + GLExtensions, + GLRenderStates, + type WebGLGraphicDevice as HostDevice +} from "@galacean/engine-rhi-webgl"; +import { Mixin, Overwrite, callOriginal } from "@/override"; + +@Mixin("WebGLGraphicDevice") +export class WebGLGraphicDevice { + declare _activeTextureID: number; + declare _renderStates: GLRenderStates; + declare _extensions: GLExtensions; + declare _capability: GLCapability; + declare _renderer: string; + declare readonly gl: WebGLRenderingContext; + declare canIUse: HostDevice["canIUse"]; + @Overwrite + _initGLState(gl: WebGLRenderingContext & Pick) { + this._activeTextureID = gl.TEXTURE0; + this._renderStates = new GLRenderStates(gl); + this._extensions = new GLExtensions(this as any); + this._capability = new GLCapability(this as any); + + // Unsupported entry points fail at their actual invocation, never during ordinary initialization. + gl.getBufferSubData = () => { + throw new Error("Buffer is write-only on WebGL1.0 platforms."); + }; + gl.activeTexture(gl.TEXTURE0); + const info = gl.getExtension("WEBGL_debug_renderer_info"); + if (info) this._renderer = gl.getParameter(info.UNMASKED_RENDERER_WEBGL); + } + @Overwrite + createPlatformRenderTarget(target: RenderTarget) { + if (target.colorTextures.length > 1 && !this.canIUse(GLCapabilityType.drawBuffers)) { + for (const texture of target.colorTextures) texture._addReferCount(-1); + target.depthTexture?._addReferCount(-1); + unregisterResource(target); + throw new Error("MRT is not supported"); + } + return callOriginal(this, target); + } + @Overwrite + createPlatformTexture2DArray(texture: Texture2DArray) { + unregisterResource(texture); + throw new Error("Texture2D Array is not supported in WebGL1.0"); + } + @Overwrite + createPlatformTransformFeedback(): never { + throw new Error("Transform Feedback is not supported on WebGL1."); + } + @Overwrite + createPlatformTransformFeedbackPrimitive(): never { + throw new Error("Transform Feedback primitives are not supported on WebGL1."); + } + @Overwrite + enableRasterizerDiscard(): never { + throw new Error("Rasterizer discard is not supported on WebGL1."); + } + @Overwrite + disableRasterizerDiscard(): never { + throw new Error("Rasterizer discard is not supported on WebGL1."); + } + @Overwrite + blitInternalRTByBlitFrameBuffer() { + return Logger.warn("WebGL1.0 not support blit frame buffer."); + } + @Overwrite + _createXRLayer(session: XRSession, scaleFactor: number) { + const attributes = this.gl.getContextAttributes()!; + const layer = new XRWebGLLayer(session, this.gl, { + antialias: session.renderState.layers === undefined ? attributes.antialias : true, + alpha: true, + depth: attributes.depth, + stencil: attributes.stencil, + framebufferScaleFactor: scaleFactor + }); + session.updateRenderState({ baseLayer: layer }); + return layer; + } +} + +// The Core constructor registers the resource before asking the device to allocate it. +function unregisterResource(resource: Texture | RenderTarget): void { + const manager = resource.engine.resourceManager; + manager._deleteGraphicResource(resource); + manager._deleteReferResource(resource); +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/compressedTexture.ts b/packages/webgl1-polyfill/src/rhi-webgl/compressedTexture.ts new file mode 100644 index 0000000000..5645399523 --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/compressedTexture.ts @@ -0,0 +1,24 @@ +import { callOriginal } from "@/override"; + +const filled = new WeakMap(); +/** Allocate a compressed mip once, then use the original sub-image path. */ +export function setCompressedPixels(texture: any, cube: boolean, args: any[]): void { + if (!texture._formatDetail.isCompressed) return callOriginal(texture, ...args); + const [face, data, level = 0, x, y, width, height] = cube ? args : [0, ...args]; + let faces = filled.get(texture); + if (!faces) filled.set(texture, (faces = new Array(6).fill(0))); + const bit = 1 << level; + if (faces[face] & bit) return callOriginal(texture, ...args); + texture._bind(); + const gl = texture._gl; + gl.compressedTexImage2D( + cube ? gl.TEXTURE_CUBE_MAP_POSITIVE_X + face : texture._target, + level, + texture._formatDetail.internalFormat, + width || Math.max(1, texture._texture.width >> level) - x, + height || Math.max(1, texture._texture.height >> level) - y, + 0, + data + ); + faces[face] |= bit; +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/context.ts b/packages/webgl1-polyfill/src/rhi-webgl/context.ts new file mode 100644 index 0000000000..d1c30942d0 --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/context.ts @@ -0,0 +1,102 @@ +import type { GLCapabilityType } from "@galacean/engine-core"; +import type { WebGLGraphicDevice } from "@galacean/engine-rhi-webgl"; +type GLCapability = WebGLGraphicDevice["capability"]; +type CapabilityType = GLCapabilityType; +type CapabilityTypes = typeof GLCapabilityType; + +/** Adapt extension entry points and constants on the existing device context. */ +export function adaptContext(capability: GLCapability, types: CapabilityTypes): void { + const { rhi } = capability; + patchBufferSubData(rhi.gl); + const { gl } = rhi; + const { + blendMinMax, + depthTexture, + vertexArrayObject, + instancedArrays, + drawBuffers, + textureHalfFloat, + colorBufferHalfFloat, + WEBGL_colorBufferFloat, + sRGB + } = types; + function mapExtension(type: CapabilityType, names: Record): void { + const extension = rhi.requireExtension(type); + if (!extension) return; + const context = gl as unknown as Record; + for (const name in names) { + const value = extension[names[name]]; + context[name] = typeof value === "function" ? value.bind(extension) : value; + } + } + + mapExtension(blendMinMax, { + MIN: "MIN_EXT", + MAX: "MAX_EXT" + }); + mapExtension(depthTexture, { + UNSIGNED_INT_24_8: "UNSIGNED_INT_24_8_WEBGL" + }); + mapExtension(vertexArrayObject, { + createVertexArray: "createVertexArrayOES", + deleteVertexArray: "deleteVertexArrayOES", + isVertexArray: "isVertexArrayOES", + bindVertexArray: "bindVertexArrayOES" + }); + mapExtension(instancedArrays, { + drawArraysInstanced: "drawArraysInstancedANGLE", + drawElementsInstanced: "drawElementsInstancedANGLE", + vertexAttribDivisor: "vertexAttribDivisorANGLE" + }); + mapExtension(drawBuffers, { + MAX_DRAW_BUFFERS: "MAX_DRAW_BUFFERS_WEBGL" + }); + const items: Record = {}; + if (capability.canIUse(drawBuffers)) { + const maxDrawBuffers = capability.maxDrawBuffers; + for (let i = 0; i < maxDrawBuffers; i++) { + i != 0 && (items[`COLOR_ATTACHMENT${i}`] = `COLOR_ATTACHMENT${i}_WEBGL`); + items[`DRAW_BUFFER${i}`] = `DRAW_BUFFER${i}_WEBGL`; + } + mapExtension(drawBuffers, { + drawBuffers: "drawBuffersWEBGL", + ...items + }); + } + mapExtension(textureHalfFloat, { + HALF_FLOAT: "HALF_FLOAT_OES" + }); + mapExtension(colorBufferHalfFloat, { + RGBA16F: "RGBA16F_EXT" + }); + mapExtension(WEBGL_colorBufferFloat, { + RGBA32F: "RGBA32F_EXT" + }); + mapExtension(sRGB, { + SRGB8: "SRGB_EXT", + SRGB8_ALPHA8: "SRGB_ALPHA_EXT" + }); +} + +const patchedBuffers = new WeakSet(); + +function patchBufferSubData(gl: WebGLRenderingContext): void { + if (patchedBuffers.has(gl)) return; + const bufferSubData = gl.bufferSubData; + gl.bufferSubData = function ( + target: number, + byteOffset: number, + data: ArrayBuffer | ArrayBufferView | null, + sourceOffset?: number, + length?: number + ): void { + if (sourceOffset !== undefined && data && ArrayBuffer.isView(data)) { + const elementSize = "BYTES_PER_ELEMENT" in data ? (data.BYTES_PER_ELEMENT as number) : 1; + const sourceByteOffset = sourceOffset * elementSize; + const byteLength = length ? length * elementSize : data.byteLength - sourceByteOffset; + data = new Uint8Array(data.buffer, data.byteOffset + sourceByteOffset, byteLength); + } + bufferSubData.call(gl, target, byteOffset, data); + }; + patchedBuffers.add(gl); +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/textureFormat.ts b/packages/webgl1-polyfill/src/rhi-webgl/textureFormat.ts new file mode 100644 index 0000000000..85e60a9f9e --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/textureFormat.ts @@ -0,0 +1,114 @@ +import type { TextureFormat } from "@galacean/engine-core"; +interface TextureFormatDetail { + internalFormat: number; + baseFormat?: number; + dataType?: number; + isCompressed: boolean; + attachment?: number; + readFormat?: number; + alignment?: number; +} + +/** Resolve the WebGL1 storage format without changing the public texture format. */ +export function textureFormat( + format: TextureFormat, + isSRGBColorSpace: boolean, + gl: WebGLRenderingContext, + types: typeof TextureFormat, + renderbuffer = false +): TextureFormatDetail | undefined { + const { SRGB8, SRGB8_ALPHA8, HALF_FLOAT, UNSIGNED_INT_24_8 } = gl as WebGLRenderingContext & + Record<"SRGB8" | "SRGB8_ALPHA8" | "HALF_FLOAT" | "UNSIGNED_INT_24_8", number>; + switch (format) { + case types.R8G8B8: + return { + internalFormat: isSRGBColorSpace ? SRGB8 : gl.RGB, + baseFormat: isSRGBColorSpace ? SRGB8 : gl.RGB, + readFormat: gl.RGB, + dataType: gl.UNSIGNED_BYTE, + isCompressed: false, + alignment: 1 + }; + case types.R8G8B8A8: + return { + internalFormat: isSRGBColorSpace ? SRGB8_ALPHA8 : gl.RGBA, + baseFormat: isSRGBColorSpace ? SRGB8_ALPHA8 : gl.RGBA, + readFormat: gl.RGBA, + dataType: gl.UNSIGNED_BYTE, + isCompressed: false, + alignment: 4 + }; + case types.R4G4B4A4: + return { + internalFormat: gl.RGBA, + baseFormat: gl.RGBA, + dataType: gl.UNSIGNED_SHORT_4_4_4_4, + isCompressed: false, + alignment: 2 + }; + case types.R5G5B5A1: + return { + internalFormat: gl.RGBA, + baseFormat: gl.RGBA, + dataType: gl.UNSIGNED_SHORT_5_5_5_1, + isCompressed: false, + alignment: 2 + }; + case types.R5G6B5: + return { + internalFormat: gl.RGB, + baseFormat: gl.RGB, + dataType: gl.UNSIGNED_SHORT_5_6_5, + isCompressed: false, + alignment: 2 + }; + case types.R16G16B16A16: + return { + internalFormat: gl.RGBA, + baseFormat: gl.RGBA, + dataType: HALF_FLOAT, + isCompressed: false, + alignment: 8 + }; + case types.R32G32B32A32: + return { + internalFormat: gl.RGBA, + baseFormat: gl.RGBA, + dataType: gl.FLOAT, + isCompressed: false, + alignment: 8 + }; + case types.Depth: + return { + internalFormat: renderbuffer ? gl.DEPTH_COMPONENT16 : gl.DEPTH_COMPONENT, + baseFormat: gl.DEPTH_COMPONENT, + dataType: gl.UNSIGNED_SHORT, + isCompressed: false, + attachment: gl.DEPTH_ATTACHMENT + }; + case types.DepthStencil: + return { + internalFormat: gl.DEPTH_STENCIL, + baseFormat: gl.DEPTH_STENCIL, + dataType: UNSIGNED_INT_24_8, + isCompressed: false, + attachment: gl.DEPTH_STENCIL_ATTACHMENT + }; + case types.Depth16: + return { + internalFormat: renderbuffer ? gl.DEPTH_COMPONENT16 : gl.DEPTH_COMPONENT, + baseFormat: gl.DEPTH_COMPONENT, + dataType: gl.UNSIGNED_SHORT, + isCompressed: false, + attachment: gl.DEPTH_ATTACHMENT + }; + case types.Depth24Stencil8: + return { + internalFormat: gl.DEPTH_STENCIL, + baseFormat: gl.DEPTH_STENCIL, + dataType: UNSIGNED_INT_24_8, + isCompressed: false, + attachment: gl.DEPTH_STENCIL_ATTACHMENT + }; + } +} diff --git a/packages/webgl1-polyfill/src/rhi-webgl/textureStorage.js b/packages/webgl1-polyfill/src/rhi-webgl/textureStorage.js new file mode 100644 index 0000000000..33109ea663 --- /dev/null +++ b/packages/webgl1-polyfill/src/rhi-webgl/textureStorage.js @@ -0,0 +1,34 @@ +export function textureStorage(isCube) { + const gl = this._gl; + const { internalFormat, baseFormat, dataType } = this._formatDetail; + const { mipmapCount, width, height, _isDepthTexture } = this._texture; + this._bind(); + if (!isCube) { + if (_isDepthTexture) { + gl.texImage2D(this._target, 0, internalFormat, width, height, 0, baseFormat, dataType, null); + } else { + for (let i = 0; i < mipmapCount; i++) { + const mipWidth = Math.max(1, width >> i); + const mipHeight = Math.max(1, height >> i); + gl.texImage2D(this._target, i, internalFormat, mipWidth, mipHeight, 0, baseFormat, dataType, null); + } + } + } else { + for (let i = 0; i < mipmapCount; i++) { + const size = Math.max(1, width >> i); + for (let faceIndex = 0; faceIndex < 6; faceIndex++) { + gl.texImage2D( + gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex, + i, + internalFormat, + size, + size, + 0, + baseFormat, + dataType, + null + ); + } + } + } +} diff --git a/packages/webgl1-polyfill/tests/browser/core/2d/atlas/FontAtlas.test.ts b/packages/webgl1-polyfill/tests/browser/core/2d/atlas/FontAtlas.test.ts new file mode 100644 index 0000000000..258c55cc18 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/2d/atlas/FontAtlas.test.ts @@ -0,0 +1,13 @@ +import { FontAtlas, TextureFormat } from "../../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../../helpers/createEngine"; + +it("uses Alpha8 for glyph storage", async () => { + const { engine } = await createEngine(); + try { + const atlas = new FontAtlas(engine); + expect(atlas.texture.format).toBe(TextureFormat.Alpha8); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/BasicResources.test.ts b/packages/webgl1-polyfill/tests/browser/core/BasicResources.test.ts new file mode 100644 index 0000000000..08761dcf5f --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/BasicResources.test.ts @@ -0,0 +1,12 @@ +import { expect, it } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("omits default array and integer textures", async () => { + const { engine } = await createEngine(); + try { + expect(engine._basicResources.whiteTexture2DArray).toBeUndefined(); + expect(engine._basicResources.uintWhiteTexture2D).toBeUndefined(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/Camera.test.ts b/packages/webgl1-polyfill/tests/browser/core/Camera.test.ts new file mode 100644 index 0000000000..8260a7f842 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/Camera.test.ts @@ -0,0 +1,41 @@ +import { Camera, Logger, TextureFormat } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("keeps HDR disabled without half-float textures", async () => { + const { engine } = await createEngine(["OES_texture_half_float"]); + try { + const camera = engine.sceneManager.activeScene!.createRootEntity().addComponent(Camera); + camera.enableHDR = true; + expect(camera.enableHDR).toBe(false); + } finally { + engine.destroy(); + } +}); + +it("uses RGBA16F for HDR and clamps the requested mip level", async () => { + const { engine } = await createEngine(); + try { + const scene = engine.sceneManager.activeScene!; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + expect(camera._getInternalColorTextureFormat()).toBe(TextureFormat.R8G8B8A8); + camera.enableHDR = true; + expect(camera.enableHDR).toBe(true); + expect(camera._getInternalColorTextureFormat()).toBe(TextureFormat.R16G16B16A16); + camera.enableHDR = false; + const error = vi.spyOn(Logger, "error"); + try { + const renderPipeline = vi.spyOn(camera._renderPipeline, "render"); + camera.render(undefined, 1); + expect(renderPipeline.mock.calls[0][2]).toBe(0); + expect(error).toHaveBeenCalledWith("mipLevel only take effect in WebGL2.0"); + } finally { + error.mockRestore(); + } + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/Engine.test.ts b/packages/webgl1-polyfill/tests/browser/core/Engine.test.ts new file mode 100644 index 0000000000..d23a5132f6 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/Engine.test.ts @@ -0,0 +1,59 @@ +import { + Camera, + MeshRenderer, + PrimitiveMesh, + ShaderMacro, + Texture2D, + TextureFormat, + UnlitMaterial +} from "../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it.each([true, false])( + "initializes default depth textures with depth texture extension enabled=%s", + async (withDepthTexture) => { + const { engine } = await createEngine(withDepthTexture ? [] : ["WEBGL_depth_texture"]); + try { + expect(engine._macroCollection.isEnable(ShaderMacro.getByName("ENGINE_NO_DEPTH_TEXTURE"))).toBe( + !withDepthTexture + ); + expect(engine._depthTexture2D?.format).toBe(withDepthTexture ? TextureFormat.Depth16 : undefined); + } finally { + engine.destroy(); + } + } +); + +it("decodes sRGB texels in the shader when EXT_sRGB is absent", async () => { + const { engine, gl } = await createEngine(["EXT_sRGB"]); + try { + expect(engine._macroCollection.isEnable(ShaderMacro.getByName("ENGINE_NO_SRGB"))).toBe(true); + const scene = engine.sceneManager.activeScene!; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + const renderer = scene.createRootEntity().addComponent(MeshRenderer); + renderer.mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + const material = new UnlitMaterial(engine); + renderer.setMaterial(material); + const sample = (srgb: boolean) => { + const texture = new Texture2D(engine, 1, 1, TextureFormat.R8G8B8A8, false, srgb); + texture.setPixelBuffer(new Uint8Array([128, 128, 128, 255])); + material.baseTexture = texture; + camera.render(); + const pixel = new Uint8Array(4); + gl.readPixels(8, 8, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + return pixel[0]; + }; + const raw = sample(false); + const decoded = sample(true); + // Unlit samples both textures with texture2DSRGB. 128/255 decodes to about 55/255. + expect(Math.abs(raw - 55)).toBeLessThanOrEqual(2); + expect(Math.abs(decoded - 55)).toBeLessThanOrEqual(2); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/BasicRenderPipeline.test.ts b/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/BasicRenderPipeline.test.ts new file mode 100644 index 0000000000..f8d68104de --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/BasicRenderPipeline.test.ts @@ -0,0 +1,23 @@ +import { Camera, Color } from "../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("renders without framebuffer blit", async () => { + const { engine, gl } = await createEngine(); + try { + const scene = engine.sceneManager.activeScene!; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + scene.background.solidColor = new Color(0, 1, 0, 1); + camera.render(); + const pixel = new Uint8Array(4); + gl.readPixels(0, 0, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect([...pixel]).toEqual([0, 255, 0, 255]); + expect((camera._renderPipeline as any)._canUseBlitFrameBuffer).toBe(false); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/DepthOnlyPass.test.ts b/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/DepthOnlyPass.test.ts new file mode 100644 index 0000000000..365f1ceab6 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/RenderPipeline/DepthOnlyPass.test.ts @@ -0,0 +1,24 @@ +import { Camera, DepthOnlyPass, TextureFormat } from "../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it.each([true, false])( + "configures the depth pass with depth texture extension enabled=%s", + async (withDepthTexture) => { + const { engine } = await createEngine(withDepthTexture ? [] : ["WEBGL_depth_texture"]); + + try { + const camera = engine.sceneManager.activeScene!.createRootEntity().addComponent(Camera); + const depthPass = new DepthOnlyPass(engine); + expect(depthPass.supportDepthTexture).toBe(withDepthTexture); + + if (withDepthTexture) { + depthPass.onConfig(camera); + expect(depthPass.renderTarget?.depthTexture?.format).toBe(TextureFormat.Depth24Stencil8); + depthPass.renderTarget?.destroy(); + } + } finally { + engine.destroy(); + } + } +); diff --git a/packages/webgl1-polyfill/tests/browser/core/SystemInfo.test.ts b/packages/webgl1-polyfill/tests/browser/core/SystemInfo.test.ts new file mode 100644 index 0000000000..b418f89afe --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/SystemInfo.test.ts @@ -0,0 +1,12 @@ +import { SystemInfo, TextureFormat } from "../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("reports RG8 as unsupported", async () => { + const { engine } = await createEngine(); + try { + expect(SystemInfo.supportsTextureFormat(engine, TextureFormat.R8G8)).toBe(false); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/mesh/MeshRenderer.test.ts b/packages/webgl1-polyfill/tests/browser/core/mesh/MeshRenderer.test.ts new file mode 100644 index 0000000000..3941f0ce17 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/mesh/MeshRenderer.test.ts @@ -0,0 +1,38 @@ +import { + Camera, + Color, + MeshRenderer, + PrimitiveMesh, + UnlitMaterial, + Vector3 +} from "../../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("does not batch identical render elements without instancing", async () => { + const { engine, gl } = await createEngine(["ANGLE_instanced_arrays"]); + try { + const scene = engine.sceneManager.activeScene!; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + const mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + const material = new UnlitMaterial(engine); + material.baseColor = new Color(1, 0, 0, 1); + for (const x of [-0.5, 0.5]) { + const entity = scene.createRootEntity(); + entity.transform.position = new Vector3(x, 0, 0); + const renderer = entity.addComponent(MeshRenderer); + renderer.mesh = mesh; + renderer.setMaterial(material); + const element = { component: renderer, material } as Parameters[0]; + expect(renderer._canBatch(element, element)).toBe(false); + } + const draw = vi.spyOn(gl, "drawElements"); + camera.render(); + expect(draw).toHaveBeenCalledTimes(2); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/mesh/PrimitiveMesh.test.ts b/packages/webgl1-polyfill/tests/browser/core/mesh/PrimitiveMesh.test.ts new file mode 100644 index 0000000000..056455148d --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/mesh/PrimitiveMesh.test.ts @@ -0,0 +1,14 @@ +import { PrimitiveMesh } from "../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("rejects oversized meshes without the uint index extension", async () => { + const { engine } = await createEngine(["OES_element_index_uint"]); + try { + expect(() => PrimitiveMesh.createPlane(engine, 1, 1, { widthSegments: 256, depthSegments: 256 })).toThrow( + "The vertex count is over limit." + ); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/ParticleGenerator.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/ParticleGenerator.test.ts new file mode 100644 index 0000000000..b0e88d25d7 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/ParticleGenerator.test.ts @@ -0,0 +1,19 @@ +import { ParticleRenderer } from "../../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("does not create a simulator even when a module requests transform feedback", async () => { + const { engine } = await createEngine(); + try { + const scene = engine.sceneManager.activeScene!; + const renderer = scene.createRootEntity().addComponent(ParticleRenderer); + const generator = renderer.generator; + // Isolate the generator guard from the NoiseModule setter, which already rejects enable. + const noise = vi.spyOn(generator.noise, "enabled", "get").mockReturnValue(true); + expect(() => generator._setTransformFeedback()).not.toThrow(); + expect(generator._feedbackSimulator).toBeNull(); + noise.mockRestore(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/ParticleRenderer.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/ParticleRenderer.test.ts new file mode 100644 index 0000000000..505c358bc3 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/ParticleRenderer.test.ts @@ -0,0 +1,21 @@ +import { ParticleRenderer, Renderer } from "../../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("skips particle registration and render preparation without instancing", async () => { + const { engine } = await createEngine(["ANGLE_instanced_arrays"]); + try { + const basePrepare = vi.spyOn(Renderer.prototype, "_prepareRender"); + try { + const scene = engine.sceneManager.activeScene!; + const particle = scene.createRootEntity().addComponent(ParticleRenderer); + expect(particle._particleSystemManager).toBeNull(); + particle._prepareRender({} as Parameters[0]); + expect(basePrepare).not.toHaveBeenCalled(); + } finally { + basePrepare.mockRestore(); + } + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/modules/InheritVelocityModule.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/modules/InheritVelocityModule.test.ts new file mode 100644 index 0000000000..11e08d174d --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/modules/InheritVelocityModule.test.ts @@ -0,0 +1,111 @@ +import { + Burst, + Camera, + Color, + CurveKey, + Engine, + ParticleCompositeCurve, + ParticleCurve, + ParticleInheritVelocityMode, + ParticleMaterial, + ParticleRenderer, + ParticleSimulationSpace, + ParticleStopMode, + WebGLEngine +} from "../../../../../../galacean/dist/module.js"; +import { afterEach, expect, it, vi } from "vitest"; +import { createWebGL1Canvas } from "../../../../helpers/canvas"; +import { createEngine } from "../../../../helpers/createEngine"; + +const originalNow = performance.now; +afterEach(() => { + performance.now = originalNow; +}); + +function tick(engine: Engine, time: { value: number }, deltaMs: number = 100): void { + //@ts-ignore + engine._vSyncCount = Infinity; + //@ts-ignore + engine._time._lastSystemTime = time.value / 1000; + performance.now = function () { + time.value += deltaMs; + return time.value; + }; + engine.update(); +} + +function createParticleRenderer(engine: Engine, name: string): ParticleRenderer { + const entity = engine.sceneManager.activeScene.createRootEntity(name); + const renderer = entity.addComponent(ParticleRenderer); + const material = new ParticleMaterial(engine); + material.baseColor = new Color(1, 1, 1, 1); + renderer.setMaterial(material); + + const generator = renderer.generator; + generator.useAutoRandomSeed = false; + generator.main.duration = 5; + generator.main.maxParticles = 10; + generator.main.startLifetime.constant = 1; + generator.main.startSpeed.constant = 0; + generator.main.simulationSpace = ParticleSimulationSpace.World; + generator.emission.rateOverTime.constant = 0; + generator.emission.addBurst(new Burst(0, new ParticleCompositeCurve(1))); + generator.inheritVelocity.enabled = true; + generator.inheritVelocity.mode = ParticleInheritVelocityMode.Current; + + return renderer; +} + +it("Initial Curve remains available on WebGL1", async () => { + const webgl1Engine = await WebGLEngine.create({ + canvas: createWebGL1Canvas() + }); + const camera = webgl1Engine.sceneManager.activeScene.createRootEntity("Camera"); + camera.addComponent(Camera); + camera.transform.setPosition(0, 0, 10); + webgl1Engine.run(); + + const renderer = createParticleRenderer(webgl1Engine, "initial-inherit-velocity-webgl1"); + const generator = renderer.generator; + generator.inheritVelocity.mode = ParticleInheritVelocityMode.Initial; + generator.inheritVelocity.curve = new ParticleCompositeCurve( + new ParticleCurve(new CurveKey(0, 0), new CurveKey(1, 1)) + ); + generator.emission.clearBurst(); + generator.emission.addBurst(new Burst(0.15, new ParticleCompositeCurve(1))); + expect(generator._feedbackSimulator).to.not.exist; + + const webgl1Time = { value: 0 }; + generator.stop(true, ParticleStopMode.StopEmittingAndClear); + generator.play(); + tick(webgl1Engine, webgl1Time); + renderer.entity.transform.setPosition(1, 0, 0); + tick(webgl1Engine, webgl1Time); + + const vertices = (generator as any)._instanceVertices as Float32Array; + expect(vertices[15]).to.equal(0); + expect(vertices[40]).to.be.closeTo(10, 1e-5); + + webgl1Engine.destroy(); +}); + +it("updates emitter velocity on the CPU in World space with Current mode", async () => { + const { engine, gl } = await createEngine(); + try { + const scene = engine.sceneManager.activeScene!; + const renderer = scene.createRootEntity().addComponent(ParticleRenderer); + const generator = renderer.generator; + const inherit = generator.inheritVelocity; + generator.main.simulationSpace = ParticleSimulationSpace.World; + inherit.enabled = true; + inherit.mode = ParticleInheritVelocityMode.Current; + const resync = vi.spyOn(inherit, "_resyncEmitterVelocity"); + renderer.entity.transform.setPosition(1, 0, 0); + inherit._updateEmitterVelocity(0.1); + expect(resync).toHaveBeenCalledOnce(); + expect(inherit._needTransformFeedback()).toBe(false); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/modules/LimitVelocityOverLifetimeModule.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/modules/LimitVelocityOverLifetimeModule.test.ts new file mode 100644 index 0000000000..8299748ef5 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/modules/LimitVelocityOverLifetimeModule.test.ts @@ -0,0 +1,15 @@ +import { ParticleRenderer } from "../../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../../helpers/createEngine"; + +it("keeps limitVelocityOverLifetime disabled when enabled on WebGL1", async () => { + const { engine } = await createEngine(); + try { + const particle = engine.sceneManager.activeScene!.createRootEntity().addComponent(ParticleRenderer).generator; + particle.limitVelocityOverLifetime.enabled = true; + expect(particle.limitVelocityOverLifetime.enabled).toBe(false); + expect(particle._feedbackSimulator).toBeNull(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/modules/NoiseModule.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/modules/NoiseModule.test.ts new file mode 100644 index 0000000000..94465fb778 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/modules/NoiseModule.test.ts @@ -0,0 +1,15 @@ +import { ParticleRenderer } from "../../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../../helpers/createEngine"; + +it("keeps noise disabled when enabled on WebGL1", async () => { + const { engine } = await createEngine(); + try { + const particle = engine.sceneManager.activeScene!.createRootEntity().addComponent(ParticleRenderer).generator; + particle.noise.enabled = true; + expect(particle.noise.enabled).toBe(false); + expect(particle._feedbackSimulator).toBeNull(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/modules/SubEmittersModule.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/modules/SubEmittersModule.test.ts new file mode 100644 index 0000000000..4c05b9b3cc --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/modules/SubEmittersModule.test.ts @@ -0,0 +1,82 @@ +import { + Burst, + Camera, + Color, + Engine, + ParticleCompositeCurve, + ParticleMaterial, + ParticleRenderer, + ParticleStopMode, + ParticleSubEmitterType, + WebGLEngine +} from "../../../../../../galacean/dist/module.js"; +import { afterEach, expect, it } from "vitest"; +import { createWebGL1Canvas } from "../../../../helpers/canvas"; + +const originalNow = performance.now; +afterEach(() => { + performance.now = originalNow; +}); + +function updateEngine(engine: Engine, frames: number, deltaTime = 100) { + //@ts-ignore + engine._vSyncCount = Infinity; + //@ts-ignore + engine._time._lastSystemTime = 0; + let times = 0; + performance.now = function () { + times++; + return times * deltaTime; + }; + for (let i = 0; i < frames; i++) { + engine.update(); + } + const currentTime = times * deltaTime; + performance.now = () => currentTime; +} + +function createSubEmitter(engine: Engine, name: string, scene = engine.sceneManager.activeScene): ParticleRenderer { + const root = scene.getRootEntity() ?? scene.createRootEntity(); + const entity = root.createChild(name); + const renderer = entity.addComponent(ParticleRenderer); + const material = new ParticleMaterial(engine); + material.baseColor = new Color(1, 1, 1, 1); + renderer.setMaterial(material); + + const generator = renderer.generator; + generator.useAutoRandomSeed = false; + generator.main.duration = 5; + generator.main.isLoop = false; + generator.main.maxParticles = 1000; + generator.main.startLifetime.constant = 10; + generator.emission.rateOverTime.constant = 0; + + return renderer; +} + +it("Sub-emitter stays inert on WebGL1 instead of crashing on Death", async () => { + const fallback = await WebGLEngine.create({ + canvas: createWebGL1Canvas() + }); + fallback.sceneManager.activeScene!.createRootEntity().addComponent(Camera); + const parent = createSubEmitter(fallback, "WebGL1_Parent"); + const child = createSubEmitter(fallback, "WebGL1_Child"); + parent.generator.main.startLifetime.constant = 0.5; + + try { + parent.generator.subEmitters.enabled = true; + parent.generator.subEmitters.addSubEmitter(child, ParticleSubEmitterType.Death, undefined, undefined, 3); + + expect(parent.generator.subEmitters.enabled).to.equal(false); + expect((parent.generator as any)._feedbackSimulator).to.not.exist; + + parent.generator.emission.addBurst(new Burst(0, new ParticleCompositeCurve(4), 1, 0.01)); + parent.generator.stop(true, ParticleStopMode.StopEmittingAndClear); + child.generator.stop(true, ParticleStopMode.StopEmittingAndClear); + parent.generator.play(); + expect(() => updateEngine(fallback, 10)).to.not.throw(); // parent death must not crash + expect(child.generator._getAliveParticleCount()).to.equal(0); // Death inert on WebGL1 + } finally { + fallback.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/particle/modules/VelocityOverLifetimeModule.test.ts b/packages/webgl1-polyfill/tests/browser/core/particle/modules/VelocityOverLifetimeModule.test.ts new file mode 100644 index 0000000000..bf7d439609 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/particle/modules/VelocityOverLifetimeModule.test.ts @@ -0,0 +1,18 @@ +import { ParticleRenderer } from "../../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../../helpers/createEngine"; + +it("does not request transform feedback when orbital velocity is active", async () => { + const { engine } = await createEngine(); + try { + const particle = engine.sceneManager.activeScene!.createRootEntity().addComponent(ParticleRenderer).generator; + const velocity = particle.velocityOverLifetime; + velocity.enabled = true; + velocity.orbitalX.constant = 1; + expect(velocity._isOrbitalActive()).toBe(true); + expect(velocity._needTransformFeedback()).toBe(false); + expect(particle._feedbackSimulator).toBeNull(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/shader/ShaderPass.test.ts b/packages/webgl1-polyfill/tests/browser/core/shader/ShaderPass.test.ts new file mode 100644 index 0000000000..0326361425 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/shader/ShaderPass.test.ts @@ -0,0 +1,68 @@ +import { + Engine, + Shader, + ShaderLanguage, + ShaderMacroCollection, + WebGLEngine +} from "../../../../../galacean/dist/module.js"; +import { ShaderCompiler } from "../../../../../shader-compiler/dist/module.js"; +import { expect, it } from "vitest"; +import { makeFallbackCanvas } from "../../../helpers/canvas"; + +it("compiles shared source shader instructions created before fallback without changing the native variant", async ({ + skip +}) => { + const canvas = document.createElement("canvas"); + if (!canvas.getContext("webgl2")) skip(); + const native = await WebGLEngine.create({ canvas, shaderCompiler: new ShaderCompiler() }); + const shader = Shader.create( + `Shader "BeforeFallback" { + SubShader "Default" { Pass "Forward" { + VertexShader = vert; + FragmentShader = frag; + #include "ShaderLibrary/Common/Common.glsl" + void vert() { gl_Position = vec4(0.0, 0.0, 0.0, 1.0); } + vec4 frag() { mat2 matrix = INVERSE_MAT(mat2(1.0)); return vec4(matrix[0], 0.0, 1.0); } + } } + }`, + ShaderLanguage.GLSLES100 + ); + let legacy: WebGLEngine | undefined; + try { + expect(shader.compileVariant(native, [])).toBe(true); + legacy = await WebGLEngine.create({ canvas: makeFallbackCanvas().canvas }); + expect(shader.compileVariant(legacy, [])).toBe(true); + expect(shader.compileVariant(native, [])).toBe(true); + } finally { + shader.destroy(); + legacy?.destroy(); + native.destroy(); + } +}); + +it("isolates shared shader passes when WebGL1 and WebGL2 compile in either order", async ({ skip }) => { + const nativeCanvas = document.createElement("canvas"); + if (!nativeCanvas.getContext("webgl2")) skip(); + const native = await WebGLEngine.create({ canvas: nativeCanvas }); + const legacy = await WebGLEngine.create({ canvas: makeFallbackCanvas().canvas }); + try { + const context = legacy._hardwareRenderer.gl; + const macros = new ShaderMacroCollection(); + for (const shader of [Engine._builtinShaders.unlit, Engine._builtinShaders.text]) { + const pass = shader.subShaders[0].passes[0]; + const instructions = pass._vertexShaderInstructions; + for (const engine of [legacy, native, native, legacy]) { + const source = (pass as any)._compileShaderSource(engine, macros, false); + expect(source.vertexSource.trimStart().startsWith(engine === native ? "#version 300 es" : "#version 100")).toBe( + true + ); + expect(pass._getShaderProgram(engine, macros).isValid).toBe(true); + expect(pass._vertexShaderInstructions).toBe(instructions); + expect(engine._hardwareRenderer.gl.getError()).toBe(0); + } + } + } finally { + legacy.destroy(); + native.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/shader/ShaderProgram.test.ts b/packages/webgl1-polyfill/tests/browser/core/shader/ShaderProgram.test.ts new file mode 100644 index 0000000000..85eb88a24c --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/shader/ShaderProgram.test.ts @@ -0,0 +1,18 @@ +import { Engine, ShaderMacroCollection } from "../../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("links a WebGL1 program without querying uniform blocks", async () => { + const { engine, gl } = await createEngine(); + try { + const getProgramParameter = vi.spyOn(gl, "getProgramParameter"); + const pass = Engine._builtinShaders.unlit.subShaders[0].passes[0]; + expect(pass._getShaderProgram(engine, new ShaderMacroCollection()).isValid).toBe(true); + expect(getProgramParameter).toHaveBeenCalled(); + // ACTIVE_UNIFORM_BLOCKS is a WebGL2 program parameter. + expect(getProgramParameter.mock.calls.every(([, pname]) => pname !== 0x8a36 && pname !== undefined)).toBe(true); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/shader/state/BlendState.test.ts b/packages/webgl1-polyfill/tests/browser/core/shader/state/BlendState.test.ts new file mode 100644 index 0000000000..7852a03830 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/shader/state/BlendState.test.ts @@ -0,0 +1,13 @@ +import { BlendOperation, BlendState } from "../../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../../helpers/createEngine"; + +it("rejects Min without EXT_blend_minmax", async () => { + const { engine } = await createEngine(["EXT_blend_minmax"]); + try { + const device = engine._hardwareRenderer; + expect(() => (BlendState as any)._getGLBlendOperation(device, BlendOperation.Min)).toThrow("BlendOperation.Min"); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/shadow/CascadedShadowCasterPass.test.ts b/packages/webgl1-polyfill/tests/browser/core/shadow/CascadedShadowCasterPass.test.ts new file mode 100644 index 0000000000..b1f36f0b0d --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/shadow/CascadedShadowCasterPass.test.ts @@ -0,0 +1,86 @@ +import { + Camera, + CascadedShadowCasterPass, + DirectLight, + MeshRenderer, + PBRMaterial, + PrimitiveMesh, + ShadowType, + TextureFormat, + Vector3 +} from "../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it.each([true, false])( + "configures shadow storage with depth texture extension enabled=%s", + async (withDepthTexture) => { + const { engine, gl } = await createEngine(withDepthTexture ? [] : ["WEBGL_depth_texture"]); + try { + const camera = engine.sceneManager.activeScene!.createRootEntity().addComponent(Camera); + const shadow = new CascadedShadowCasterPass(camera) as any; + const shadowFormat = shadow._getShadowFormat(); + expect(shadowFormat).toBe(withDepthTexture ? TextureFormat.Depth16 : TextureFormat.R8G8B8A8); + shadow._shadowMapFormat = shadowFormat; + shadow._shadowMapSize.set(4, 4, 4, 4); + const context = { + setRenderTarget(target) { + target._platformRenderTarget.activeRenderTarget(0, 0); + gl.viewport(0, 0, 4, 4); + } + }; + shadow._prepareShadowMap(context); + expect(shadow._depthTexture.format).toBe(withDepthTexture ? TextureFormat.Depth16 : TextureFormat.R8G8B8A8); + if (!withDepthTexture) { + const pixel = new Uint8Array(4); + gl.readPixels(0, 0, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect([...pixel]).toEqual([255, 255, 255, 255]); + } + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } + } +); + +it("renders a visible shadow through the color map when depth textures are unavailable", async () => { + const { engine, gl } = await createEngine(["WEBGL_depth_texture"]); + try { + const scene = engine.sceneManager.activeScene!; + scene.shadowDistance = 20; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 4, 6); + cameraEntity.transform.lookAt(new Vector3(0, 0, 0)); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + const lightEntity = scene.createRootEntity(); + lightEntity.transform.setPosition(-3, 6, 0); + lightEntity.transform.lookAt(new Vector3()); + const light = lightEntity.addComponent(DirectLight); + light.shadowType = ShadowType.Hard; + + const plane = scene.createRootEntity().addComponent(MeshRenderer); + plane.mesh = PrimitiveMesh.createPlane(engine, 10, 10); + plane.castShadows = false; + plane.setMaterial(new PBRMaterial(engine)); + const cubeEntity = scene.createRootEntity(); + cubeEntity.transform.setPosition(0, 0.5, 0); + const cube = cubeEntity.addComponent(MeshRenderer); + cube.mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + cube.setMaterial(new PBRMaterial(engine)); + + const unshadowed = new Uint8Array(16 * 16 * 4); + const shadowed = new Uint8Array(unshadowed.length); + cube.castShadows = false; + scene._updateRendering(0); + camera.render(); + gl.readPixels(0, 0, 16, 16, gl.RGBA, gl.UNSIGNED_BYTE, unshadowed); + cube.castShadows = true; + camera.render(); + gl.readPixels(0, 0, 16, 16, gl.RGBA, gl.UNSIGNED_BYTE, shadowed); + expect(shadowed.some((value, i) => i % 4 !== 3 && value + 8 < unshadowed[i])).toBe(true); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/texture/Texture.test.ts b/packages/webgl1-polyfill/tests/browser/core/texture/Texture.test.ts new file mode 100644 index 0000000000..7963e6d51b --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/texture/Texture.test.ts @@ -0,0 +1,18 @@ +import { Logger, Texture2D, TextureDepthCompareFunction } from "../../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("leaves the public depth compare function unchanged", async () => { + const { engine } = await createEngine(); + try { + const texture = new Texture2D(engine, 4, 4); + const warn = vi.spyOn(Logger, "warn"); + const compare = texture.depthCompareFunction; + texture.depthCompareFunction = TextureDepthCompareFunction.Less; + expect(texture.depthCompareFunction).toBe(compare); + expect(warn).toHaveBeenCalledWith("depthCompareFunction only support WebGL2"); + warn.mockRestore(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/core/texture/TextureUtils.test.ts b/packages/webgl1-polyfill/tests/browser/core/texture/TextureUtils.test.ts new file mode 100644 index 0000000000..9e3312e7a5 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/core/texture/TextureUtils.test.ts @@ -0,0 +1,14 @@ +import { TextureFormat, TextureUtils } from "../../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../../helpers/createEngine"; + +it("rejects automatic mipmap generation for sRGB RGBA8", async () => { + const { engine } = await createEngine(); + try { + expect(TextureUtils.supportGenerateMipmapsWithCorrection(engine, 4, 4, TextureFormat.R8G8B8A8, true, true)).toBe( + false + ); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/index.test.ts b/packages/webgl1-polyfill/tests/browser/index.test.ts new file mode 100644 index 0000000000..aa5dd91c24 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/index.test.ts @@ -0,0 +1,105 @@ +import { Camera, Color, ParticleRenderer, WebGLEngine, WebGLGraphicDevice } from "../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { makeFallbackCanvas } from "../helpers/canvas"; + +it("loads one compatibility module for concurrent real fallback devices and keeps WebGL2 TF active", async ({ + skip +}) => { + const nativeCanvas = document.createElement("canvas"); + if (!nativeCanvas.getContext("webgl2")) skip(); + const native = await WebGLEngine.create({ canvas: nativeCanvas }); + const nativeDevice = native._hardwareRenderer as WebGLGraphicDevice; + const scene = native.sceneManager.activeScene!; + const nativeParticle = scene.createRootEntity().addComponent(ParticleRenderer).generator; + nativeParticle.noise.enabled = true; + const nativeSimulation = nativeParticle._feedbackSimulator; + const first = makeFallbackCanvas(); + const second = makeFallbackCanvas(); + const engines: WebGLEngine[] = []; + + try { + expect(nativeDevice.isWebGL2).toBe(true); + expect(nativeSimulation).not.toBeNull(); + + await Promise.all( + [first, second].map(async ({ canvas }) => { + const engine = await WebGLEngine.create({ canvas }); + engines.push(engine); + const device = engine._hardwareRenderer as WebGLGraphicDevice; + const gl = canvas.getContext("webgl")!; + expect(device.isWebGL2).toBe(false); + expect(device.gl).toBe(gl); + expect(gl.getParameter(gl.VERSION)).toMatch(/^WebGL 1/); + + const root = engine.sceneManager.activeScene!.createRootEntity(); + const camera = root.addComponent(Camera); + camera.enablePostProcess = false; + engine.sceneManager.activeScene!.background.solidColor = new Color(1, 0, 0, 1); + const particle = root.createChild().addComponent(ParticleRenderer).generator; + particle.noise.enabled = true; + particle.limitVelocityOverLifetime.enabled = true; + expect(particle.noise.enabled).toBe(false); + expect(particle.limitVelocityOverLifetime.enabled).toBe(false); + expect(particle._feedbackSimulator).toBeNull(); + camera.render(); + const pixel = new Uint8Array(4); + gl.readPixels(0, 0, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect(Array.from(pixel)).toEqual([255, 0, 0, 255]); + expect(gl.getError()).toBe(gl.NO_ERROR); + }) + ); + + expect( + performance + .getEntriesByType("resource") + .filter((entry) => entry.name.includes("https://cdn.jsdelivr.net/npm/@galacean/engine-webgl1-polyfill@")) + ).toHaveLength(1); + nativeParticle._setTransformFeedback(); + expect(nativeParticle._feedbackSimulator).toBe(nativeSimulation); + expect(nativeParticle.noise.enabled).toBe(true); + expect(first.attempts.mock.calls.filter(([type]) => type === "webgl2")).toHaveLength(1); + expect(second.attempts.mock.calls.filter(([type]) => type === "webgl2")).toHaveLength(1); + } finally { + engines.forEach((engine) => engine.destroy()); + native.destroy(); + } +}); + +it("restores the WebGL1 device and redraws without fetching the module again", async () => { + const { canvas } = makeFallbackCanvas(); + const engine = await WebGLEngine.create({ canvas }); + const gl = canvas.getContext("webgl")!; + try { + const scene = engine.sceneManager.activeScene!; + const camera = scene.createRootEntity().addComponent(Camera); + camera.enablePostProcess = false; + scene.background.solidColor = new Color(0, 1, 0, 1); + + const requests = () => + performance + .getEntriesByType("resource") + .filter((entry) => entry.name.includes("https://cdn.jsdelivr.net/npm/@galacean/engine-webgl1-polyfill@")) + .length; + const requestCount = requests(); + const extension = gl.getExtension("WEBGL_lose_context")!; + const lost = new Promise((resolve) => engine.once("devicelost", () => resolve())); + extension.loseContext(); + await lost; + expect(gl.isContextLost()).toBe(true); + + const restored = new Promise((resolve) => engine.once("devicerestored", () => resolve())); + // Chromium rate-limits restoration requests immediately after context loss. + await new Promise((resolve) => setTimeout(resolve, 100)); + extension.restoreContext(); + await restored; + expect(engine._hardwareRenderer.gl).toBe(gl); + camera.render(); + const pixel = new Uint8Array(4); + gl.readPixels(0, 0, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect(Array.from(pixel)).toEqual([0, 255, 0, 255]); + expect(gl.getError()).toBe(gl.NO_ERROR); + expect(requests()).toBe(requestCount); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/override.test.ts b/packages/webgl1-polyfill/tests/browser/override.test.ts new file mode 100644 index 0000000000..42dc257d76 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/override.test.ts @@ -0,0 +1,86 @@ +import { bindOverrides, Mixin, Overwrite, type Bindings } from "../../src/override"; +import { + ParticleRenderer, + SystemInfo, + TextureFormat, + WebGLEngine, + type WebGLGraphicDevice +} from "../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../helpers/createEngine"; + +it("routes static methods and instance setters according to the owning device", async () => { + const { engine: legacy } = await createEngine(); + try { + const native = await WebGLEngine.create({ canvas: document.createElement("canvas") }); + try { + for (const [engine, expected] of [ + [legacy, false], + [native, true] + ] as const) { + expect(SystemInfo.supportsTextureFormat(engine, TextureFormat.R8G8)).toBe(expected); + const { generator } = engine.sceneManager.activeScene!.createRootEntity().addComponent(ParticleRenderer); + generator.noise.enabled = true; + expect(generator.noise.enabled).toBe(expected); + expect(Boolean(generator._feedbackSimulator)).toBe(expected); + } + } finally { + native.destroy(); + } + } finally { + legacy.destroy(); + } +}); + +it("keeps original descriptors on validation and commit failure, then installs once on retry", () => { + class First { + method() { + return "original"; + } + } + + class Replacement { + method() { + return "replacement"; + } + } + + class Device {} + for (const target of ["Camera", "Texture"] as const) { + Overwrite(Replacement.prototype, "method", Object.getOwnPropertyDescriptor(Replacement.prototype, "method")!); + Mixin(target)(Replacement); + } + const descriptor = Object.getOwnPropertyDescriptor(First.prototype, "method")!; + const latePrototype = Object.create(null); + let rejectWrite = true; + // A constructible target with a Proxy prototype lets the commit fail after a successful validation. + const Late = function () {}; + Late.prototype = new Proxy(latePrototype, { + defineProperty(object, key, next) { + if (rejectWrite) throw new Error("blocked"); + return Reflect.defineProperty(object, key, next); + } + }); + const bindings = { WebGLGraphicDevice: Device, Camera: First, Texture: Late } as unknown as Bindings; + + expect(() => bindOverrides(bindings)).toThrow("Incompatible engine member: method"); + expect(Object.getOwnPropertyDescriptor(First.prototype, "method")).toEqual(descriptor); + + Object.defineProperty(latePrototype, "method", descriptor); + expect(() => bindOverrides(bindings)).toThrow("blocked"); + expect(Object.getOwnPropertyDescriptor(First.prototype, "method")).toEqual(descriptor); + expect(Object.getOwnPropertyDescriptor(latePrototype, "method")).toEqual(descriptor); + + rejectWrite = false; + const registerDevice = bindOverrides(bindings); + expect(First.prototype.method).not.toBe(descriptor.value); + expect(latePrototype.method).not.toBe(descriptor.value); + + const fallback = new Device() as WebGLGraphicDevice; + registerDevice(fallback); + const installedMethod = First.prototype.method; + bindOverrides(bindings); + expect(First.prototype.method).toBe(installedMethod); + expect(Object.assign(new First(), { _rhi: fallback }).method()).toBe("replacement"); + expect(new First().method()).toBe("original"); +}); diff --git a/packages/webgl1-polyfill/tests/browser/overrides.test.ts b/packages/webgl1-polyfill/tests/browser/overrides.test.ts new file mode 100644 index 0000000000..8b1e589a67 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/overrides.test.ts @@ -0,0 +1,20 @@ +import { Camera, FontAtlas, GLTexture2D, ShaderPass, WebGLGraphicDevice } from "../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../helpers/createEngine"; + +it("registers core and RHI mixins when the published entry point is loaded", async () => { + const readMethods = () => [ + FontAtlas.prototype["_createTexture"], + Camera.prototype.render, + ShaderPass.prototype["_compileShaderSource"], + GLTexture2D.prototype.setPixelBuffer, + WebGLGraphicDevice.prototype.createPlatformTransformFeedback + ]; + const originalMethods = readMethods(); + const { engine } = await createEngine(); + try { + readMethods().forEach((method, index) => expect(method).not.toBe(originalMethods[index])); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLCapability.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLCapability.test.ts new file mode 100644 index 0000000000..376af85ecc --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLCapability.test.ts @@ -0,0 +1,53 @@ +import { + BlendShape, + BlendShapeFrame, + GLCapabilityType, + PrimitiveMesh, + Vector3 +} from "../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("detects extensions and falls back to one draw buffer and sample", async () => { + const { engine } = await createEngine(["ANGLE_instanced_arrays", "WEBGL_draw_buffers"]); + try { + const device = engine._hardwareRenderer; + expect(device.canIUse(GLCapabilityType.instancedArrays)).toBe(false); + expect(device.canIUse(GLCapabilityType.vertexArrayObject)).toBe(true); + expect(engine._hardwareRenderer.capability.maxDrawBuffers).toBe(1); + expect(engine._hardwareRenderer.capability.maxAntiAliasing).toBe(1); + } finally { + engine.destroy(); + } +}); + +it("reports the extension draw buffer limit", async () => { + const { engine, gl } = await createEngine(); + try { + const ext = gl.getExtension("WEBGL_draw_buffers")!; + expect(engine._hardwareRenderer.capability.maxDrawBuffers).toBe(gl.getParameter(ext.MAX_DRAW_BUFFERS_WEBGL)); + } finally { + engine.destroy(); + } +}); + +it("stores blend shapes in vertex buffers when vertex IDs are unavailable", async () => { + const { engine, gl } = await createEngine(); + try { + const mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + const shape = new BlendShape("deformation"); + shape.addFrame( + new BlendShapeFrame( + 1, + Array.from({ length: mesh.vertexCount }, () => new Vector3(0.1, 0, 0)) + ) + ); + mesh.addBlendShape(shape); + mesh.uploadData(false); + expect(mesh._blendShapeManager._vertexBuffers.length).toBeGreaterThan(0); + expect(mesh._blendShapeManager._vertexTexture).toBeFalsy(); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLPrimitive.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLPrimitive.test.ts new file mode 100644 index 0000000000..7e77e0acec --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLPrimitive.test.ts @@ -0,0 +1,96 @@ +import { + Camera, + Color, + MeshRenderer, + PrimitiveMesh, + UnlitMaterial, + Vector3, + WebGLEngine +} from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { makeFallbackCanvas } from "../../helpers/canvas"; +import { createEngine } from "../../helpers/createEngine"; + +it("draws without instancing and cleans up cached VAOs", async () => { + const { engine, gl } = await createEngine(["ANGLE_instanced_arrays"]); + try { + const scene = engine.sceneManager.activeScene!; + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + const mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + const material = new UnlitMaterial(engine); + material.baseColor = new Color(1, 0, 0, 1); + for (const x of [-0.5, 0.5]) { + const entity = scene.createRootEntity(); + entity.transform.position = new Vector3(x, 0, 0); + const renderer = entity.addComponent(MeshRenderer); + renderer.mesh = mesh; + renderer.setMaterial(material); + } + const draw = vi.spyOn(gl, "drawElements"); + const bindAttribute = vi.spyOn(gl, "vertexAttribPointer"); + const rhiPrimitive = (mesh._primitive as any)._platformPrimitive; + const clearVAO = vi.spyOn(rhiPrimitive, "_clearVAO"); + scene.background.solidColor = new Color(0, 1, 0, 1); + camera.render(); + expect(draw).toHaveBeenCalledTimes(2); + expect(bindAttribute).toHaveBeenCalled(); + expect(rhiPrimitive._vaoMap.size).toBeGreaterThan(0); + clearVAO.mockClear(); + rhiPrimitive.destroy(); + expect(clearVAO).toHaveBeenCalledOnce(); + expect(rhiPrimitive._vaoMap.size).toBe(0); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("renders on real WebGL1 without optional VAO, instancing, depth, sRGB or float extensions", async () => { + const { canvas } = makeFallbackCanvas(); + canvas.width = canvas.height = 32; + const gl = canvas.getContext("webgl")!; + const getExtension = gl.getExtension.bind(gl); + const disabled = new Set([ + "OES_vertex_array_object", + "ANGLE_instanced_arrays", + "WEBGL_depth_texture", + "EXT_sRGB", + "WEBGL_draw_buffers", + "EXT_blend_minmax", + "OES_element_index_uint", + "OES_texture_float", + "OES_texture_half_float" + ]); + vi.spyOn(gl, "getExtension").mockImplementation((name) => (disabled.has(name) ? null : getExtension(name))); + const engine = await WebGLEngine.create({ canvas }); + try { + const scene = engine.sceneManager.activeScene!; + scene.background.solidColor = new Color(0, 1, 0, 1); + const cameraEntity = scene.createRootEntity(); + cameraEntity.transform.setPosition(0, 0, 5); + const camera = cameraEntity.addComponent(Camera); + camera.enablePostProcess = false; + const renderer = scene.createRootEntity().addComponent(MeshRenderer); + renderer.mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1); + const material = new UnlitMaterial(engine); + material.baseColor = new Color(1, 0, 0, 1); + renderer.setMaterial(material); + camera.render(); + const pixel = new Uint8Array(4); + gl.readPixels(16, 16, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect(gl.getError()).toBe(gl.NO_ERROR); + expect(Array.from(pixel)).toEqual([255, 0, 0, 255]); + expect(gl.getError()).toBe(gl.NO_ERROR); + expect(engine._hardwareRenderer.capability.maxDrawBuffers).toBe(1); + expect(engine._hardwareRenderer.capability.maxAntiAliasing).toBe(1); + const rhiPrimitive = (renderer.mesh!._primitive as any)._platformPrimitive; + const clearVAO = vi.spyOn(rhiPrimitive, "_clearVAO"); + rhiPrimitive.destroy(); + expect(clearVAO).not.toHaveBeenCalled(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture.test.ts new file mode 100644 index 0000000000..fe2327eb9a --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture.test.ts @@ -0,0 +1,77 @@ +import { + Logger, + RenderTarget, + Texture2D, + TextureDepthCompareFunction, + TextureFormat, + TextureWrapMode, + WebGLEngine +} from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createWebGL1Canvas } from "../../helpers/canvas"; +import { createEngine } from "../../helpers/createEngine"; + +it("downgrades NPOT storage and wrapping, and reads mip zero when requested", async () => { + const canvas = createWebGL1Canvas(); + const engine = await WebGLEngine.create({ canvas }); + try { + const gl = canvas.getContext("webgl")!; + const texture = new Texture2D(engine, 3, 5, TextureFormat.R8G8B8A8, true, false); + const data = new Uint8Array(3 * 5 * 4).fill(127); + texture.setPixelBuffer(data); + expect(texture.mipmapCount).toBe(1); + texture.wrapModeU = TextureWrapMode.Mirror; + expect(gl.getTexParameter(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S)).toBe(gl.CLAMP_TO_EDGE); + + const pixels = new Uint8Array(4); + const error = vi.spyOn(Logger, "error"); + texture.getPixelBuffer(0, 0, 1, 1, 1, pixels); + expect([...pixels]).toEqual([127, 127, 127, 127]); + expect(error).toHaveBeenCalledWith("mipLevel only take effect in WebGL2.0"); + error.mockRestore(); + const compareState = vi.spyOn(gl, "texParameteri"); + texture._setUseDepthCompareMode(true); + expect(compareState).not.toHaveBeenCalled(); + compareState.mockClear(); + texture._platformTexture.depthCompareFunction = TextureDepthCompareFunction.Less; + expect(compareState).not.toHaveBeenCalled(); + compareState.mockRestore(); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("uses linear storage without EXT_sRGB and reports sRGB mipmap limitations", async () => { + const { engine, gl } = await createEngine(["EXT_sRGB"]); + try { + const upload = vi.spyOn(gl, "texImage2D"); + const texture = new Texture2D(engine, 4, 4, TextureFormat.R8G8B8A8, true, true); + expect(upload).toHaveBeenCalledWith(gl.TEXTURE_2D, 0, gl.RGBA, 4, 4, 0, gl.RGBA, gl.UNSIGNED_BYTE, null); + const platform = texture._platformTexture.constructor as any; + const device = engine._hardwareRenderer; + expect(platform._supportRenderBufferColorFormat(TextureFormat.R11G11B10_UFloat, device)).toBe(false); + expect(platform._supportRenderBufferDepthFormat(TextureFormat.Depth32, device)).toBe(false); + expect(platform._supportRenderBufferDepthFormat(TextureFormat.Depth16, device)).toBe(true); + const nativeGenerate = vi.spyOn(gl, "generateMipmap"); + texture.generateMipmaps(); + expect(nativeGenerate).not.toHaveBeenCalled(); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("allocates a generic Depth renderbuffer as DEPTH_COMPONENT16", async () => { + const { engine, gl } = await createEngine(); + try { + const color = new Texture2D(engine, 4, 4, TextureFormat.R8G8B8A8, false, false); + const storage = vi.spyOn(gl, "renderbufferStorage"); + const target = new RenderTarget(engine, 4, 4, color, TextureFormat.Depth); + expect(storage).toHaveBeenCalledWith(gl.RENDERBUFFER, gl.DEPTH_COMPONENT16, 4, 4); + expect(gl.getError()).toBe(gl.NO_ERROR); + target.destroy(); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture2D.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture2D.test.ts new file mode 100644 index 0000000000..f1b8c3ba6b --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTexture2D.test.ts @@ -0,0 +1,23 @@ +import { Texture2D, TextureFormat, WebGLEngine } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createWebGL1Canvas } from "../../helpers/canvas"; + +it("allocates and updates a compressed 2D mip", async () => { + const canvas = createWebGL1Canvas(); + const gl = canvas.getContext("webgl")!; + expect(gl.getExtension("WEBGL_compressed_texture_s3tc")).not.toBeNull(); + const engine = await WebGLEngine.create({ canvas }); + try { + const allocate = vi.spyOn(gl, "compressedTexImage2D"); + const update = vi.spyOn(gl, "compressedTexSubImage2D"); + const data = new Uint8Array(8); + const texture = new Texture2D(engine, 4, 4, TextureFormat.DXT1, false, false); + texture.setPixelBuffer(data); + texture.setPixelBuffer(data); + expect(allocate).toHaveBeenCalledTimes(1); + expect(update).toHaveBeenCalledTimes(1); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTextureCube.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTextureCube.test.ts new file mode 100644 index 0000000000..f72417114a --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/GLTextureCube.test.ts @@ -0,0 +1,38 @@ +import { TextureCube, TextureCubeFace, TextureFormat, WebGLEngine } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createWebGL1Canvas } from "../../helpers/canvas"; + +it("allocates and updates a compressed cube mip", async () => { + const canvas = createWebGL1Canvas(); + const gl = canvas.getContext("webgl")!; + expect(gl.getExtension("WEBGL_compressed_texture_s3tc")).not.toBeNull(); + const engine = await WebGLEngine.create({ canvas }); + try { + const allocate = vi.spyOn(gl, "compressedTexImage2D"); + const update = vi.spyOn(gl, "compressedTexSubImage2D"); + const data = new Uint8Array(8); + const texture = new TextureCube(engine, 4, TextureFormat.DXT1, false, false); + texture.setPixelBuffer(TextureCubeFace.PositiveX, data); + texture.setPixelBuffer(TextureCubeFace.PositiveX, data); + texture.setPixelBuffer(TextureCubeFace.NegativeX, data); + expect(allocate).toHaveBeenCalledTimes(2); + expect(update).toHaveBeenCalledTimes(1); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("keeps NPOT cube maps complete by allocating only mip zero", async () => { + const canvas = createWebGL1Canvas(); + const engine = await WebGLEngine.create({ canvas }); + try { + const gl = canvas.getContext("webgl")!; + const cube = new TextureCube(engine, 3, TextureFormat.R8G8B8A8, true, false); + expect(cube.mipmapCount).toBe(1); + cube.setPixelBuffer(TextureCubeFace.PositiveX, new Uint8Array(36).fill(255)); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/WebGLGraphicDevice.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/WebGLGraphicDevice.test.ts new file mode 100644 index 0000000000..b66834d7b7 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/WebGLGraphicDevice.test.ts @@ -0,0 +1,124 @@ +import { + Buffer, + BufferBindFlag, + Camera, + Color, + Logger, + RenderTarget, + Texture2D, + Texture2DArray, + TextureFormat, + WebCanvas, + WebGLEngine, + WebGLGraphicDevice +} from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { makeFallbackCanvas } from "../../helpers/canvas"; +import { createEngine } from "../../helpers/createEngine"; + +it("keeps direct device initialization WebGL2-only", () => { + const { canvas } = makeFallbackCanvas(); + const device = new WebGLGraphicDevice(); + expect(() => + device.init( + new WebCanvas(canvas), + () => {}, + () => {} + ) + ).toThrow("WebGL2 is unavailable"); + device.destroy(); +}); + +it("rejects explicit Transform Feedback and rasterizer discard operations on WebGL1", async () => { + const { canvas } = makeFallbackCanvas(); + const engine = await WebGLEngine.create({ canvas }); + try { + const device = engine._hardwareRenderer as WebGLGraphicDevice; + expect(() => device.createPlatformTransformFeedback()).toThrow("Transform Feedback is not supported on WebGL1."); + expect(() => device.createPlatformTransformFeedbackPrimitive()).toThrow( + "Transform Feedback primitives are not supported on WebGL1." + ); + expect(() => device.enableRasterizerDiscard()).toThrow("Rasterizer discard is not supported on WebGL1."); + expect(() => device.disableRasterizerDiscard()).toThrow("Rasterizer discard is not supported on WebGL1."); + + const scene = engine.sceneManager.activeScene!; + scene.background.solidColor = new Color(1, 0, 0, 1); + const camera = scene.createRootEntity().addComponent(Camera); + camera.enablePostProcess = false; + camera.render(); + const gl = canvas.getContext("webgl")!; + const pixel = new Uint8Array(4); + gl.readPixels(0, 0, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect(Array.from(pixel)).toEqual([255, 0, 0, 255]); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("rejects unsupported texture arrays, buffer reads and MRT without the extension", async () => { + const { canvas } = makeFallbackCanvas(); + const gl = canvas.getContext("webgl")!; + const getExtension = gl.getExtension.bind(gl); + vi.spyOn(gl, "getExtension").mockImplementation((name) => + name === "WEBGL_draw_buffers" ? null : getExtension(name) + ); + const engine = await WebGLEngine.create({ canvas }); + try { + expect(() => new Texture2DArray(engine, 4, 4, 2)).toThrow("Texture2D Array is not supported in WebGL1.0"); + const buffer = new Buffer(engine, BufferBindFlag.VertexBuffer, 16); + expect(() => buffer.getData(new Uint8Array(16))).toThrow("Buffer is write-only on WebGL1.0 platforms."); + const color = new Texture2D(engine, 4, 4, TextureFormat.R8G8B8A8, false, false); + const second = new Texture2D(engine, 4, 4, TextureFormat.R8G8B8A8, false, false); + expect(() => new RenderTarget(engine, 4, 4, [color, second], null)).toThrow("MRT is not supported"); + + const target = new RenderTarget(engine, 4, 4, color, null); + expect(target.colorTextureCount).toBe(1); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("creates and installs an XR base layer using the WebGL1 context", async () => { + const { engine, gl } = await createEngine(); + const layer = vi.fn(function () {}); + vi.stubGlobal("XRWebGLLayer", layer); + try { + const updateRenderState = vi.fn(); + const session = { renderState: { layers: [] }, updateRenderState }; + const result = (engine._hardwareRenderer as any)._createXRLayer(session, 0.75); + expect(layer).toHaveBeenCalledWith(session, gl, expect.objectContaining({ framebufferScaleFactor: 0.75 })); + expect(updateRenderState).toHaveBeenCalledWith({ baseLayer: result }); + } finally { + vi.unstubAllGlobals(); + engine.destroy(); + } +}); + +it("accepts two color attachments with WEBGL_draw_buffers", async () => { + const { engine, gl } = await createEngine(); + try { + const textures = [0, 1].map(() => new Texture2D(engine, 4, 4, TextureFormat.R8G8B8A8, false, false)); + const target = new RenderTarget(engine, 4, 4, textures, null); + expect(target.colorTextureCount).toBe(2); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("warns when framebuffer blit is called directly", async () => { + const { engine } = await createEngine(); + try { + const warn = vi.spyOn(Logger, "warn"); + try { + engine._hardwareRenderer.blitInternalRTByBlitFrameBuffer(); + expect(warn).toHaveBeenCalledWith("WebGL1.0 not support blit frame buffer."); + } finally { + warn.mockRestore(); + } + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/compressedTexture.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/compressedTexture.test.ts new file mode 100644 index 0000000000..5fcb8072d5 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/compressedTexture.test.ts @@ -0,0 +1,24 @@ +import { Texture2D, TextureFormat } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("tracks compressed mip allocations independently per texture", async () => { + const { engine, gl } = await createEngine(); + try { + expect(gl.getExtension("WEBGL_compressed_texture_s3tc")).not.toBeNull(); + const allocate = vi.spyOn(gl, "compressedTexImage2D"); + const update = vi.spyOn(gl, "compressedTexSubImage2D"); + const first = new Texture2D(engine, 8, 8, TextureFormat.DXT1, true, false); + const second = new Texture2D(engine, 8, 8, TextureFormat.DXT1, true, false); + first.setPixelBuffer(new Uint8Array(32), 0); + first.setPixelBuffer(new Uint8Array(8), 1); + first.setPixelBuffer(new Uint8Array(8), 1); + second.setPixelBuffer(new Uint8Array(8), 1); + + expect(allocate.mock.calls.map(([, mip]) => mip)).toEqual([0, 1, 1]); + expect(update.mock.calls.map(([, mip]) => mip)).toEqual([1]); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/context.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/context.test.ts new file mode 100644 index 0000000000..6f78840c78 --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/context.test.ts @@ -0,0 +1,105 @@ +import { WebGLEngine, WebGLGraphicDevice } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { makeFallbackCanvas } from "../../helpers/canvas"; +import { createEngine } from "../../helpers/createEngine"; + +it("adapts buffer uploads through the automatic WebGL1 fallback", async () => { + const { canvas } = makeFallbackCanvas(); + const gl = canvas.getContext("webgl")!; + const upload = vi.spyOn(gl, "bufferSubData"); + const engine = await WebGLEngine.create({ canvas }); + const device = engine._hardwareRenderer as WebGLGraphicDevice; + try { + expect(device.isWebGL2).toBe(false); + expect(device.gl).toBe(gl); + const buffer = gl.createBuffer(); + gl.bindBuffer(gl.ARRAY_BUFFER, buffer); + gl.bufferData(gl.ARRAY_BUFFER, 16, gl.STATIC_DRAW); + + for (let iteration = 0; iteration < 2; iteration++) { + const view = new Uint16Array(new Uint16Array([10, 20, 30, 40]).buffer, 2, 3); + (device.gl as WebGL2RenderingContext).bufferSubData(gl.ARRAY_BUFFER, 0, view, 1, 2); + const uploaded = upload.mock.calls.at(-1)![2] as Uint8Array; + expect(uploaded.byteOffset).toBe(4); + expect(uploaded.byteLength).toBe(4); + expect(gl.getError()).toBe(gl.NO_ERROR); + if (iteration === 0) device.resetState(); + } + gl.deleteBuffer(buffer); + } finally { + engine.destroy(); + } +}); + +it("binds VAO and divisor extension entry points", async () => { + const { engine, gl } = await createEngine(); + try { + const adapted = gl as unknown as WebGL2RenderingContext; + const vao = adapted.createVertexArray(); + expect(vao).not.toBeNull(); + adapted.bindVertexArray(vao); + expect(adapted.isVertexArray(vao)).toBe(true); + adapted.bindVertexArray(null); + adapted.deleteVertexArray(vao); + expect(adapted.isVertexArray(vao)).toBe(false); + adapted.vertexAttribDivisor(0, 1); + expect(adapted.getVertexAttrib(0, adapted.VERTEX_ATTRIB_ARRAY_DIVISOR ?? 0x88fe)).toBe(1); + adapted.vertexAttribDivisor(0, 0); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); + +it("draws indexed and non-indexed instances through ANGLE_instanced_arrays", async () => { + const { engine, gl } = await createEngine(); + try { + const context = gl as unknown as WebGL2RenderingContext; + const vertex = gl.createShader(gl.VERTEX_SHADER)!; + const fragment = gl.createShader(gl.FRAGMENT_SHADER)!; + gl.shaderSource( + vertex, + "attribute vec2 position; void main() { gl_Position = vec4(position, 0.0, 1.0); gl_PointSize = 16.0; }" + ); + gl.shaderSource(fragment, "precision mediump float; void main() { gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0); }"); + gl.compileShader(vertex); + gl.compileShader(fragment); + const program = gl.createProgram()!; + gl.attachShader(program, vertex); + gl.attachShader(program, fragment); + gl.linkProgram(program); + expect(gl.getProgramParameter(program, gl.LINK_STATUS)).toBe(true); + gl.useProgram(program); + gl.viewport(0, 0, 16, 16); + gl.disable(gl.DEPTH_TEST); + const positions = gl.createBuffer(); + gl.bindBuffer(gl.ARRAY_BUFFER, positions); + gl.bufferData(gl.ARRAY_BUFFER, new Float32Array([0, 0]), gl.STATIC_DRAW); + const position = gl.getAttribLocation(program, "position"); + gl.enableVertexAttribArray(position); + gl.vertexAttribPointer(position, 2, gl.FLOAT, false, 0, 0); + const indices = gl.createBuffer(); + gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, indices); + gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, new Uint16Array([0]), gl.STATIC_DRAW); + for (const draw of [ + () => context.drawArraysInstanced(gl.POINTS, 0, 1, 2), + () => context.drawElementsInstanced(gl.POINTS, 1, gl.UNSIGNED_SHORT, 0, 2) + ]) { + gl.clearColor(0, 0, 0, 1); + gl.clear(gl.COLOR_BUFFER_BIT); + draw(); + expect(gl.getError()).toBe(gl.NO_ERROR); + const pixel = new Uint8Array(4); + gl.readPixels(8, 8, 1, 1, gl.RGBA, gl.UNSIGNED_BYTE, pixel); + expect([...pixel]).toEqual([255, 0, 0, 255]); + expect(gl.getError()).toBe(gl.NO_ERROR); + } + gl.deleteBuffer(indices); + gl.deleteBuffer(positions); + gl.deleteProgram(program); + gl.deleteShader(vertex); + gl.deleteShader(fragment); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureFormat.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureFormat.test.ts new file mode 100644 index 0000000000..6bda20b02e --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureFormat.test.ts @@ -0,0 +1,17 @@ +import { TextureFormat } from "../../../../galacean/dist/module.js"; +import { expect, it } from "vitest"; +import { textureFormat } from "../../../src/rhi-webgl/textureFormat"; +import { createWebGL1Canvas } from "../../helpers/canvas"; + +it("maps color texture and depth renderbuffer formats to WebGL1 enums", () => { + const gl = createWebGL1Canvas().getContext("webgl")!; + expect(textureFormat(TextureFormat.R8G8B8A8, false, gl, TextureFormat)).toMatchObject({ + internalFormat: gl.RGBA, + baseFormat: gl.RGBA, + dataType: gl.UNSIGNED_BYTE + }); + expect(textureFormat(TextureFormat.Depth, false, gl, TextureFormat, true)).toMatchObject({ + internalFormat: gl.DEPTH_COMPONENT16, + attachment: gl.DEPTH_ATTACHMENT + }); +}); diff --git a/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureStorage.test.ts b/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureStorage.test.ts new file mode 100644 index 0000000000..4335a0f4df --- /dev/null +++ b/packages/webgl1-polyfill/tests/browser/rhi-webgl/textureStorage.test.ts @@ -0,0 +1,23 @@ +import { Texture2D, TextureCube, TextureFormat } from "../../../../galacean/dist/module.js"; +import { expect, it, vi } from "vitest"; +import { createEngine } from "../../helpers/createEngine"; + +it("allocates the available mips and every cube face with texImage2D", async () => { + const { engine, gl } = await createEngine(); + try { + const storage = vi.spyOn(gl, "texImage2D"); + new Texture2D(engine, 3, 5, TextureFormat.R8G8B8A8, true, false); + expect(storage.mock.calls).toEqual([[gl.TEXTURE_2D, 0, gl.RGBA, 3, 5, 0, gl.RGBA, gl.UNSIGNED_BYTE, null]]); + + storage.mockClear(); + new TextureCube(engine, 4, TextureFormat.R8G8B8A8, true, false); + expect(storage.mock.calls.map(([face, level, , width, height]) => [face, level, width, height])).toEqual( + [4, 2, 1].flatMap((size, level) => + Array.from({ length: 6 }, (_, face) => [gl.TEXTURE_CUBE_MAP_POSITIVE_X + face, level, size, size]) + ) + ); + expect(gl.getError()).toBe(gl.NO_ERROR); + } finally { + engine.destroy(); + } +}); diff --git a/packages/webgl1-polyfill/tests/helpers/canvas.ts b/packages/webgl1-polyfill/tests/helpers/canvas.ts new file mode 100644 index 0000000000..bda793f293 --- /dev/null +++ b/packages/webgl1-polyfill/tests/helpers/canvas.ts @@ -0,0 +1,34 @@ +import { beforeAll, vi } from "vitest"; +import { server } from "@vitest/browser/context"; + +declare module "@vitest/browser/context" { + interface BrowserCommands { + mockRemoteAsset(pattern: string, localFile: string): Promise; + } +} + +beforeAll(() => + server.commands.mockRemoteAsset( + /^https:\/\/cdn\.jsdelivr\.net\/npm\/@galacean\/engine-webgl1-polyfill@[^/]+\/dist\/module\.js(?:\?retry=\d+)?$/ + .source, + "packages/webgl1-polyfill/dist/module.js" + ) +); + +export function createWebGL1Canvas(): HTMLCanvasElement { + const canvas = document.createElement("canvas"); + const getContext = canvas.getContext.bind(canvas); + canvas.getContext = ((type: string, options?: unknown) => + type === "webgl2" || type === "experimental-webgl2" ? null : getContext(type, options)) as typeof canvas.getContext; + return canvas; +} + +export function makeFallbackCanvas() { + const canvas = document.createElement("canvas"); + const getContext = canvas.getContext.bind(canvas); + const attempts = vi.spyOn(canvas, "getContext").mockImplementation((type: string, options?: unknown) => { + if (type === "webgl2" || type === "experimental-webgl2") return null; + return getContext(type, options); + }); + return { canvas, attempts }; +} diff --git a/packages/webgl1-polyfill/tests/helpers/createEngine.ts b/packages/webgl1-polyfill/tests/helpers/createEngine.ts new file mode 100644 index 0000000000..f58cc654de --- /dev/null +++ b/packages/webgl1-polyfill/tests/helpers/createEngine.ts @@ -0,0 +1,12 @@ +import { WebGLEngine } from "../../../galacean/dist/module.js"; +import { vi } from "vitest"; +import { createWebGL1Canvas } from "./canvas"; + +export async function createEngine(disabled: string[] = []) { + const canvas = createWebGL1Canvas(); + canvas.width = canvas.height = 16; + const gl = canvas.getContext("webgl")!; + const getExtension = gl.getExtension.bind(gl); + vi.spyOn(gl, "getExtension").mockImplementation((name) => (disabled.includes(name) ? null : getExtension(name))); + return { engine: await WebGLEngine.create({ canvas }), gl }; +} diff --git a/packages/webgl1-polyfill/tsconfig.json b/packages/webgl1-polyfill/tsconfig.json new file mode 100644 index 0000000000..5357eacbbb --- /dev/null +++ b/packages/webgl1-polyfill/tsconfig.json @@ -0,0 +1,26 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "module": "esnext", + "target": "esnext", + "declaration": true, + "moduleResolution": "node", + "paths": { + "@/override": ["./src/override.ts"] + }, + "allowSyntheticDefaultImports": true, + "experimentalDecorators": true, + "declarationDir": "types", + "emitDeclarationOnly": true, + "noImplicitAny": true, + "noImplicitOverride": true, + "sourceMap": true, + "incremental": false, + "skipLibCheck": true, + "allowJs": true, + "checkJs": false + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/xr-webxr/src/WebXRDevice.ts b/packages/xr-webxr/src/WebXRDevice.ts index 3371d920d6..5927ec577b 100644 --- a/packages/xr-webxr/src/WebXRDevice.ts +++ b/packages/xr-webxr/src/WebXRDevice.ts @@ -63,25 +63,7 @@ export class WebXRDevice implements IXRDevice { } gl.makeXRCompatible().then(() => { const scaleFactor = XRWebGLLayer.getNativeFramebufferScaleFactor(session); - let layer: XRWebGLLayer; - if (session.renderState.layers === undefined || !rhi.isWebGL2) { - const layerInit = { - antialias: session.renderState.layers === undefined ? attributes.antialias : true, - alpha: true, - depth: attributes.depth, - stencil: attributes.stencil, - framebufferScaleFactor: scaleFactor - }; - layer = new XRWebGLLayer(session, gl, layerInit); - session.updateRenderState({ - baseLayer: layer - }); - } else { - layer = new XRWebGLLayer(session, gl); - session.updateRenderState({ - layers: [layer] - }); - } + const layer = rhi._createXRLayer(session, scaleFactor); session.requestReferenceSpace("local").then((referenceSpace: XRReferenceSpace) => { resolve(new WebXRSession(session, layer, referenceSpace)); }, reject); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a84a1ca3a4..cdd82fb9fa 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -364,6 +364,18 @@ importers: specifier: workspace:* version: link:../galacean + packages/webgl1-polyfill: + devDependencies: + '@galacean/engine-core': + specifier: workspace:* + version: link:../core + '@galacean/engine-math': + specifier: workspace:* + version: link:../math + '@galacean/engine-rhi-webgl': + specifier: workspace:* + version: link:../rhi-webgl + packages/xr: devDependencies: '@galacean/engine': diff --git a/rollup.config.js b/rollup.config.js index 0b645804c3..2e9f51e60c 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -83,6 +83,16 @@ function config({ location, pkgJson }) { __buildVersion: pkgJson.version }) ); + curPlugins.push({ + name: "preserve-runtime-import", + renderDynamicImport({ format, targetModuleId, customResolution }) { + // Runtime URLs cannot be loaded with CommonJS require(). + if (format === "cjs" && targetModuleId === null && customResolution === null) { + return { left: "import(", right: ")" }; + } + return null; + } + }); return { umd: (compress) => { const umdConfig = pkgJson.umd; @@ -126,7 +136,11 @@ function config({ location, pkgJson }) { file: mainFile, sourcemap: true, format: "commonjs" - } + }, + ...(pkgJson.rollup?.output ?? []).map((output) => ({ + ...output, + file: path.join(location, output.file) + })) ], plugins: curPlugins }; diff --git a/tests/src/core/mesh/BlendShapeManager.test.ts b/tests/src/core/mesh/BlendShapeManager.test.ts index 387696b963..6440eaa51d 100644 --- a/tests/src/core/mesh/BlendShapeManager.test.ts +++ b/tests/src/core/mesh/BlendShapeManager.test.ts @@ -7,15 +7,13 @@ import { BlendShapeFrame, UnlitMaterial } from "@galacean/engine-core"; -import { WebGLEngine, WebGLMode } from "@galacean/engine"; +import { WebGLEngine } from "@galacean/engine"; import { Vector3 } from "@galacean/engine-math"; import { describe, beforeAll, expect, it } from "vitest"; describe("BlendShapeManager", () => { let engineWebGL2: WebGLEngine; - let engineWebGL1: WebGLEngine; let rootEntity1: Entity; - let rootEntity2: Entity; beforeAll(async () => { engineWebGL2 = await WebGLEngine.create({ @@ -29,21 +27,6 @@ describe("BlendShapeManager", () => { cameraEntity.transform.rotate(new Vector3(0, 0, 0)); engineWebGL2.run(); - - engineWebGL1 = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - graphicDeviceOptions: { - webGLMode: WebGLMode.WebGL1 - } - }); - - rootEntity2 = engineWebGL1.sceneManager.activeScene.createRootEntity("root"); - const cameraEntity2 = rootEntity2.createChild("camera"); - cameraEntity2.addComponent(Camera); - cameraEntity2.transform.setPosition(0, 0, 10); - cameraEntity2.transform.rotate(new Vector3(0, 0, 0)); - - engineWebGL1.run(); }); it("_updateShaderData", () => { @@ -278,24 +261,6 @@ describe("BlendShapeManager", () => { expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_USE_TEXTURE")).to.be.undefined; expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_HAS_NORMAL")).to.be.undefined; expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_HAS_TANGENT")).to.be.undefined; - - const skinnedMREntity2 = rootEntity2.createChild("skinnedMR"); - const meshRendererWebgl1 = skinnedMREntity2.addComponent(SkinnedMeshRenderer); - const modelMeshWebgl1 = PrimitiveMesh.createCuboid(engineWebGL1, 0.5, 0.5, 0.5); - modelMeshWebgl1.addBlendShape(blendShapeWeights0_5); - modelMeshWebgl1.addBlendShape(blendShapeWeights0_7); - modelMeshWebgl1.addBlendShape(blendShapeWeights0_7); - modelMeshWebgl1.addBlendShape(blendShapeWeights0_5); - modelMeshWebgl1.uploadData(false); - meshRendererWebgl1.mesh = modelMeshWebgl1; - engineWebGL1.update(); - - // Test that shaderData contains the correct macros not useTextureMode. - expect(macros.find((macro) => macro.name === "RENDERER_HAS_BLENDSHAPE")).to.be.not.undefined; - expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_COUNT")).to.be.undefined; - expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_USE_TEXTURE")).to.be.undefined; - expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_HAS_NORMAL")).to.be.undefined; - expect(macros.find((macro) => macro.name === "RENDERER_BLENDSHAPE_HAS_TANGENT")).to.be.undefined; }); it("_addBlendShape and _clearBlendShapes", () => { diff --git a/tests/src/core/mesh/PrimitiveMesh.test.ts b/tests/src/core/mesh/PrimitiveMesh.test.ts index 97e2a42251..64df77311d 100644 --- a/tests/src/core/mesh/PrimitiveMesh.test.ts +++ b/tests/src/core/mesh/PrimitiveMesh.test.ts @@ -1,7 +1,7 @@ -import { Camera, GLCapabilityType, PrimitiveMesh } from "@galacean/engine-core"; +import { Camera, PrimitiveMesh } from "@galacean/engine-core"; import { WebGLEngine } from "@galacean/engine"; import { Vector2, Vector3 } from "@galacean/engine-math"; -import { describe, beforeAll, expect, it, vi } from "vitest"; +import { describe, beforeAll, expect, it } from "vitest"; describe("PrimitiveMesh", () => { let engine: WebGLEngine; @@ -173,46 +173,22 @@ describe("PrimitiveMesh", () => { ); }); - it("test limit vertex count", function () { + it("creates large meshes with 32-bit indices", () => { const radius = 1; const segments = 256; const count = segments + 1; - - if (engine["_hardwareRenderer"].canIUse(GLCapabilityType.elementIndexUint)) { - const mesh = PrimitiveMesh.createPlane(engine, radius * 2, radius * 2, { - keepMeshData: true, - widthSegments: segments, - depthSegments: segments - }); - expect(mesh.vertexCount).equal(count * count); - expect(mesh.vertexElements.length).equal(4); - expect(mesh.bounds.min).to.deep.include({ x: -radius, y: 0, z: -radius }); - expect(mesh.bounds.max).to.deep.include({ x: radius, y: 0, z: radius }); - expect(mesh.getIndices().length).equal(segments * segments * 6); - expect(mesh.vertexBufferBindings.length).equal(2); - } else { - expect(() => - PrimitiveMesh.createPlane(engine, radius * 2, radius * 2, { - keepMeshData: true, - widthSegments: segments, - depthSegments: segments - }) - ).throw("The vertex count is over limit."); - } - }); - - it("rejects large meshes without 32-bit index support", () => { - const renderer = engine._hardwareRenderer; - const canIUse = renderer.canIUse.bind(renderer); - const capability = vi.spyOn(renderer, "canIUse").mockImplementation((type) => { - return type === GLCapabilityType.elementIndexUint ? false : canIUse(type); + const mesh = PrimitiveMesh.createPlane(engine, radius * 2, radius * 2, { + keepMeshData: true, + widthSegments: segments, + depthSegments: segments }); - try { - expect(() => PrimitiveMesh.createPlane(engine, 2, 2, { widthSegments: 256, depthSegments: 256 })).toThrow( - "The vertex count is over limit." - ); - } finally { - capability.mockRestore(); - } + expect(mesh.vertexCount).equal(count * count); + expect(mesh.vertexElements.length).equal(4); + expect(mesh.bounds.min).to.deep.include({ x: -radius, y: 0, z: -radius }); + expect(mesh.bounds.max).to.deep.include({ x: radius, y: 0, z: radius }); + const indices = mesh.getIndices(); + expect(indices).toBeInstanceOf(Uint32Array); + expect(indices.length).equal(segments * segments * 6); + expect(mesh.vertexBufferBindings.length).equal(2); }); }); diff --git a/tests/src/core/particle/InheritVelocity.test.ts b/tests/src/core/particle/InheritVelocity.test.ts index 3ce039e33e..c471ab0705 100644 --- a/tests/src/core/particle/InheritVelocity.test.ts +++ b/tests/src/core/particle/InheritVelocity.test.ts @@ -14,8 +14,7 @@ import { ParticleSimulationSpace, ParticleStopMode, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest"; @@ -435,40 +434,6 @@ describe("InheritVelocityModule", () => { renderer.entity.destroy(); }); - it("Initial Curve remains available on WebGL1", async () => { - const webgl1Engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - webGLMode: WebGLMode.WebGL1 - }); - const camera = webgl1Engine.sceneManager.activeScene.createRootEntity("Camera"); - camera.addComponent(Camera); - camera.transform.setPosition(0, 0, 10); - webgl1Engine.run(); - - const renderer = createParticleRenderer(webgl1Engine, "initial-inherit-velocity-webgl1"); - const generator = renderer.generator; - generator.inheritVelocity.mode = ParticleInheritVelocityMode.Initial; - generator.inheritVelocity.curve = new ParticleCompositeCurve( - new ParticleCurve(new CurveKey(0, 0), new CurveKey(1, 1)) - ); - generator.emission.clearBurst(); - generator.emission.addBurst(new Burst(0.15, new ParticleCompositeCurve(1))); - expect(generator._feedbackSimulator).to.not.exist; - - const webgl1Time = { value: 0 }; - generator.stop(true, ParticleStopMode.StopEmittingAndClear); - generator.play(); - tick(webgl1Engine, webgl1Time); - renderer.entity.transform.setPosition(1, 0, 0); - tick(webgl1Engine, webgl1Time); - - const vertices = (generator as any)._instanceVertices as Float32Array; - expect(vertices[15]).to.equal(0); - expect(vertices[40]).to.be.closeTo(10, 1e-5); - - webgl1Engine.destroy(); - }); - it("Initial evaluates TwoCurves over each particle lifetime using its birth velocity", () => { const renderer = createParticleRenderer(engine, "initial-inherit-velocity-curve"); const generator = renderer.generator; diff --git a/tests/src/core/particle/SubEmitter.test.ts b/tests/src/core/particle/SubEmitter.test.ts index 30a3aa2997..a1618511b6 100644 --- a/tests/src/core/particle/SubEmitter.test.ts +++ b/tests/src/core/particle/SubEmitter.test.ts @@ -3144,37 +3144,6 @@ describe("SubEmitter", () => { c.entity.destroy(); }); - it("Sub-emitter stays inert on WebGL1 instead of crashing on Death", () => { - const parent = createParticleRenderer(engine, "WebGL1_Parent"); - const child = createParticleRenderer(engine, "WebGL1_Child"); - parent.generator.main.startLifetime.constant = 0.5; - - // Pretend WebGL1 from the start: the whole module must be inert (enabled → false), - // and no transform-feedback buffer is built, so a parent death never reads a null buffer. - const hardwareRenderer = (engine as any)._hardwareRenderer; - const realIsWebGL2 = hardwareRenderer._isWebGL2; - hardwareRenderer._isWebGL2 = false; - try { - parent.generator.subEmitters.enabled = true; - parent.generator.subEmitters.addSubEmitter(child, ParticleSubEmitterType.Death, undefined, undefined, 3); - - expect(parent.generator.subEmitters.enabled).to.equal(false); - expect((parent.generator as any)._feedbackSimulator).to.not.exist; - - parent.generator.emission.addBurst(new Burst(0, new ParticleCompositeCurve(4), 1, 0.01)); - parent.generator.stop(true, ParticleStopMode.StopEmittingAndClear); - child.generator.stop(true, ParticleStopMode.StopEmittingAndClear); - parent.generator.play(); - expect(() => updateEngine(engine, 10)).to.not.throw(); // parent death must not crash - expect(child.generator._getAliveParticleCount()).to.equal(0); // Death inert on WebGL1 - } finally { - hardwareRenderer._isWebGL2 = realIsWebGL2; - } - - parent.entity.destroy(); - child.entity.destroy(); - }); - it("Cloned sub-emitter slots re-link to the cloned module", () => { const parent = createParticleRenderer(engine, "CloneParent"); const child = createParticleRenderer(engine, "CloneChild"); diff --git a/tests/src/core/particle/SubEmitterRendering.test.ts b/tests/src/core/particle/SubEmitterRendering.test.ts index 3a75960f01..0708209938 100644 --- a/tests/src/core/particle/SubEmitterRendering.test.ts +++ b/tests/src/core/particle/SubEmitterRendering.test.ts @@ -16,8 +16,7 @@ import { PrimitiveMesh, RenderTarget, Texture2D, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; @@ -32,7 +31,7 @@ describe("Sub-emitter rendering", () => { time = 0; vi.spyOn(performance, "now").mockImplementation(() => time); canvas = document.createElement("canvas"); - engine = await WebGLEngine.create({ canvas, graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } }); + engine = await WebGLEngine.create({ canvas }); const scene = engine.sceneManager.activeScene; scene.background.solidColor.set(0, 0, 0, 1); camera = scene.createRootEntity("Camera").addComponent(Camera); diff --git a/tests/src/core/texture/Texture2D.test.ts b/tests/src/core/texture/Texture2D.test.ts index 32a6470658..e371f60e05 100644 --- a/tests/src/core/texture/Texture2D.test.ts +++ b/tests/src/core/texture/Texture2D.test.ts @@ -1,6 +1,6 @@ import { Engine, Texture2D, TextureFormat } from "@galacean/engine-core"; import { WebGLEngine } from "@galacean/engine"; -import { beforeAll, beforeEach, describe, expect, it } from "vitest"; +import { beforeAll, describe, expect, it } from "vitest"; describe("Texture2D", () => { const width = 1024; @@ -10,16 +10,10 @@ describe("Texture2D", () => { let engine: Engine; let rhi: any; - let isWebGL2: boolean; beforeAll(async function () { engine = await WebGLEngine.create({ canvas: canvas }); // @ts-ignore rhi = engine._hardwareRenderer; - isWebGL2 = rhi.isWebGL2; - }); - - beforeEach(() => { - rhi._isWebGL2 = isWebGL2; }); describe("格式测试", () => { @@ -37,8 +31,8 @@ describe("Texture2D", () => { }); describe("mipmap", () => { - it("webgl2 支持非2次幂开启 mipmap ", () => { - rhi._isWebGL2 = true; + it("webgl2 支持非2次幂开启 mipmap ", async ({ skip }) => { + if (!rhi.isWebGL2) skip(); const texture1 = new Texture2D(engine, 100, 100); const texture2 = new Texture2D(engine, 100, 100, undefined, true); @@ -51,15 +45,7 @@ describe("Texture2D", () => { expect(texture.mipmapCount).to.eq(1); }); - it("webgl1 开启 mipmap 失败自动降级 - 非2次幂图片", () => { - rhi._isWebGL2 = false; - - const texture1 = new Texture2D(engine, 100, 100); - const texture2 = new Texture2D(engine, 100, 100, undefined, true); - expect(texture1.mipmapCount).to.eq(1); - expect(texture2.mipmapCount).to.eq(1); - }); }); describe("设置颜色缓冲", () => { diff --git a/tests/src/core/texture/TextureCubeMap.test.ts b/tests/src/core/texture/TextureCubeMap.test.ts index 2cfa0c2611..e83bc98151 100644 --- a/tests/src/core/texture/TextureCubeMap.test.ts +++ b/tests/src/core/texture/TextureCubeMap.test.ts @@ -1,6 +1,6 @@ import { Engine, TextureCube, TextureCubeFace, TextureFormat } from "@galacean/engine-core"; import { WebGLEngine } from "@galacean/engine"; -import { describe, beforeAll, beforeEach, expect, it } from "vitest"; +import { describe, beforeAll, expect, it } from "vitest"; describe("TextureCube", () => { const width = 1024; @@ -11,16 +11,10 @@ describe("TextureCube", () => { let engine: Engine; let rhi: any; - let isWebGL2: boolean; beforeAll(async function () { engine = await WebGLEngine.create({ canvas: canvas }); // @ts-ignore rhi = engine._hardwareRenderer; - isWebGL2 = rhi.isWebGL2; - }); - - beforeEach(() => { - rhi._isWebGL2 = isWebGL2; }); describe("格式测试", () => { @@ -38,8 +32,8 @@ describe("TextureCube", () => { }); describe("mipmap", () => { - it("webgl2 支持非2次幂开启 mipmap ", () => { - rhi._isWebGL2 = true; + it("webgl2 支持非2次幂开启 mipmap ", async ({ skip }) => { + if (!rhi.isWebGL2) skip(); const texture1 = new TextureCube(engine, 100); const texture2 = new TextureCube(engine, 100, undefined, true); @@ -52,15 +46,7 @@ describe("TextureCube", () => { expect(texture.mipmapCount).to.eq(1); }); - it("webgl1 开启 mipmap 失败自动降级 - 非2次幂图片", () => { - rhi._isWebGL2 = false; - - const texture1 = new TextureCube(engine, 100); - const texture2 = new TextureCube(engine, 100, undefined, true); - expect(texture1.mipmapCount).to.eq(1); - expect(texture2.mipmapCount).to.eq(1); - }); }); // todo: dom test diff --git a/tests/src/rhi-webgl/GLCapability.test.ts b/tests/src/rhi-webgl/GLCapability.test.ts index a80e474281..c1ee24f0dd 100644 --- a/tests/src/rhi-webgl/GLCapability.test.ts +++ b/tests/src/rhi-webgl/GLCapability.test.ts @@ -1,5 +1,6 @@ +import { createWebGL1Canvas } from "../../../packages/webgl1-polyfill/tests/helpers/canvas"; import { GLCapabilityType } from "@galacean/engine-core"; -import { WebGLEngine, WebGLMode } from "@galacean/engine"; +import { WebGLEngine } from "@galacean/engine"; import { describe, expect, it, vi } from "vitest"; describe("ASTC capabilities", () => { @@ -9,7 +10,7 @@ describe("ASTC capabilities", () => { { name: "LDR profile", extension: { getSupportedProfiles: () => ["ldr"] }, astc: true, hdr: false }, { name: "HDR profile", extension: { getSupportedProfiles: () => ["ldr", "hdr"] }, astc: true, hdr: true } ])("initializes with $name", async ({ extension, astc, hdr }) => { - const canvas = document.createElement("canvas"); + const canvas = createWebGL1Canvas(); const gl = canvas.getContext("webgl"); const getExtension = gl.getExtension.bind(gl); const spy = vi.spyOn(gl, "getExtension").mockImplementation((name) => { @@ -19,7 +20,7 @@ describe("ASTC capabilities", () => { }); let engine: WebGLEngine; try { - engine = await WebGLEngine.create({ canvas, graphicDeviceOptions: { webGLMode: WebGLMode.WebGL1 } }); + engine = await WebGLEngine.create({ canvas }); // @ts-ignore const rhi = engine._hardwareRenderer; expect(rhi.canIUse(GLCapabilityType.astc)).toBe(astc); diff --git a/tests/src/shader-analyzer/LoopReturnCoverage.test.ts b/tests/src/shader-analyzer/LoopReturnCoverage.test.ts index 05a009e350..77e325a35f 100644 --- a/tests/src/shader-analyzer/LoopReturnCoverage.test.ts +++ b/tests/src/shader-analyzer/LoopReturnCoverage.test.ts @@ -1,5 +1,6 @@ +import { createWebGL1Canvas } from "../../../packages/webgl1-polyfill/tests/helpers/canvas"; import { DiagnosticType, ShaderAnalyzer } from "@galacean/engine-shader-analyzer"; -import { Shader, ShaderLanguage, WebGLEngine, WebGLMode } from "@galacean/engine"; +import { Shader, ShaderLanguage, WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { describe, expect, it } from "vitest"; @@ -17,11 +18,8 @@ describe("loop return coverage", () => { "accepts returning loops that compile in GLES %i", async (target) => { const engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: new ShaderCompiler(), - graphicDeviceOptions: { - webGLMode: target === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: target === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: new ShaderCompiler() }); try { for (const [index, body] of [ diff --git a/tests/src/shader-compiler/DeclarationIdentity.test.ts b/tests/src/shader-compiler/DeclarationIdentity.test.ts index 0428236769..d2d1fd039a 100644 --- a/tests/src/shader-compiler/DeclarationIdentity.test.ts +++ b/tests/src/shader-compiler/DeclarationIdentity.test.ts @@ -1,4 +1,5 @@ -import { Logger, Shader, ShaderLanguage, WebGLEngine, WebGLMode } from "@galacean/engine"; +import { createWebGL1Canvas } from "../../../packages/webgl1-polyfill/tests/helpers/canvas"; +import { Logger, Shader, ShaderLanguage, WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { ShaderPrecompiler } from "@galacean/engine-shader-compiler/precompile"; import { describe, expect, it } from "vitest"; @@ -53,11 +54,8 @@ describe("conditional declaration identity", () => { const previousCompiler = Shader._shaderCompiler; const compiler = new ShaderCompiler(); const engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: compiler, - graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: compiler }); let shader: Shader | undefined; try { diff --git a/tests/src/shader-compiler/ParticleFeedbackReturn.test.ts b/tests/src/shader-compiler/ParticleFeedbackReturn.test.ts index e0a39989fb..72bde093dc 100644 --- a/tests/src/shader-compiler/ParticleFeedbackReturn.test.ts +++ b/tests/src/shader-compiler/ParticleFeedbackReturn.test.ts @@ -3,7 +3,7 @@ import { ShaderMacroProcessor } from "@galacean/engine-core/src/shader/ShaderMac import type { IPrecompiledShader } from "@galacean/engine-design"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { ShaderPrecompiler } from "@galacean/engine-shader-compiler/precompile"; -import { WebGLEngine, WebGLMode } from "@galacean/engine"; +import { WebGLEngine } from "@galacean/engine"; import { server } from "@vitest/browser/context"; import { afterAll, beforeAll, describe, expect, it } from "vitest"; @@ -13,8 +13,7 @@ describe("ParticleFeedback early return", () => { beforeAll(async () => { engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } + canvas: document.createElement("canvas") }); source = await server.commands.readFile("../packages/shader/src/Shaders/Effect/ParticleFeedback.shader"); }); diff --git a/tests/src/shader-compiler/ShaderCompiler.test.ts b/tests/src/shader-compiler/ShaderCompiler.test.ts index 8288ed2fec..0102beba59 100644 --- a/tests/src/shader-compiler/ShaderCompiler.test.ts +++ b/tests/src/shader-compiler/ShaderCompiler.test.ts @@ -1,3 +1,4 @@ +import { createWebGL1Canvas } from "../../../packages/webgl1-polyfill/tests/helpers/canvas"; import { BlendFactor, BlendOperation, @@ -23,8 +24,7 @@ import { ModelMesh, Shader, Vector3, - WebGLEngine, - WebGLMode + WebGLEngine } from "@galacean/engine"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; import { server } from "@vitest/browser/context"; @@ -54,11 +54,8 @@ describe("ShaderCompiler", async () => { ["runtime", ShaderLanguage.GLSLES300, shaderCompilerRelease] ] as const)("preserves disabled bare fragment returns (%s, %s)", async (mode, language, compiler) => { const fixtureEngine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: compiler, - graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: compiler }); let shader: Shader | undefined; try { @@ -95,11 +92,8 @@ describe("ShaderCompiler", async () => { "compiles conditional fragment helper macros without vertex dependencies (%s)", async (language) => { const fixtureEngine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: shaderCompilerRelease, - graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: shaderCompilerRelease }); const shader = Shader.create( `Shader "FragmentHelperMacro${language}" { @@ -147,13 +141,12 @@ describe("ShaderCompiler", async () => { ["fragment", "fragment-if-else", "varying-helper"].map((kind) => ({ language, kind })) ) )("preserves early return colors ($language, $kind)", async ({ language, kind }) => { - const canvas = document.createElement("canvas"); + const canvas = language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"); canvas.width = canvas.height = 32; const fixtureEngine = await WebGLEngine.create({ canvas, shaderCompiler: shaderCompilerRelease, graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2, preserveDrawingBuffer: true } }); @@ -1296,11 +1289,8 @@ void frag(Varyings input) { gl_FragColor = readColor(input); }`; let fixtureEngine: WebGLEngine; beforeAll(async () => { fixtureEngine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: shaderCompilerRelease, - graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: shaderCompilerRelease }); }); afterAll(() => fixtureEngine.destroy()); diff --git a/tests/src/shader-compiler/TransformFeedbackNames.test.ts b/tests/src/shader-compiler/TransformFeedbackNames.test.ts index 1a56c244a1..d81ec69eac 100644 --- a/tests/src/shader-compiler/TransformFeedbackNames.test.ts +++ b/tests/src/shader-compiler/TransformFeedbackNames.test.ts @@ -1,5 +1,5 @@ import { Shader, ShaderFactory, ShaderLanguage, ShaderPass, ShaderMacroCollection } from "@galacean/engine-core"; -import { WebGLEngine, WebGLMode } from "@galacean/engine"; +import { WebGLEngine } from "@galacean/engine"; import { ShaderMacroProcessor } from "@galacean/engine-core/src/shader/ShaderMacroProcessor"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { ShaderPrecompiler } from "@galacean/engine-shader-compiler/precompile"; @@ -31,8 +31,7 @@ async function capture( vertexOutputNames?: Readonly> ): Promise { const engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - graphicDeviceOptions: { webGLMode: WebGLMode.WebGL2 } + canvas: document.createElement("canvas") }); const gl = engine._hardwareRenderer.gl as WebGL2RenderingContext; expect(gl).not.toBeNull(); diff --git a/tests/src/shader-compiler/TypeDependencies.test.ts b/tests/src/shader-compiler/TypeDependencies.test.ts index 08490ca378..7cf8ea3565 100644 --- a/tests/src/shader-compiler/TypeDependencies.test.ts +++ b/tests/src/shader-compiler/TypeDependencies.test.ts @@ -1,4 +1,5 @@ -import { Logger, Shader, ShaderLanguage, WebGLEngine, WebGLMode } from "@galacean/engine"; +import { createWebGL1Canvas } from "../../../packages/webgl1-polyfill/tests/helpers/canvas"; +import { Logger, Shader, ShaderLanguage, WebGLEngine } from "@galacean/engine"; import { ShaderCompiler } from "@galacean/engine-shader-compiler"; import { ShaderPrecompiler } from "@galacean/engine-shader-compiler/precompile"; import { describe, expect, it } from "vitest"; @@ -111,11 +112,8 @@ describe("shader declaration type dependencies", () => { const previousCompiler = Shader._shaderCompiler; const compiler = new ShaderCompiler(); const engine = await WebGLEngine.create({ - canvas: document.createElement("canvas"), - shaderCompiler: compiler, - graphicDeviceOptions: { - webGLMode: language === ShaderLanguage.GLSLES100 ? WebGLMode.WebGL1 : WebGLMode.WebGL2 - } + canvas: language === ShaderLanguage.GLSLES100 ? createWebGL1Canvas() : document.createElement("canvas"), + shaderCompiler: compiler }); let shader: Shader | undefined; try { diff --git a/tests/vitest.config.ts b/tests/vitest.config.ts index c1d27b0826..57d6986093 100644 --- a/tests/vitest.config.ts +++ b/tests/vitest.config.ts @@ -1,6 +1,11 @@ import { defineProject } from "vitest/config"; import type {} from "@vitest/browser/providers/playwright"; +import type { BrowserContext } from "playwright"; import { fileURLToPath } from "node:url"; +import { resolve, relative, isAbsolute } from "node:path"; + +const repository = fileURLToPath(new URL("..", import.meta.url)); +const assetRoutes = new WeakMap>>(); export default defineProject({ root: fileURLToPath(new URL(".", import.meta.url)), @@ -27,9 +32,31 @@ export default defineProject({ ] }, test: { - include: ["src/**/*.test.ts"], + include: ["src/**/*.test.ts", "../packages/*/tests/browser/**/*.test.ts"], browser: { provider: "playwright", + commands: { + async mockRemoteAsset({ context }, pattern: string, localFile: string) { + const path = resolve(repository, localFile); + const repoPath = relative(repository, path); + if (repoPath.startsWith("..") || isAbsolute(repoPath)) { + throw new Error("Asset path must be inside the repository."); + } + + let routes = assetRoutes.get(context); + if (!routes) assetRoutes.set(context, (routes = new Map())); + const key = JSON.stringify([pattern, path]); + let requested = routes.get(key); + if (!requested) { + requested = context.route(new RegExp(pattern), (route) => + route.fulfill({ path, headers: { "Access-Control-Allow-Origin": "*" } }) + ); + routes.set(key, requested); + requested.catch(() => routes.delete(key)); + } + await requested; + } + }, enabled: true, headless: process.env.HEADLESS === "true", screenshotFailures: false, diff --git a/vitest.config.ts b/vitest.config.ts index 590808176c..9fd615b92f 100644 --- a/vitest.config.ts +++ b/vitest.config.ts @@ -1,7 +1,16 @@ -import { defineConfig } from "vitest/config"; +import { configDefaults, defineConfig } from "vitest/config"; export default defineConfig({ test: { - projects: ["packages/*", "tests"] + projects: [ + { + test: { + name: "node", + include: ["packages/*/tests/**/*.test.ts"], + exclude: [...configDefaults.exclude, "packages/*/tests/browser/**"] + } + }, + "tests" + ] } });