@galacean/effects-webgl 2.9.0-alpha.2 → 2.9.0

package/dist/gl-engine.d.ts

@@ -1,7 +1,12 @@
-import type { EngineOptions, Nullable, Texture, math } from '@galacean/effects-core';
+import type { EngineOptions, Geometry, Material, Nullable, RenderPassClearAction, ShaderLibrary, Texture, math } from '@galacean/effects-core';
 import { Engine } from '@galacean/effects-core';
 import { GLShaderLibrary } from './gl-shader-library';
+import type { GLTexture } from './gl-texture';
 import { GLContextManager } from './gl-context-manager';
+import type { GLFramebuffer } from './gl-framebuffer';
+import type { GLGPUBuffer } from './gl-gpu-buffer';
+import type { GLRenderbuffer } from './gl-renderbuffer';
+import { GLVertexArrayObject } from './gl-vertex-array-object';
 type Color = math.Color;
 type Vector2 = math.Vector2;
 type Vector3 = math.Vector3;
@@ -23,9 +28,25 @@ export declare class GLEngine extends Engine {
     private pixelStorei;
     private restoreCompositionsCache;
     constructor(canvas: HTMLCanvasElement, options?: EngineOptions);
+    getWidth(): number;
+    getHeight(): number;
+    getShaderLibrary(): ShaderLibrary | null;
+    createGLFramebuffer(name?: string): WebGLFramebuffer | null;
+    createVAO(name?: string): GLVertexArrayObject | undefined;
+    deleteGLTexture(texture: GLTexture): void;
+    deleteGPUBuffer(buffer: GLGPUBuffer | null): void;
+    deleteGLFramebuffer(framebuffer: GLFramebuffer): void;
+    deleteGLRenderbuffer(renderbuffer: GLRenderbuffer): void;
+    drawGeometry(geometry: Geometry, matrix: Matrix4, material: Material, subMeshIndex?: number): void;
+    clear(action: RenderPassClearAction): void;
     dispose(): void;
     reset(): void;
-    toggle(capability: GLenum, enable?: boolean): void;
+    setSampleAlphaToCoverage(enable: boolean): void;
+    setBlending(enable: boolean): void;
+    setDepthTest(enable: boolean): void;
+    setStencilTest(enable: boolean): void;
+    setCulling(enable: boolean): void;
+    setPolygonOffsetFill(enable: boolean): void;
     /**
      * 对于该上下文开启某种特性
      * @param capability
@@ -62,14 +83,6 @@ export declare class GLEngine extends Engine {
      * gl.useProgram(null);
      */
     useProgram(program: WebGLProgram | null): void;
-    /**
-     * 使用预设值来清空缓冲
-     * @param mask
-     * example:
-     * gl.clear(gl.DEPTH_BUFFER_BIT);
-     * gl.clear(gl.DEPTH_BUFFER_BIT | gl.COLOR_BUFFER_BIT);
-     */
-    clear(mask: number): void;
     /*** depth start ***/
     /**
      * 设置深度缓冲区的深度清除值

package/dist/gl-framebuffer.d.ts

@@ -1,7 +1,6 @@
 import type { Disposable, FramebufferProps, Renderbuffer, Renderer, Texture } from '@galacean/effects-core';
 import { Framebuffer, RenderPassDestroyAttachmentType } from '@galacean/effects-core';
 import { GLRenderbuffer } from './gl-renderbuffer';
-import type { GLRenderer } from './gl-renderer';
 import { GLTexture } from './gl-texture';
 import type { GLEngine } from './gl-engine';
 export declare class GLFramebuffer extends Framebuffer implements Disposable {
@@ -12,7 +11,7 @@ export declare class GLFramebuffer extends Framebuffer implements Disposable {
     colorTextures: GLTexture[];
     fbo?: WebGLFramebuffer;
     engine: GLEngine;
-    readonly renderer: GLRenderer;
+    readonly renderer: Renderer;
     private readonly attachmentTextures;
     constructor(props: FramebufferProps, renderer: Renderer);
     get stencilStorage(): Renderbuffer | undefined;

package/dist/gl-renderbuffer.d.ts

@@ -1,12 +1,11 @@
-import type { RenderbufferProps } from '@galacean/effects-core';
+import type { RenderbufferProps, Renderer } from '@galacean/effects-core';
 import { Renderbuffer } from '@galacean/effects-core';
-import type { GLRenderer } from './gl-renderer';
 export declare class GLRenderbuffer extends Renderbuffer {
     buffer: WebGLRenderbuffer | null;
     private initialized;
     private renderer?;
-    constructor(props: RenderbufferProps, renderer?: GLRenderer);
-    initialize(renderer: GLRenderer): void;
+    constructor(props: RenderbufferProps, renderer?: Renderer);
+    initialize(renderer: Renderer): void;
     setSize(width: number, height: number): void;
     dispose(): void;
 }

package/dist/gl-shader.d.ts

@@ -33,5 +33,7 @@ export declare class GLShaderVariant extends ShaderVariant {
     fillShaderInformation(uniformNames: string[], samplers: string[]): void;
     toData(): void;
     dispose(): void;
+    bind(): void;
+    isReady(): boolean;
 }
 export {};

package/dist/gl-texture.d.ts

@@ -1,4 +1,4 @@
-import type { Disposable, RestoreHandler, TextureConfigOptions, TextureSourceOptions, Engine } from '@galacean/effects-core';
+import type { Disposable, RestoreHandler, TextureConfigOptions, TextureSourceOptions, spec, Engine } from '@galacean/effects-core';
 import { Texture } from '@galacean/effects-core';
 export declare class GLTexture extends Texture implements Disposable, RestoreHandler {
     textureBuffer: WebGLTexture | null;
@@ -17,7 +17,7 @@ export declare class GLTexture extends Texture implements Disposable, RestoreHan
     release(): void;
     update(sourceOptions: TextureSourceOptions): void;
     setTextureFilters(gl: WebGLRenderingContext | WebGL2RenderingContext, target: GLenum, options: TextureConfigOptions): void;
-    fromData(data: any): void;
+    fromData(data: spec.EffectsObjectData): void;
     private texImage2D;
     private texImage2DData;
     private resizeImage;

package/dist/index.d.ts

@@ -1,6 +1,4 @@
 export * from './gl-geometry';
-export * from './gl-renderer';
-export * from './gl-material';
 export * from './gl-renderer-internal';
 export * from './gl-renderbuffer';
 export * from './gl-texture';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-webgl",
-  "version": "2.9.0-alpha.2",
+  "version": "2.9.0",
   "description": "Galacean Effects runtime webgl for the web",
   "types": "./dist/index.d.ts",
   "files": [
@@ -38,7 +38,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-core": "2.9.0-alpha.2"
+    "@galacean/effects-core": "2.9.0"
   },
   "scripts": {
     "prebuild": "pnpm clean",

package/dist/gl-material-state.d.ts

@@ -1,50 +0,0 @@
-import type { GLEngine } from './gl-engine';
-export declare class GLMaterialState {
-    blending: boolean;
-    blendFunctionParameters: [blendSrc: GLenum, blendDst: GLenum, blendSrcAlpha: GLenum, blendDstAlpha: GLenum];
-    blendEquationParameters: [blendEquationRGB: GLenum, blendEquationAlpha: GLenum];
-    blendColor: [r: number, g: number, b: number, a: number];
-    depthTest: boolean;
-    depthMask: boolean;
-    depthRange: [zNear: GLenum, zFar: GLenum];
-    depthFunc: GLenum;
-    polygonOffset: [factor: GLenum, units: GLenum];
-    polygonOffsetFill: boolean;
-    sampleAlphaToCoverage: boolean;
-    colorMask: [r: boolean, g: boolean, b: boolean, a: boolean];
-    stencilTest: boolean;
-    stencilMask: [front: GLenum, back: GLenum];
-    stencilRef: [front: GLenum, back: GLenum];
-    stencilFunc: [front: GLenum, back: GLenum];
-    stencilOpFail: [front: GLenum, back: GLenum];
-    stencilOpZFail: [front: GLenum, back: GLenum];
-    stencilOpZPass: [front: GLenum, back: GLenum];
-    culling: boolean;
-    frontFace: GLenum;
-    cullFace: GLenum;
-    constructor();
-    setBlendColor(color: [r: number, g: number, b: number, a: number]): void;
-    setBlending(value: boolean): void;
-    setBlendFunctionParameters(value: [blendSrc: GLenum, blendDst: GLenum, blendSrcAlpha: GLenum, blendDstAlpha: GLenum]): void;
-    setBlendEquationParameters(value: [rgb: GLenum, alpha: GLenum]): void;
-    setDepthTest(value: boolean): void;
-    setDepthMask(value: boolean): void;
-    setDepthRange(value: [zNear: GLenum, zFar: GLenum]): void;
-    setDepthFunc(value: GLenum): void;
-    setPolygonOffsetFill(value: boolean): void;
-    setPolygonOffset(value: [factor: GLenum, units: GLenum]): void;
-    setSampleAlphaToCoverage(value: boolean): void;
-    setColorMask(colorMask: boolean): void;
-    setStencilTest(value: boolean): void;
-    setStencilMask(value: [front: GLenum, back: GLenum]): void;
-    setStencilRef(value: [front: GLenum, back: GLenum]): void;
-    setStencilFunc(value: [front: GLenum, back: GLenum]): void;
-    setStencilOpFail(value: [front: GLenum, back: GLenum]): void;
-    setStencilOpZFail(value: [front: GLenum, back: GLenum]): void;
-    setStencilOpZPass(value: [front: GLenum, back: GLenum]): void;
-    setCulling(value: boolean): void;
-    setFrontFace(value: GLenum): void;
-    setCullFace(value: GLenum): void;
-    reset(): void;
-    apply(engine: GLEngine): void;
-}

package/dist/gl-material.d.ts

@@ -1,124 +0,0 @@
-import type { Engine, GlobalUniforms, MaterialProps, Renderer, Texture, UndefinedAble } from '@galacean/effects-core';
-import { spec, Material, math } from '@galacean/effects-core';
-import type { GLEngine } from './gl-engine';
-type Color = math.Color;
-type Vector2 = math.Vector2;
-type Vector3 = math.Vector3;
-type Vector4 = math.Vector4;
-type Matrix3 = math.Matrix3;
-type Matrix4 = math.Matrix4;
-type Quaternion = math.Quaternion;
-declare const Vector4: typeof math.Vector4, Matrix4: typeof math.Matrix4;
-export declare class GLMaterial extends Material {
-    private floats;
-    private ints;
-    private vector2s;
-    private vector3s;
-    private vector4s;
-    private colors;
-    private quaternions;
-    private matrices;
-    private matrice3s;
-    private textures;
-    private floatArrays;
-    private vector4Arrays;
-    private matrixArrays;
-    private samplers;
-    private uniforms;
-    private uniformDirty;
-    private macrosDirty;
-    private glMaterialState;
-    constructor(engine: Engine, props?: MaterialProps);
-    get blending(): UndefinedAble<boolean>;
-    set blending(blending: UndefinedAble<boolean>);
-    get blendColor(): UndefinedAble<[r: number, g: number, b: number, a: number]>;
-    set blendColor(color: UndefinedAble<[r: number, g: number, b: number, a: number]>);
-    get blendFunction(): UndefinedAble<[blendSrc: number, blendDst: number, blendSrcAlpha: number, blendDstAlpha: number]>;
-    set blendFunction(func: UndefinedAble<[blendSrc: number, blendDst: number, blendSrcAlpha: number, blendDstAlpha: number]>);
-    get blendEquation(): UndefinedAble<[rgb: number, alpha: number]>;
-    set blendEquation(equation: UndefinedAble<[rgb: number, alpha: number]>);
-    get depthTest(): UndefinedAble<boolean>;
-    set depthTest(value: UndefinedAble<boolean>);
-    get depthMask(): UndefinedAble<boolean>;
-    set depthMask(value: UndefinedAble<boolean>);
-    get depthRange(): UndefinedAble<[number, number]>;
-    set depthRange(value: UndefinedAble<[number, number]>);
-    get depthFunc(): UndefinedAble<number>;
-    set depthFunc(value: UndefinedAble<number>);
-    get polygonOffsetFill(): UndefinedAble<boolean>;
-    set polygonOffsetFill(value: UndefinedAble<boolean>);
-    get polygonOffset(): UndefinedAble<[number, number]>;
-    set polygonOffset(value: UndefinedAble<[number, number]>);
-    get sampleAlphaToCoverage(): UndefinedAble<boolean>;
-    set sampleAlphaToCoverage(value: UndefinedAble<boolean>);
-    get colorMask(): boolean;
-    set colorMask(value: boolean);
-    get stencilTest(): UndefinedAble<boolean>;
-    set stencilTest(value: UndefinedAble<boolean>);
-    get stencilMask(): UndefinedAble<[number, number]>;
-    set stencilMask(value: UndefinedAble<[number, number]>);
-    get stencilRef(): UndefinedAble<[number, number]>;
-    set stencilRef(value: UndefinedAble<[number, number]>);
-    get stencilFunc(): UndefinedAble<[number, number]>;
-    set stencilFunc(value: UndefinedAble<[number, number]>);
-    get stencilOpFail(): UndefinedAble<[number, number]>;
-    set stencilOpFail(value: UndefinedAble<[number, number]>);
-    get stencilOpZFail(): UndefinedAble<[number, number]>;
-    set stencilOpZFail(value: UndefinedAble<[number, number]>);
-    get stencilOpZPass(): UndefinedAble<[number, number]>;
-    set stencilOpZPass(value: UndefinedAble<[number, number]>);
-    get culling(): UndefinedAble<boolean>;
-    set culling(value: UndefinedAble<boolean>);
-    get frontFace(): UndefinedAble<number>;
-    set frontFace(value: UndefinedAble<number>);
-    get cullFace(): UndefinedAble<number>;
-    set cullFace(value: UndefinedAble<number>);
-    enableMacro(keyword: string, value?: boolean | number): void;
-    disableMacro(keyword: string): void;
-    isMacroEnabled(keyword: string): boolean;
-    get isDestroyed(): boolean;
-    /**shader和texture的GPU资源初始化。 */
-    initialize(): void;
-    createShaderVariant(): void;
-    setupStates(engine: GLEngine): void;
-    use(renderer: Renderer, globalUniforms?: GlobalUniforms): void;
-    getFloat(name: string): number | null;
-    setFloat(name: string, value: number): void;
-    getInt(name: string): number | null;
-    setInt(name: string, value: number): void;
-    getFloats(name: string): number[] | null;
-    setFloats(name: string, value: number[]): void;
-    getVector2(name: string): Vector2 | null;
-    setVector2(name: string, value: Vector2): void;
-    getVector3(name: string): Vector3 | null;
-    setVector3(name: string, value: Vector3): void;
-    getVector4(name: string): Vector4 | null;
-    setVector4(name: string, value: Vector4): void;
-    getColor(name: string): Color | null;
-    setColor(name: string, value: Color): void;
-    getQuaternion(name: string): Quaternion | null;
-    setQuaternion(name: string, value: Quaternion): void;
-    getMatrix(name: string): Matrix4 | null;
-    setMatrix(name: string, value: Matrix4): void;
-    setMatrix3(name: string, value: Matrix3): void;
-    getVector4Array(name: string): number[];
-    setVector4Array(name: string, array: Vector4[]): void;
-    getMatrixArray(name: string): number[] | null;
-    setMatrixArray(name: string, array: Matrix4[]): void;
-    setMatrixNumberArray(name: string, array: number[]): void;
-    getTexture(name: string): Texture | null;
-    setTexture(name: string, texture: Texture): void;
-    hasUniform(name: string): boolean;
-    clone(props?: MaterialProps): Material;
-    fromData(data: spec.MaterialData): void;
-    /**
-     * @since 2.0.0
-     * @param sceneData
-     * @returns
-     */
-    toData(): spec.MaterialData;
-    cloneUniforms(sourceMaterial: Material): void;
-    private checkUniform;
-    dispose(): void;
-}
-export {};

