@galacean/effects-core 2.9.0-alpha.1 → 2.9.0

package/dist/animation/animation-events.d.ts

@@ -1,7 +1,6 @@
-import type { AnimationClip } from './animation-clip';
 import type { VFXItem } from '../vfx-item';
 export interface AnimationEventReference {
-    event: AnimationEventInfo;
+    data: AnimationEventInfo;
     currentTime: number;
     deltaTime: number;
 }
@@ -10,7 +9,6 @@ export interface AnimationEventInfo {
     startTime: number;
     duration: number;
     event: AnimationEvent;
-    clip: AnimationClip;
 }
 export interface AnimationEventData {
     typeName: string;
@@ -22,8 +20,8 @@ export interface AnimationEventInfoData {
     eventData?: AnimationEventData;
 }
 export declare class AnimationEvent {
-    onEvent(item: VFXItem, animation: AnimationClip, eventReference: AnimationEventReference): void;
+    onEvent(item: VFXItem, eventReference: AnimationEventReference): void;
 }
 export declare class NotifyEvent extends AnimationEvent {
-    onEvent(item: VFXItem, animation: AnimationClip, eventReference: AnimationEventReference): void;
+    onEvent(item: VFXItem, eventReference: AnimationEventReference): void;
 }

package/dist/components/base-render-component.d.ts

@@ -14,6 +14,10 @@ export interface ItemRenderer extends Required<Omit<spec.RendererOptions, 'textu
     texture: Texture;
     mask: number;
 }
+interface MaskableGraphicData extends spec.ComponentData {
+    renderer: spec.RendererOptions;
+    mask?: spec.MaskOptions;
+}
 /**
  * @since 2.7.0
  */
@@ -89,5 +93,6 @@ export declare class MaskableGraphic extends RendererComponent implements Maskab
     getBoundingBoxInfo(): BoundingBoxInfo;
     private configureMaterial;
     private draw;
-    fromData(data: unknown): void;
+    fromData(data: MaskableGraphicData): void;
 }
+export {};

package/dist/components/component.d.ts

@@ -1,3 +1,4 @@
+import type * as spec from '@galacean/effects-specification';
 import { EffectsObject } from '../effects-object';
 import type { VFXItem } from '../vfx-item';
 /**
@@ -59,8 +60,12 @@ export declare abstract class Component extends EffectsObject {
      * 当属性被动画修改时调用
      */
     onApplyAnimationProperties(): void;
+    /**
+     * 当父级或间接父级发生改变时调用
+     */
+    onParentChanged(): void;
     setVFXItem(item: VFXItem): void;
-    fromData(data: any): void;
+    fromData(data: spec.ComponentData): void;
     dispose(): void;
     private start;
 }

package/dist/components/composition-component.d.ts

@@ -1,7 +1,5 @@
-import type { Ray } from '@galacean/effects-math/es/core/ray';
 import * as spec from '@galacean/effects-specification';
-import type { CompositionHitTestOptions } from '../composition';
-import type { Region, TrackAsset } from '../plugins';
+import type { TrackAsset } from '../plugins';
 import { VFXItem } from '../vfx-item';
 import { Component } from './component';
 export interface SceneBinding {
@@ -47,10 +45,9 @@ export declare class CompositionComponent extends Component {
     onEnable(): void;
     onDisable(): void;
     onDestroy(): void;
-    hitTest(ray: Ray, x: number, y: number, regions: Region[], force?: boolean, options?: CompositionHitTestOptions): boolean;
     /**
      * 递归收集场景树中的直接子元素（DFS 前序）
      */
     private collectChildren;
-    fromData(data: any): void;
+    fromData(data: spec.CompositionComponentData): void;
 }

package/dist/components/frame-component.d.ts

@@ -1,7 +1,11 @@
+import type * as spec from '@galacean/effects-specification';
 import { RendererComponent } from './renderer-component';
 import { type Maskable } from '../material';
 import type { Renderer } from '../render';
 import { Color } from '@galacean/effects-math/es/core/color';
+interface FrameComponentData extends spec.ComponentData {
+    color?: spec.ColorData;
+}
 export declare class FrameComponent extends RendererComponent implements Maskable {
     color: Color;
     private clipGeometry;
@@ -12,8 +16,9 @@ export declare class FrameComponent extends RendererComponent implements Maskabl
     render(renderer: Renderer): void;
     onDestroy(): void;
     drawStencilMask(maskRef: number): void;
-    fromData(data: any): void;
+    fromData(data: FrameComponentData): void;
     private getHitTestParams;
     private setClipRectangle;
     private setClipRectangleRecursive;
 }
+export {};

package/dist/components/mesh-component.d.ts

@@ -1,8 +1,12 @@
+import type * as spec from '@galacean/effects-specification';
 import type { Engine } from '../engine';
 import type { Maskable } from '../material';
 import type { BoundingBoxTriangle, HitTestTriangleParams, BoundingBoxInfo } from '../plugins';
 import type { Geometry, Renderer } from '../render';
 import { RendererComponent } from './renderer-component';
+interface MeshComponentData extends spec.ComponentData {
+    mask?: spec.MaskOptions;
+}
 /**
  * Mesh 组件
  */
@@ -17,5 +21,6 @@ export declare class MeshComponent extends RendererComponent implements Maskable
     getHitTestParams: (force?: boolean) => HitTestTriangleParams | void;
     getBoundingBox(): BoundingBoxTriangle | void;
     getBoundingBoxInfo(): BoundingBoxInfo;
-    fromData(data: any): void;
+    fromData(data: MeshComponentData): void;
 }
