@galacean/effects-core 2.3.1 → 2.4.0-alpha.0

package/dist/material/index.d.ts

@@ -2,3 +2,4 @@ export * from './types';
 export * from './utils';
 export * from './material-data-block';
 export * from './material';
+export * from './mask-ref-manager';

package/dist/material/mask-ref-manager.d.ts

@@ -0,0 +1,15 @@
+import type { Engine } from '../engine';
+import type { MaskProps } from './types';
+import { MaskMode } from './types';
+export declare class MaskRefManager {
+    currentRef: number;
+    constructor(initRef?: number);
+    distributeRef(): number;
+}
+export declare class MaskProcessor {
+    engine: Engine;
+    maskRef: number;
+    constructor(engine: Engine);
+    getRefValue(): number;
+    getMaskMode(data: MaskProps): MaskMode;
+}

package/dist/material/types.d.ts

@@ -2,6 +2,7 @@ import type * as spec from '@galacean/effects-specification';
 import type { Matrix3, Matrix4, Vector2, Vector3, Vector4 } from '@galacean/effects-math/es/core/index';
 import type { Texture } from '../texture';
 import type { DestroyOptions } from '../utils';
+import type { MaskProcessor } from './mask-ref-manager';
 export type UniformSemantic = 'VIEW' | 'MODEL' | 'MODELVIEW' | 'PROJECTION' | 'VIEWPROJECTION' | 'VIEWINVERSE' | 'EDITOR_TRANSFORM' | 'MODELVIEWPROJECTION';
 export interface MaterialBlendingStates {
     blending?: boolean;
@@ -59,3 +60,34 @@ export declare enum ShaderType {
     vertex = 0,
     fragment = 1
 }
+export interface MaskProps {
+    mask?: {
+        mask?: boolean;
+        mode?: spec.ObscuredMode;
+        ref?: Maskable;
+    };
+}
+/**
+ *
+ */
+export interface Maskable {
+    readonly maskManager: MaskProcessor;
+}
+export declare enum MaskMode {
+    /**
+     * 无
+     */
+    NONE = 0,
+    /**
+     * 蒙版
+     */
+    MASK = 1,
+    /**
+     * 被遮挡
+     */
+    OBSCURED = 2,
+    /**
+     * 被反向遮挡
+     */
+    REVERSE_OBSCURED = 3
+}

package/dist/material/utils.d.ts

@@ -1,7 +1,8 @@
 import * as spec from '@galacean/effects-specification';
+import { MaskMode } from './types';
 import type { Material } from './material';
 export declare function valIfUndefined<T>(val: any, def: T): T;
 export declare function getPreMultiAlpha(blending?: number): number;
 export declare function setBlendMode(material: Material, blendMode?: number): void;
 export declare function setSideMode(material: Material, side: spec.SideMode): void;
-export declare function setMaskMode(material: Material, maskMode: spec.MaskMode): void;
+export declare function setMaskMode(material: Material, maskMode: MaskMode, colorMask?: boolean): void;

package/dist/plugins/index.d.ts

@@ -19,5 +19,11 @@ export * from './particle/particle-system-renderer';
 export * from './cal/calculate-loader';
 export * from './cal/calculate-vfx-item';
 export * from './cal/calculate-item';
+export * from './shape/build-line';
+export * from './shape/graphics-path';
+export * from './shape/ellipse';
+export * from './shape/poly-star';
+export * from './shape/polygon';
+export * from './shape/shape-path';
 export * from './timeline';
 export * from './text';

package/dist/plugins/particle/particle-system.d.ts

@@ -6,6 +6,8 @@ import { Component } from '../../components';
 import type { Engine } from '../../engine';
 import type { ValueGetter } from '../../math';
 import type { Mesh } from '../../render';
+import type { Maskable } from '../../material';
+import { MaskMode, MaskProcessor } from '../../material';
 import type { ShapeGenerator, ShapeParticle } from '../../shape';
 import { Texture } from '../../texture';
 import { Transform } from '../../transform';
@@ -114,23 +116,30 @@ type ParticleInteraction = {
 export interface ParticleSystemOptions extends spec.ParticleOptions {
     meshSlots?: number[];
 }
-export interface ParticleSystemProps extends Omit<spec.ParticleContent, 'options' | 'renderer' | 'trails'> {
+export interface ParticleSystemProps extends Omit<spec.ParticleContent, 'options' | 'renderer' | 'trails' | 'mask'> {
     options: ParticleSystemOptions;
     renderer: ParticleSystemRendererOptions;
     trails?: ParticleTrailProps;
+    mask?: {
+        mode: MaskMode;
+        ref: Maskable;
+    };
 }
 export interface ParticleSystemRendererOptions extends Required<Omit<spec.RendererOptions, 'texture' | 'anchor' | 'particleOrigin'>> {
-    mask: number;
     texture: Texture;
     anchor?: vec2;
     particleOrigin?: spec.ParticleOrigin;
 }
-export interface ParticleTrailProps extends Omit<spec.ParticleTrail, 'texture'> {
+export interface ParticleTrailProps extends Omit<spec.ParticleTrail, 'texture' | 'mask'> {
     texture: Texture;
     textureMap: vec4;
+    mask?: {
+        mode: MaskMode;
+        ref: Maskable;
+    };
 }
 export type ParticleContent = [number, number, number, Point];
-export declare class ParticleSystem extends Component {
+export declare class ParticleSystem extends Component implements Maskable {
     renderer: ParticleSystemRenderer;
     options: ParticleOptions;
     shape: ShapeGenerator;
@@ -142,6 +151,7 @@ export declare class ParticleSystem extends Component {
     emissionStopped: boolean;
     destroyed: boolean;
     props: ParticleSystemProps;
+    readonly maskManager: MaskProcessor;
     private generatedCount;
     private lastUpdate;
     private loopStartTime;
@@ -207,5 +217,9 @@ export declare class ParticleSystem extends Component {
     getBoundingBox(): void | BoundingBoxSphere;
     getHitTestParams: (force?: boolean) => void | HitTestCustomParams;
     fromData(data: unknown): void;
+    getMaskOptions(data: ParticleSystemProps | ParticleTrailProps): {
+        maskMode: MaskMode;
+        maskRef: number;
+    };
 }
 export {};

package/dist/plugins/sprite/sprite-item.d.ts

@@ -1,20 +1,20 @@
 import * as spec from '@galacean/effects-specification';
+import type { ColorPlayableAssetData } from '../../animation';
+import { BaseRenderComponent } from '../../components';
 import type { Engine } from '../../engine';
+import type { MaskProps } from '../../material';
 import type { GeometryDrawMode } from '../../render';
 import { Geometry } from '../../render';
 import type { GeometryFromShape } from '../../shape';
 import { type Texture } from '../../texture';
-import type { PlayableGraph, Playable } from '../cal/playable-graph';
+import type { Playable, PlayableGraph } from '../cal/playable-graph';
 import { PlayableAsset } from '../cal/playable-graph';
-import type { ColorPlayableAssetData } from '../../animation';
-import { BaseRenderComponent } from '../../components/base-render-component';
 /**
  * 用于创建 spriteItem 的数据类型, 经过处理后的 spec.SpriteContent
  */
-export interface SpriteItemProps extends Omit<spec.SpriteContent, 'renderer'> {
+export interface SpriteItemProps extends Omit<spec.SpriteContent, 'renderer' | 'mask'>, MaskProps {
     listIndex?: number;
     renderer: {
-        mask: number;
         shape: GeometryFromShape;
         texture: Texture;
     } & Omit<spec.RendererOptions, 'texture'>;

package/dist/plugins/text/text-item.d.ts

@@ -1,19 +1,18 @@
 import * as spec from '@galacean/effects-specification';
+import type { ItemRenderer } from '../../components';
+import { BaseRenderComponent } from '../../components';
 import type { Engine } from '../../engine';
+import type { MaskProps, Material } from '../../material';
 import { Texture } from '../../texture';
+import type { VFXItem } from '../../vfx-item';
 import { TextLayout } from './text-layout';
 import { TextStyle } from './text-style';
-import type { Material } from '../../material';
-import type { VFXItem } from '../../vfx-item';
-import type { ItemRenderer } from '../../components';
-import { BaseRenderComponent } from '../../components';
 /**
  * 用于创建 textItem 的数据类型, 经过处理后的 spec.TextContentOptions
  */
-export interface TextItemProps extends Omit<spec.TextContent, 'renderer'> {
+export interface TextItemProps extends Omit<spec.TextContent, 'renderer' | 'mask'>, MaskProps {
     listIndex?: number;
     renderer: {
-        mask: number;
         texture: Texture;
     } & Omit<spec.RendererOptions, 'texture'>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.3.1",
+  "version": "2.4.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.2.0",
+    "@galacean/effects-specification": "2.3.0-alpha.0",
     "@galacean/effects-math": "1.1.0",
     "flatbuffers": "24.3.25",
     "uuid": "9.0.1",