package/dist/gl-renderer.d.ts

@@ -1,65 +0,0 @@
-import type { Disposable, Engine, Framebuffer, RenderFrame, RenderPass, RenderPassClearAction, RendererComponent, ShaderLibrary, Texture } from '@galacean/effects-core';
-import { Geometry, Material, math, Renderer } from '@galacean/effects-core';
-import type { GLFramebuffer } from './gl-framebuffer';
-import type { GLTexture } from './gl-texture';
-import type { GLRenderbuffer } from './gl-renderbuffer';
-import { GLVertexArrayObject } from './gl-vertex-array-object';
-import type { GLGPUBuffer } from './gl-gpu-buffer';
-type Matrix4 = math.Matrix4;
-type Vector4 = math.Vector4;
-type Vector3 = math.Vector3;
-export declare class GLRenderer extends Renderer implements Disposable {
-    temporaryRTs: Record<string, Framebuffer>;
-    readonly name: string;
-    private sourceFbo;
-    private targetFbo;
-    private disposed;
-    private blitGeometry;
-    private blitMaterial;
-    get gl(): WebGLRenderingContext | WebGL2RenderingContext;
-    get height(): number;
-    get width(): number;
-    get canvas(): HTMLCanvasElement | OffscreenCanvas;
-    get isDisposed(): boolean;
-    get context(): import("packages/effects-webgl/src/gl-context-manager").GLContextManager;
-    constructor(engine: Engine);
-    renderRenderFrame(renderFrame: RenderFrame): void;
-    renderRenderPass(pass: RenderPass): void;
-    renderMeshes(meshes: RendererComponent[]): void;
-    setGlobalFloat(name: string, value: number): void;
-    setGlobalVector4(name: string, value: Vector4): void;
-    getGlobalVector4(name: string): Vector4;
-    setGlobalInt(name: string, value: number): void;
-    setGlobalMatrix(name: string, value: Matrix4): void;
-    setGlobalVector3(name: string, value: Vector3): void;
-    drawGeometry(geometry: Geometry, matrix: Matrix4, material: Material, subMeshIndex?: number): void;
-    setFramebuffer(framebuffer: Framebuffer | null): void;
-    setViewport(x: number, y: number, width: number, height: number): void;
-    clear(action: RenderPassClearAction): void;
-    getShaderLibrary(): ShaderLibrary | undefined;
-    getWidth(): number;
-    getHeight(): number;
-    dispose(): void;
-    lost(e: Event): void;
-    restore(): void;
-    resize(width: number, height: number): void;
-    /**
-     * 将源纹理复制到目标 Framebuffer，可使用自定义材质进行处理
-     * @param source - 源纹理
-     * @param destination - 目标 Framebuffer，如果为 null 则渲染到屏幕
-     * @param material - 可选的自定义材质，不传则使用默认复制材质
-     */
-    blit(source: Texture, destination: Framebuffer | null, material?: Material): void;
-    private checkGlobalUniform;
-    copy2(source: GLTexture, target: GLTexture): void;
-    createGLRenderbuffer(renderbuffer: GLRenderbuffer): WebGLRenderbuffer | null;
-    createGLFramebuffer(name?: string): WebGLFramebuffer | null;
-    /**创建包裹VAO对象。 */
-    createVAO(name?: string): GLVertexArrayObject | undefined;
-    deleteGLTexture(texture: GLTexture): void;
-    deleteGPUBuffer(buffer: GLGPUBuffer | null): void;
-    deleteGLFramebuffer(framebuffer: GLFramebuffer): void;
-    deleteGLRenderbuffer(renderbuffer: GLRenderbuffer): void;
-    private deleteResource;
-}
-export {};