+export {};

package/dist/components/renderer-component.d.ts

@@ -1,4 +1,4 @@
-import type { Material } from '../material';
+import type { Material, Maskable } from '../material';
 import { MaskProcessor } from '../material';
 import { BoundingBoxInfo } from '../plugins/interact/mesh-collider';
 import { Component } from './component';
@@ -9,6 +9,12 @@ import type { Renderer } from '../render/renderer';
  */
 export declare class RendererComponent extends Component {
     materials: Material[];
+    /**
+     * @hidden
+     * Internal utility.
+     * Not part of the public API — do not rely on this in your code.
+     */
+    frameClipMasks: Maskable[];
     /**
      * @hidden
      * Internal utility.
@@ -26,6 +32,7 @@ export declare class RendererComponent extends Component {
     set material(material: Material);
     onEnable(): void;
     onDisable(): void;
+    onParentChanged(): void;
     /**
      * 获取包围盒信息
      */

package/dist/components/shape-component.d.ts

@@ -123,6 +123,7 @@ export interface PolygonAttribute extends ShapeAttributes {
  * @since 2.1.0
  */
 export declare class ShapeComponent extends RendererComponent implements Maskable {
+    private static readonly tempMVP;
     private shapeDirty;
     private materialDirty;
     private graphicsPath;
@@ -151,6 +152,7 @@ export declare class ShapeComponent extends RendererComponent implements Maskabl
     getBoundingBox(): BoundingBoxTriangle;
     getBoundingBoxInfo(): BoundingBoxInfo;
     private buildGeometryFromPath;
+    private computeScreenScale;
     private buildPath;
     private updateMaterials;
     private updatePaintMaterial;

package/dist/composition.d.ts

@@ -5,7 +5,6 @@ import { Camera } from './camera';
 import type { Component, PostProcessVolume } from './components';
 import { CompositionComponent } from './components';
 import type { EventSystem, Region } from './plugins';
-import type { Renderer } from './render';
 import { RenderFrame } from './render';
 import type { Scene } from './scene';
 import type { Texture } from './texture';
@@ -14,6 +13,7 @@ import { VFXItem } from './vfx-item';
 import type { CompositionEvent } from './events';
 import { EventEmitter } from './events';
 import { SceneTicking } from './composition/scene-ticking';
+import type { Engine } from './engine';
 /**
  * 合成统计信息
  */
@@ -86,10 +86,6 @@ export interface CompositionProps {
      *
      */
     baseRenderOrder?: number;
-    /**
-     *
-     */
-    renderer: Renderer;
     /**
      *
      * @param message
@@ -100,14 +96,6 @@ export interface CompositionProps {
      *
      */
     event?: EventSystem;
-    /**
-     *
-     */
-    width: number;
-    /**
-     *
-     */
-    height: number;
     /**
      *
      */
@@ -119,7 +107,7 @@ export interface CompositionProps {
  * 也负责 Item 相关的动画播放控制，和持有渲染帧数据。
  */
 export declare class Composition extends EventEmitter<CompositionEvent<Composition>> implements Disposable, LostHandler {
-    renderer: Renderer;
+    engine: Engine;
     /**
      *
      */
@@ -159,14 +147,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * 合成id
      */
     readonly id: string;
-    /**
-     * 画布宽度
-     */
-    readonly width: number;
-    /**
-     * 画布高度
-     */
-    readonly height: number;
     /**
      * 鼠标和触屏处理系统
      */
@@ -228,11 +208,20 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     private _textures;
     /**
      * Composition 构造函数
+     * @param engine - 引擎实例
      * @param props - composition 的创建参数
      * @param scene
      */
-    constructor(props: CompositionProps, scene: Scene);
-    get engine(): import("@galacean/effects-core").Engine;
+    constructor(engine: Engine, props?: CompositionProps, scene?: Scene);
+    /**
+     * 画布宽度
+     */
+    get width(): number;
+    /**
+     * 画布高度
+     */
+    get height(): number;
+    get renderer(): import("packages/effects-core/src/render/renderer").Renderer;
     /**
      * 所有合成 Item 的根变换
      */
@@ -373,9 +362,10 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     getHitTestRay(x: number, y: number): Ray;
     /**
      * 获取 engine 对象
+     * @deprecated 2.9.0 Please use composition.engine instead.
      * @returns
      */
-    getEngine(): import("@galacean/effects-core").Engine;
+    getEngine(): Engine;
     /**
      * Item 求交测试，返回求交结果列表，x 和 y 是归一化到[-1, 1]区间的值，x 向右，y 向上
      * @param x - 鼠标或触点的 x，已经归一化到[-1, 1]

package/dist/effects-object.d.ts

@@ -15,7 +15,7 @@ export declare abstract class EffectsObject {
     /**
      * 存储需要序列化的数据
      */
-    defination: Record<string, any>;
+    definition: Record<string, any>;
     /**
      *
      * @param engine

package/dist/engine.d.ts

@@ -2,7 +2,8 @@ import * as spec from '@galacean/effects-specification';
 import type { Database, SceneData } from './asset-loader';
 import type { EffectsObject } from './effects-object';
 import type { Material } from './material';
-import type { GPUCapability, Geometry, Mesh, RenderPass, Renderer, ShaderLibrary } from './render';
+import type { GPUCapability, Geometry, Mesh, RenderPass, RenderPassClearAction, Renderer, RenderingData, ShaderLibrary } from './render';
+import { RenderTargetPool } from './render';
 import type { Scene, SceneRenderLevel } from './scene';
 import type { Texture } from './texture';
 import type { Disposable } from './utils';
@@ -14,6 +15,7 @@ import { EventSystem } from './plugins/interact/event-system';
 import type { GLType } from './gl/create-gl-context';
 import type { PointerEventData, Region } from './plugins/interact/click-handler';
 import { EventEmitter } from './events';
+import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 export interface EngineOptions extends WebGLContextAttributes {
     name?: string;
     glType?: GLType;
@@ -82,6 +84,16 @@ export declare class Engine extends EventEmitter<EngineEvent> implements Disposa
      * 引擎的像素比
      */
     pixelRatio: number;
+    /**
+     * @hidden
+     * Internal utility.
+     * Not part of the public API — do not rely on this in your code.
+     */
+    renderTargetPool: RenderTargetPool;
+    /**
+     * 存放渲染需要用到的数据
+     */
+    renderingData: RenderingData;
     protected _disposed: boolean;
     protected textures: Texture[];
     protected materials: Material[];
@@ -129,7 +141,42 @@ export declare class Engine extends EventEmitter<EngineEvent> implements Disposa
     removeRenderPass(pass: RenderPass): void;
     addComposition(composition: Composition): void;
     removeComposition(composition: Composition): void;
-    getShaderLibrary(): ShaderLibrary;
+    getWidth(): number;
+    getHeight(): number;
+    getShaderLibrary(): ShaderLibrary | null;
+    bindSystemFramebuffer(): void;
+    /**
+     * 用来设置视口，即指定从标准设备到窗口坐标的x、y仿射变换。
+     * @param x
+     * @param y
+     * @param width
+     * @param height
+     * example:
+     * gl.viewport(0, 0, width, height);
+     */
+    viewport(x: number, y: number, width: number, height: number): void;
+    clear(action: RenderPassClearAction): void;
+    drawGeometry(geometry: Geometry, matrix: Matrix4, material: Material, subMeshIndex?: number): 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;
+    blendColor(r: number, g: number, b: number, a: number): void;
+    blendFuncSeparate(srcRGB: number, dstRGB: number, srcAlpha: number, dstAlpha: number): void;
+    blendEquationSeparate(modeRGB: number, modeAlpha: number): void;
+    colorMask(r: boolean, g: boolean, b: boolean, a: boolean): void;
+    depthMask(flag: boolean): void;
+    depthFunc(func: number): void;
+    depthRange(near: number, far: number): void;
+    polygonOffset(factor: number, units: number): void;
+    cullFace(mode: number): void;
+    frontFace(mode: number): void;
+    stencilMaskSeparate(face: number, mask: number): void;
+    stencilFuncSeparate(face: number, func: number, ref: number, mask: number): void;
+    stencilOpSeparate(face: number, fail: number, zfail: number, zpass: number): void;
     /**
      * 销毁所有缓存的资源
      */