@galacean/effects-core 2.7.4 → 2.8.0-alpha.0

package/dist/render/render-frame.d.ts

@@ -1,21 +1,20 @@
-import type { vec4 } from '@galacean/effects-specification';
 import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { Vector2 } from '@galacean/effects-math/es/core/vector2';
+import type { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import { Vector4 } from '@galacean/effects-math/es/core/vector4';
+import type { vec4 } from '@galacean/effects-specification';
 import type { Camera } from '../camera';
+import type { PostProcessVolume, RendererComponent } from '../components';
 import type { UniformValue } from '../material';
 import { PassTextureCache } from '../paas-texture-cache';
-import type { SemanticFunc } from './semantic-map';
-import { SemanticMap } from './semantic-map';
-import { Texture } from '../texture';
+import type { Texture } from '../texture';
 import type { Disposable } from '../utils';
 import { DestroyOptions } from '../utils';
-import { Mesh } from './mesh';
-import type { RenderPassClearAction, RenderPassColorAttachmentOptions, RenderPassDepthStencilAttachment, RenderPassDestroyOptions, RenderPassStoreAction } from './render-pass';
-import { RenderPass } from './render-pass';
+import type { Mesh } from './mesh';
+import type { RenderPass, RenderPassClearAction, RenderPassColorAttachmentOptions, RenderPassDepthStencilAttachment, RenderPassDestroyOptions, RenderPassStoreAction } from './render-pass';
 import type { Renderer } from './renderer';
-import type { PostProcessVolume, RendererComponent } from '../components';
-import type { Vector3 } from '@galacean/effects-math/es/core/vector3';
+import type { SemanticFunc } from './semantic-map';
+import { SemanticMap } from './semantic-map';
 /**
  * 渲染数据，保存了当前渲染使用到的数据。
  */
@@ -172,7 +171,6 @@ export declare class RenderFrame implements Disposable {
      */
     globalVolume?: PostProcessVolume;
     renderer: Renderer;
-    resource: RenderFrameResource;
     keepColorBuffer?: boolean;
     editorTransform: Vector4;
     renderQueue: RendererComponent[];
@@ -207,19 +205,12 @@ export declare class RenderFrame implements Disposable {
      * @param options - 可以有选择销毁一些对象
      */
     dispose(options?: RenderFrameDestroyOptions): void;
-    /**
-     * 重置 RenderPass ColorAttachment，解决 Framebuffer 即读又写的问题
-     * @param renderPasses - RenderPass 对象数组
-     * @param startIndex - 开始重置的索引
-     */
-    resetRenderPassDefaultAttachment(renderPasses: RenderPass[], startIndex: number): void;
     /**
      * 查找 Mesh 所在的 RenderPass 索引，没找到是-1
      * @param mesh - 需要查找的 Mesh
      */
     findMeshRenderPassIndex(mesh: Mesh): number;
     protected addToRenderPass(renderPass: RenderPass, mesh: Mesh): void;
-    protected getRPAttachments(attachments: RenderPassColorAttachmentOptions[], preRP?: RenderPass): RenderPassColorAttachmentOptions[];
     protected resetClearActions(): void;
     /**
      * 设置 RenderPass 数组，直接修改内部的 RenderPass 数组
@@ -231,20 +222,6 @@ export declare class RenderFrame implements Disposable {
      * @param pass - 需要添加的 RenderPass
      */
     addRenderPass(pass: RenderPass): void;
-    /**
-     * 创建 RenderPass 切分时需要的 GPU 资源
-     */
-    createResource(): void;
-    /**
-     * 创建拷贝 RenderPass 用到的 Mesh 对象
-     * @param semantics - RenderPass 渲染时 Framebuffer 的颜色和深度纹理、大小和是否混合
-     */
-    createCopyMesh(semantics?: {
-        tex?: string;
-        size?: string;
-        blend?: boolean;
-        depthTexture?: Texture;
-    }): Mesh;
     /**
      * 移除 RenderPass
      * @param pass - 需要移除的 RenderPass

package/dist/render/render-pass.d.ts

@@ -172,16 +172,6 @@ export interface RenderPassDelegate {
 export interface RenderPassAttachmentOptions {
     attachments?: RenderPassColorAttachmentOptions[];
     depthStencilAttachment?: RenderPassDepthStencilAttachmentOptions;
-    /**
-     * RenderPass 视口大小，如果没有指定，会用 viewportScale 计算
-     */
-    viewport?: [x: number, y: number, width: number, height: number];
-    /**
-     * 视口缩放系数
-     *  1. viewport 提供时，忽略此参数，RenderPass 视口大小由 viewport 决定；
-     *  2. 默认为1，RenderPass 视口大小由画布大小* viewportScale 决定，画布尺寸变化时，RenderPass 视口也会变化；
-     */
-    viewportScale?: number;
 }
 export interface RenderPassOptions extends RenderPassAttachmentOptions {
     name?: string;
@@ -246,7 +236,6 @@ export declare class RenderPass implements Disposable, Sortable {
     protected options: RenderPassAttachmentOptions;
     protected renderer: Renderer;
     private initialized;
-    private viewportScale;
     private depthTexture?;
     private stencilTexture?;
     private isCustomViewport;
@@ -259,10 +248,6 @@ export declare class RenderPass implements Disposable, Sortable {
     addMesh(mesh: RendererComponent): void;
     removeMesh(mesh: RendererComponent): void;
     setMeshes(meshes: RendererComponent[]): RendererComponent[];
-    /**
-     * 获取当前 Attachment 数组，注意 RenderPass 可能没有创建完成
-     */
-    getInitAttachments(): RenderPassColorAttachmentOptions[] | RenderTargetHandle[] | undefined;
     /**
      * 配置当前pass的RT，在每帧渲染前调用
      */
@@ -275,17 +260,6 @@ export declare class RenderPass implements Disposable, Sortable {
      * 每帧所有的pass渲染完后调用，通常用于清空临时的RT资源
      */
     frameCleanup(renderer: Renderer): void;
-    /**
-     * 重置 ColorAttachment 数组，会直接替换掉
-     * @param colors - 纹理数组，作为新的 ColorAttachment
-     */
-    resetColorAttachments(colors: Texture[]): void;
-    /**
-     * 重置所有 Attachment，会替换掉所有 Attachment
-     * @param options - Attachment 和视口数据
-     */
-    resetAttachments(options: RenderPassAttachmentOptions): void;
-    private setViewportOptions;
     private _resetAttachments;
     /**
      * 获取当前视口大小，格式：[x偏移，y偏移，宽度，高度]

package/dist/render/renderer.d.ts

@@ -8,40 +8,27 @@ import type { Geometry } from './geometry';
 import type { RenderFrame, RenderingData } from './render-frame';
 import type { RenderPassClearAction, RenderPassStoreAction } from './render-pass';
 import type { ShaderLibrary } from './shader';
-import type { GLType } from '../gl';
 export declare class Renderer implements LostHandler, RestoreHandler {
-    static create: (canvas: HTMLCanvasElement | OffscreenCanvas, framework: GLType, renderOptions?: WebGLContextAttributes) => Renderer;
+    static create: (engine: Engine) => Renderer;
     engine: Engine;
-    env: string;
     /**
     * 存放渲染需要用到的数据
     */
     renderingData: RenderingData;
-    constructor();
+    protected currentFramebuffer: Framebuffer;
+    constructor(engine: Engine);
     setGlobalFloat(name: string, value: number): void;
     setGlobalInt(name: string, value: number): void;
     setGlobalVector4(name: string, value: Vector4): void;
     setGlobalVector3(name: string, value: Vector3): void;
     setGlobalMatrix(name: string, value: Matrix4): void;
-    getFramebuffer(): Framebuffer | null;
+    getFramebuffer(): Framebuffer;
     setFramebuffer(framebuffer: Framebuffer | null): void;
     setViewport(x: number, y: number, width: number, height: number): void;
     resize(canvasWidth: number, canvasHeight: number): void;
     clear(action: RenderPassClearAction | RenderPassStoreAction): void;
     getWidth(): number;
     getHeight(): number;
-    /**
-     * 添加 webglcontextlost 事件回调
-     * @override
-     * @param lostHandler
-     */
-    addLostHandler(lostHandler: LostHandler): void;
-    /**
-     * 添加 webglContextrestored 事件的回调
-     * @override
-     * @param restoreHandler
-     */
-    addRestoreHandler(restoreHandler: RestoreHandler): void;
     /**
      * @override
      * @param e
@@ -61,5 +48,5 @@ export declare class Renderer implements LostHandler, RestoreHandler {
     renderMeshes(meshes: RendererComponent[]): void;
     drawGeometry(geometry: Geometry, matrix: Matrix4, material: Material, subMeshIndex?: number): void;
     getTemporaryRT(name: string, width: number, height: number, depthBuffer: number, filter: FilterMode, format: RenderTextureFormat): Framebuffer | null;
-    dispose(haltGL?: boolean): void;
+    dispose(): void;
 }

package/dist/scene-loader.d.ts

@@ -0,0 +1,7 @@
+import { Composition } from './composition';
+import type { Engine } from './engine';
+import type { Scene, SceneLoadOptions } from './scene';
+export declare class SceneLoader {
+    static load(scene: Scene.LoadType, engine: Engine, options?: SceneLoadOptions): Promise<Composition>;
+    private static createComposition;
+}

package/dist/texture/index.d.ts

@@ -1,5 +1,5 @@
 export * from './utils';
 export * from './texture';
-export * from './ktx-texture';
 export * from './texture-factory';
 export * from './types';
+export * from './texture-loader';

package/dist/texture/texture-loader.d.ts

@@ -0,0 +1,60 @@
+import type { Texture2DSourceOptions } from './types';
+import type { GPUCapability } from '../render/gpu-capability';
+export interface TextureLoader {
+    /**
+     * 从 ArrayBuffer 加载纹理
+     */
+    loadFromBuffer(arrBuffer: ArrayBuffer, gpuCapability?: GPUCapability): Promise<Texture2DSourceOptions>;
+    /**
+     * 从 URL 加载纹理
+     */
+    loadFromURL(url: string, gpuCapability?: GPUCapability): Promise<Texture2DSourceOptions>;
+    /**
+     * 释放资源
+     */
+    dispose(): void;
+}
+/**
+ * 纹理加载器工厂类型
+ */
+export type TextureLoaderFactory = () => TextureLoader;
+/**
+ * 纹理加载器注册表
+ */
+declare class TextureLoaderRegistry {
+    private loaders;
+    private instances;
+    /**
+     * 注册纹理加载器
+     * @param type - 加载器类型（如 'ktx2', 'hdr'）
+     * @param factory - 加载器工厂函数
+     */
+    register(type: string, factory: TextureLoaderFactory): void;
+    /**
+     * 注销纹理加载器
+     * @param type - 加载器类型
+     */
+    unregister(type: string): void;
+    /**
+     * 获取纹理加载器实例（单例）
+     * @param type - 加载器类型
+     */
+    getLoader(type: string): TextureLoader | null;
+    /**
+     * 检查是否已注册某类型加载器
+     */
+    has(type: string): boolean;
+    /**
+     * 获取所有已注册的加载器类型
+     */
+    getRegisteredTypes(): string[];
+    /**
+     * 清理所有加载器
+     */
+    dispose(): void;
+}
+/**
+ * 全局纹理加载器注册表实例
+ */
+export declare const textureLoaderRegistry: TextureLoaderRegistry;
+export {};

package/dist/transform.d.ts

@@ -13,7 +13,7 @@ export interface TransformProps {
     valid?: boolean;
 }
 /**
- *
+ * 变换组件，用于描述元素的位置、旋转、缩放等信息
  */
 export declare class Transform implements Disposable {
     /**
@@ -204,6 +204,13 @@ export declare class Transform implements Disposable {
      * @returns
      */
     getWorldPosition(): Vector3;
+    /**
+     * 设置世界坐标位置
+     * @param x - 世界坐标 x
+     * @param y - 世界坐标 y
+     * @param z - 世界坐标 z
+     */
+    setWorldPosition(x: number, y: number, z: number): void;
     /**
      * 获取联合变换后的最终旋转量
      * @returns

package/dist/utils/index.d.ts

@@ -79,6 +79,7 @@ export declare function isObject(obj: unknown): obj is Record<string | symbol, u
  */
 export declare function isPlainObject(obj: unknown): obj is Record<string | symbol, unknown>;
 export declare function isCanvas(canvas: HTMLCanvasElement): boolean;
+export declare function isPowerOfTwo(value: number): boolean;
 /**
  * 生成一个位于 min 和 max 之间的随机数
  * @param min

package/dist/vfx-item.d.ts

@@ -238,17 +238,24 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      */
     setPositionByPixel(x: number, y: number): void;
     /**
-     * 设置元素在 3D 坐标轴的位置
+     * 设置本地坐标位置
      */
     setPosition(x: number, y: number, z: number): void;
     /**
-     * 设置元素在 3D 坐标轴的角度
+     * 设置本地坐标欧拉旋转
      */
     setRotation(x: number, y: number, z: number): void;
     /**
-     * 设置元素在 3D 坐标轴的缩放
+     * 设置本地坐标缩放
      */
     setScale(x: number, y: number, z: number): void;
+    /**
+     * 设置世界坐标位置
+     * @param x - 世界坐标 x
+     * @param y - 世界坐标 y
+     * @param z - 世界坐标 z
+     */
+    setWorldPosition(x: number, y: number, z: number): void;
     /**
      * 获取元素包围盒
      * @override

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.7.4",
+  "version": "2.8.0-alpha.0",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -42,7 +42,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-specification": "2.6.0",
+    "@galacean/effects-specification": "2.7.0-alpha.0",
     "@galacean/effects-math": "1.1.0",
     "flatbuffers": "24.3.25",
     "uuid": "9.0.1",

package/dist/texture/ktx-texture.d.ts

@@ -1,21 +0,0 @@
-import type { Texture2DSourceOptionsCompressed, TextureDataType } from './types';
-export declare class KTXTexture {
-    private readonly arrayBuffer;
-    private readonly baseOffset;
-    glType: number;
-    glTypeSize: number;
-    glFormat: number;
-    glInternalFormat: number;
-    glBaseInternalFormat: number;
-    pixelWidth: number;
-    pixelHeight: number;
-    loadType: number;
-    pixelDepth: number;
-    numberOfArrayElements: number;
-    numberOfFaces: number;
-    numberOfMipmapLevels: number;
-    bytesOfKeyValueData: number;
-    constructor(arrayBuffer: ArrayBuffer, facesExpected: number, baseOffset?: number);
-    mipmaps(loadMipmaps: boolean): TextureDataType[];
-}
-export declare function getKTXTextureOptions(data: ArrayBuffer): Texture2DSourceOptionsCompressed;