@galacean/effects-specification 2.1.0-beta.0 → 2.2.0-alpha.0

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

@@ -0,0 +1,36 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+/**
+ * 星形参数
+ */
+export interface StarData extends ShapeComponentData {
+    /**
+     * 顶点数 - 内外顶点同数
+     */
+    pointCount: number;
+    /**
+     * 内径
+     */
+    innerRadius: number;
+    /**
+     * 外径
+     */
+    outerRadius: number;
+    /**
+     * 内径点圆度
+     */
+    innerRoundness: number;
+    /**
+     * 外径点圆度
+     */
+    outerRoundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/star-data.js

@@ -0,0 +1 @@
+export {};

package/es/texture.d.ts

@@ -0,0 +1,48 @@
+import type { BinaryPointer } from './binary';
+import type { DataType } from './data-type';
+export interface TextureFormatOptions {
+    format?: GLenum;
+    internalFormat?: GLenum;
+    type?: GLenum;
+}
+export interface TextureConfigOptionsBase {
+    generateMipmap?: boolean;
+    id?: string;
+    dataType?: DataType.Texture;
+    name?: string;
+    wrapS?: GLenum;
+    wrapT?: GLenum;
+    magFilter?: GLenum;
+    minFilter?: GLenum;
+    anisotropic?: number;
+    flipY?: boolean;
+    premultiplyAlpha?: boolean;
+    keepImageSource?: boolean;
+}
+export type SerializedTextureCubeMipmap = [
+    TEXTURE_CUBE_MAP_POSITIVE_X: BinaryPointer,
+    TEXTURE_CUBE_MAP_NEGATIVE_X: BinaryPointer,
+    TEXTURE_CUBE_MAP_POSITIVE_Y: BinaryPointer,
+    TEXTURE_CUBE_MAP_NEGATIVE_Y: BinaryPointer,
+    TEXTURE_CUBE_MAP_POSITIVE_Z: BinaryPointer,
+    TEXTURE_CUBE_MAP_NEGATIVE_Z: BinaryPointer
+];
+export interface SerializedTexture2DImageSource extends TextureConfigOptionsBase, TextureFormatOptions {
+    dataType: DataType.Texture;
+    target?: WebGLRenderingContext['TEXTURE_2D'];
+    source: number;
+}
+export interface SerializedTexture2DMipmapSource extends TextureConfigOptionsBase, TextureFormatOptions {
+    dataType: DataType.Texture;
+    target?: WebGLRenderingContext['TEXTURE_2D'];
+    mipmaps: BinaryPointer[];
+}
+export interface SerializedTextureCube extends TextureConfigOptionsBase, TextureFormatOptions {
+    dataType: DataType.Texture;
+    target: WebGLRenderingContext['TEXTURE_CUBE_MAP'];
+    mipmaps: SerializedTextureCubeMipmap[];
+}
+export type SerializedTexture2D = SerializedTexture2DImageSource | SerializedTexture2DMipmapSource;
+export type SerializedTextureSource = SerializedTexture2D | SerializedTextureCube;
+export type TextureJSONOptions = SerializedTextureSource;
+export type TextureDefine = TextureJSONOptions;

package/es/texture.js

@@ -0,0 +1 @@
+export {};

package/es/timeline/playables/sprite-color-playable-asset-data.d.ts

@@ -1,6 +1,7 @@
-import type { DataType, EffectsObjectData } from '../../components';
 import type { RGBAColorValue } from '../../number-expression';
 import type { ColorOverLifetime } from '../../type';
+import type { DataType } from '../../data-type';
+import type { EffectsObjectData } from '../../effects-object-data';
 export interface SpriteColorPlayableAssetData extends EffectsObjectData {
     dataType: DataType.SpriteColorPlayableAsset;
     colorOverLifetime?: ColorOverLifetime;

package/es/timeline/playables/transform-playable-asset-data.d.ts

@@ -1,5 +1,6 @@
-import type { DataType, EffectsObjectData } from '../../components';
+import type { EffectsObjectData } from '../../effects-object-data';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime } from '../../type';
+import type { DataType } from '../../data-type';
 export interface TransformPlayableAssetData extends EffectsObjectData {
     dataType: DataType.TransformPlayableAsset;
     /**

package/es/timeline/timeline-asset-data.d.ts

@@ -1,4 +1,6 @@
-import type { EffectsObjectData, DataPath, DataType } from '../components';
+import type { DataPath } from '../components';
+import type { DataType } from '../data-type';
+import type { EffectsObjectData } from '../effects-object-data';
 export interface TimelineAssetData extends EffectsObjectData {
     dataType: DataType.TimelineAsset;
     /**

package/es/timeline/track/track-asset-data.d.ts

@@ -1,5 +1,6 @@
-import type { DataPath, EffectsObjectData } from '../../components';
+import type { DataPath } from '../../components';
 import type { TimelineClipData } from '../timeline-clip-data';
+import type { EffectsObjectData } from '../../effects-object-data';
 export interface TrackAssetData extends EffectsObjectData {
     /**
      * 子轨道数据（TrackAssetData）

package/es/type.d.ts

@@ -1,3 +1,4 @@
+import type { DataPath } from './components';
 import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './number-expression';
 /**
  * 播放器版本
@@ -31,19 +32,6 @@ export interface GLTF {
      */
     reuse: boolean;
 }
-/**
- * 形状属性
- */
-export interface Shape {
-    /**
-     * 形状 ID
-     */
-    id: number;
-    /**
-     * 形状数据
-     */
-    shape: number[];
-}
 /**
  * 插件参数
  */
@@ -329,7 +317,7 @@ export declare enum MaskMode {
 /**
  * 发射器形状
  */
-export declare enum ShapeType {
+export declare enum ParticleEmitterShapeType {
     /**
      * 没有类型
      */
@@ -457,7 +445,7 @@ export interface RendererOptions {
     /**
      * 贴图，索引到 scene 中的 images 数组
      */
-    texture?: number;
+    texture?: DataPath;
     /**
      * 蒙版模式
      * @default none
@@ -540,10 +528,30 @@ export declare enum ItemType {
      * 特效元素
      */
     effect = "effect",
+    /**
+     * 形状元素
+     */
+    shape = "shape",
+    /**
+     * 后处理元素
+     */
+    postProcessVolume = "postProcessVolume",
     /**
      * 节点元素
      */
-    node = "node"
+    node = "node",
+    /**
+     * 视频元素
+     */
+    video = "video",
+    /**
+     * 音频元素
+     */
+    audio = "audio",
+    /**
+     * 富文本元素
+     */
+    richtext = "richtext"
 }
 /**
  * 渲染模式
@@ -670,3 +678,4 @@ export declare enum RenderFace {
     Back = "Back",
     Front = "Front"
 }
+export type HTMLImageLike = HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;

package/es/type.js

@@ -93,49 +93,49 @@ export var MaskMode;
 /**
  * 发射器形状
  */
-export var ShapeType;
-(function (ShapeType) {
+export var ParticleEmitterShapeType;
+(function (ParticleEmitterShapeType) {
     /**
      * 没有类型
      */
-    ShapeType[ShapeType["NONE"] = 0] = "NONE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["NONE"] = 0] = "NONE";
     /**
      * 圆球
      */
-    ShapeType[ShapeType["SPHERE"] = 1] = "SPHERE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["SPHERE"] = 1] = "SPHERE";
     /**
      * 圆锥
      */
-    ShapeType[ShapeType["CONE"] = 2] = "CONE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["CONE"] = 2] = "CONE";
     /**
      * 半球
      */
-    ShapeType[ShapeType["HEMISPHERE"] = 3] = "HEMISPHERE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["HEMISPHERE"] = 3] = "HEMISPHERE";
     /**
      * 圆
      */
-    ShapeType[ShapeType["CIRCLE"] = 4] = "CIRCLE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["CIRCLE"] = 4] = "CIRCLE";
     /**
      * 圆环
      */
-    ShapeType[ShapeType["DONUT"] = 5] = "DONUT";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["DONUT"] = 5] = "DONUT";
     /**
      * 矩形
      */
-    ShapeType[ShapeType["RECTANGLE"] = 6] = "RECTANGLE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["RECTANGLE"] = 6] = "RECTANGLE";
     /**
      * 矩形框
      */
-    ShapeType[ShapeType["RECTANGLE_EDGE"] = 7] = "RECTANGLE_EDGE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["RECTANGLE_EDGE"] = 7] = "RECTANGLE_EDGE";
     /**
      * 直线
      */
-    ShapeType[ShapeType["EDGE"] = 8] = "EDGE";
+    ParticleEmitterShapeType[ParticleEmitterShapeType["EDGE"] = 8] = "EDGE";
     /**
      * 贴图
      */
-    ShapeType[ShapeType["TEXTURE"] = 9] = "TEXTURE";
-})(ShapeType || (ShapeType = {}));
+    ParticleEmitterShapeType[ParticleEmitterShapeType["TEXTURE"] = 9] = "TEXTURE";
+})(ParticleEmitterShapeType || (ParticleEmitterShapeType = {}));
 /**
  * 插件类型
  */
@@ -260,10 +260,30 @@ export var ItemType;
      * 特效元素
      */
     ItemType["effect"] = "effect";
+    /**
+     * 形状元素
+     */
+    ItemType["shape"] = "shape";
+    /**
+     * 后处理元素
+     */
+    ItemType["postProcessVolume"] = "postProcessVolume";
     /**
      * 节点元素
      */
     ItemType["node"] = "node";
+    /**
+     * 视频元素
+     */
+    ItemType["video"] = "video";
+    /**
+     * 音频元素
+     */
+    ItemType["audio"] = "audio";
+    /**
+     * 富文本元素
+     */
+    ItemType["richtext"] = "richtext";
 })(ItemType || (ItemType = {}));
 /**
  * 渲染模式

package/es/vfx-item-data.d.ts

@@ -1,4 +1,5 @@
-import type { DataPath, EffectsObjectData } from './components';
+import type { DataPath } from './components';
+import type { EffectsObjectData } from './effects-object-data';
 import type { EndBehavior, BaseContent, TransformData } from './item/base-item';
 import type { ItemType, RenderLevel } from './type';
 export interface VFXItemData extends EffectsObjectData {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.1.0-beta.0",
+  "version": "2.2.0-alpha.0",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",
@@ -15,6 +15,17 @@
       "types": "./es/index.d.ts"
     }
   },
+  "scripts": {
+    "prebuild": "pnpm clean",
+    "build": "pnpm build:lib",
+    "build:lib": "tsc -b tsconfig.build.json",
+    "lint": "eslint src --ext .ts,.mjs",
+    "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
+    "check:ts": "tsc -b tsconfig.check.json",
+    "clean": "rimraf es/**",
+    "prepare": "husky install",
+    "prepublishOnly": "npm run build"
+  },
   "browserslist": [
     "iOS 9"
   ],
@@ -37,15 +48,5 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
-  },
-  "scripts": {
-    "prebuild": "npm run clean:all",
-    "build": "npm run build:lib",
-    "build:lib": "tsc -b tsconfig.build.json",
-    "lint": "eslint src --ext .ts,.mjs",
-    "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
-    "check:ts": "tsc -b tsconfig.check.json",
-    "clean:all": "npm run clean:lib",
-    "clean:lib": "rimraf es/**"
   }
-}
+}

package/es/image.d.ts

@@ -1,123 +0,0 @@
-import type { RenderLevel } from './type';
-import type { BinaryPointer } from './binary';
-import type { DataType } from './components';
-export interface TextureFormatOptions {
-    format?: GLenum;
-    internalFormat?: GLenum;
-    type?: GLenum;
-}
-export interface TextureConfigOptionsBase {
-    generateMipmap?: boolean;
-    id?: string;
-    dataType?: DataType.Texture;
-    name?: string;
-    wrapS?: GLenum;
-    wrapT?: GLenum;
-    magFilter?: GLenum;
-    minFilter?: GLenum;
-    anisotropic?: number;
-    flipY?: boolean;
-    premultiplyAlpha?: boolean;
-    keepImageSource?: boolean;
-}
-export type SerializedTextureCubeMipmap = [
-    TEXTURE_CUBE_MAP_POSITIVE_X: BinaryPointer,
-    TEXTURE_CUBE_MAP_NEGATIVE_X: BinaryPointer,
-    TEXTURE_CUBE_MAP_POSITIVE_Y: BinaryPointer,
-    TEXTURE_CUBE_MAP_NEGATIVE_Y: BinaryPointer,
-    TEXTURE_CUBE_MAP_POSITIVE_Z: BinaryPointer,
-    TEXTURE_CUBE_MAP_NEGATIVE_Z: BinaryPointer
-];
-export interface SerializedTexture2DImageSource extends TextureConfigOptionsBase, TextureFormatOptions {
-    target?: WebGLRenderingContext['TEXTURE_2D'];
-    source: number;
-}
-export interface SerializedTexture2DMipmapSource extends TextureConfigOptionsBase, TextureFormatOptions {
-    target?: WebGLRenderingContext['TEXTURE_2D'];
-    mipmaps: BinaryPointer[];
-}
-export interface SerializedTextureCube extends TextureConfigOptionsBase, TextureFormatOptions {
-    target: WebGLRenderingContext['TEXTURE_CUBE_MAP'];
-    mipmaps: SerializedTextureCubeMipmap[];
-}
-export type SerializedTexture2D = SerializedTexture2DImageSource | SerializedTexture2DMipmapSource;
-export type SerializedTextureSource = SerializedTexture2D | SerializedTextureCube;
-export type TextureJSONOptions = SerializedTextureSource;
-export type TextureDefine = TextureJSONOptions;
-/**
- * 动态换图类型
- * @since 1.1.0
- */
-export declare enum BackgroundType {
-    video = "video",
-    image = "image"
-}
-export interface TemplateContent {
-    /**
-     * 当 template 宽高和 image 不相同时，会对 template 进行缩放，使其和 image 相同。
-     */
-    width: number;
-    height: number;
-    background?: {
-        type: BackgroundType;
-        name: string;
-        url: string | HTMLImageElement;
-    };
-}
-export type TemplateVariables = Record<string, string | string[] | HTMLImageElement | HTMLImageElement[]>;
-/**
- * 纹理贴图属性
- */
-export interface Image {
-    id: string;
-    /**
-     * 纹理贴图地址
-     */
-    url: string;
-    /**
-     * WebP 地址
-     * 如果运行时支持 WebP，则优先使用 WebP
-     */
-    webp?: string;
-    /**
-     * AVIF 地址
-     * 如果运行时支持 AVIF，则优先使用 AVIF
-     * @since 2.0.0
-     */
-    avif?: string;
-    /**
-     * 纹理贴图渲染等级
-     * 如果没有设置，按照 B+ 处理
-     */
-    renderLevel?: RenderLevel;
-    /**
-     * 是否使用 mipmap
-     * loader 发布压缩纹理的时候会根据此参数决定是否生成压缩纹理
-     * @default false
-     */
-    mipmap?: boolean;
-    /**
-     * 图片 Y 轴的方向，如果 Y 轴向上（与 OpenGL 相同）则为 1
-     * 如果 Y 轴向下（与 OpenGL 相反）则为 -1，图片再绘制数据模板的时候需要翻转绘制
-     * @default 1
-     */
-    oriY?: 1 | -1;
-}
-/**
- * 模板贴图属性
- */
-export interface TemplateImage extends Image {
-    template: TemplateContent;
-}
-/**
- * 压缩贴图属性
- */
-export interface CompressedImage extends Image {
-    /**
-     * 压缩贴图地址
-     */
-    compressed: {
-        astc?: string;
-        pvrtc?: string;
-    };
-}

package/es/image.js

@@ -1,9 +0,0 @@
-/**
- * 动态换图类型
- * @since 1.1.0
- */
-export var BackgroundType;
-(function (BackgroundType) {
-    BackgroundType["video"] = "video";
-    BackgroundType["image"] = "image";
-})(BackgroundType || (BackgroundType = {}));