@galacean/effects-specification 2.3.0 → 2.4.0

package/es/item/base-item.d.ts

@@ -2,7 +2,7 @@ import type { BinaryEnv } from '../binary';
 import type { DataPath } from '../components';
 import type { Vector2Data, Vector3Data } from '../math';
 import type { vec3, vec4 } from '../number-expression';
-import type { ItemType, ObscuredMode, RenderLevel } from '../type';
+import type { ItemType, RenderLevel } from '../type';
 import type { CameraContent } from './camera-item';
 import type { CompositionContent } from './composition-item';
 import type { EffectContent } from './effect-item';
@@ -37,23 +37,25 @@ export declare enum EndBehavior {
     freeze = 4
 }
 /**
- * 元素被遮挡/反向遮挡，需要时传入
- */
-export interface ObscuredOptions {
-    mode: ObscuredMode;
-    /**
-     * 指向作为蒙版的组件
-     */
-    ref: DataPath;
-}
-/**
- * 元素的蒙版行为
+ * 元素的蒙版选项
  */
 export interface MaskOptions {
     /**
      * 是否作为蒙版
      */
-    mask?: boolean;
+    isMask?: boolean;
+    /**
+     * 是否反转
+     */
+    inverted?: boolean;
+    /**
+     * 是否开启图片透明蒙版
+     */
+    alphaMaskEnabled?: boolean;
+    /**
+     * 指向作为蒙版的组件
+     */
+    reference: DataPath;
 }
 export interface BaseItem {
     /**

package/es/item/effect-item.d.ts

@@ -1,6 +1,6 @@
 import type { ComponentData, DataPath } from '../components';
 import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
-import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 /**
  * 特效元素
  */
@@ -41,5 +41,5 @@ export interface EffectComponentData extends ComponentData {
     /**
      * 特效元素蒙版属性，传入表示需要被遮挡/反向遮挡
      */
-    mask?: ObscuredOptions;
+    mask?: MaskOptions;
 }

package/es/item/particle-item.d.ts

@@ -1,6 +1,6 @@
 import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, SplitParameter, ObscuredMode } from '../type';
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
-import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 import type { ParticleShape } from './particle-shape';
 import type { ComponentData, DataPath } from '../components';
 /**
@@ -280,7 +280,7 @@ export interface ParticleContent {
     /**
      * 粒子元素蒙版属性，传入表示需要被遮挡/反向遮挡
      */
-    mask?: ObscuredOptions;
+    mask?: MaskOptions;
     /**
      * 粒子元素发射器形状属性
      */

package/es/item/spine-item.d.ts

@@ -2,7 +2,7 @@ import type { BinaryPointer } from '../binary';
 import type { ComponentData, DataPath } from '../components';
 import type { DataType } from '../data-type';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType, RenderMode } from '../type';
-import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 /**
  * 插件元素
  */
@@ -125,5 +125,5 @@ export interface SpineComponent extends ComponentData {
     /**
      * Spine 元素蒙版属性，传入表示需要被遮挡/反向遮挡
      */
-    mask?: ObscuredOptions;
+    mask?: MaskOptions;
 }

package/es/item/sprite-item.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, EndBehavior, MaskOptions, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, SplitParameter, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../number-expression';
 import type { ComponentData } from '../components';
@@ -43,7 +43,7 @@ export interface SpriteContent {
     /**
      * 图层元素蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
      */
-    mask?: MaskOptions | ObscuredOptions;
+    mask?: MaskOptions;
     /**
      * 图层元素大小变化属性
      */

package/es/item/text-item.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, EndBehavior, MaskOptions, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../number-expression';
 import type { FontStyle, TextAlignment, TextBaseline, TextOverflow, TextWeight } from '../text';
@@ -146,7 +146,7 @@ export interface TextContent {
     /**
      * 文本元素蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
      */
-    mask?: MaskOptions | ObscuredOptions;
+    mask?: MaskOptions;
     /**
      * 文本元素大小变化属性
      */

package/es/item/video-item.d.ts

@@ -1,7 +1,7 @@
 import type { ComponentData, DataPath } from '../components';
 import type { RGBAColorValue } from '../number-expression';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, InteractBehavior, RendererOptions, ItemType } from '../type';
-import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 /**
  * 视频元素
  */
@@ -62,7 +62,7 @@ export interface VideoComponentData extends ComponentData {
     /**
      * 视频元素蒙版属性，传入表示需要被遮挡/反向遮挡
      */
-    mask?: ObscuredOptions;
+    mask?: MaskOptions;
     /**
      * 视频元素大小变化属性
      */

package/es/shape/shape-component-data.d.ts

@@ -1,5 +1,5 @@
 import type { ComponentData } from '../components/component-data';
-import type { MaskOptions, ObscuredOptions } from '../item/base-item';
+import type { MaskOptions } from '../item/base-item';
 import type { ShapeFillParam } from './shape-fill-param';
 import type { ShapePrimitiveType } from './shape-primitive-type';
 import type { ShapeStrokeParam } from './shape-stroke-param';
@@ -22,5 +22,5 @@ export interface ShapeComponentData extends ComponentData {
     /**
      *  蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
      */
-    mask?: MaskOptions | ObscuredOptions;
+    mask?: MaskOptions;
 }

package/es/type.d.ts

@@ -1,5 +1,5 @@
 import type { DataPath } from './components';
-import type { ObscuredOptions, MaskOptions } from './item/base-item';
+import type { MaskOptions } from './item/base-item';
 import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './number-expression';
 /**
  * 播放器版本
@@ -457,7 +457,7 @@ export interface RendererOptions {
     /**
      * 蒙版属性
      */
-    mask?: MaskOptions | ObscuredOptions;
+    mask?: MaskOptions;
 }
 /**
  * 元素类型

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",