@galacean/effects-specification 2.0.1 → 2.1.0-alpha.0

package/es/assets.d.ts

@@ -0,0 +1,95 @@
+import type { RenderLevel } from './type';
+/**
+ * 资源基类
+ */
+export interface AssetBase {
+    /**
+     * 资源 ID
+     */
+    id: string;
+    /**
+     * 资源类型
+     */
+    url: string;
+    /**
+     * 渲染等级
+     * 如果没有设置，按照 B+ 处理
+     */
+    renderLevel?: RenderLevel;
+}
+/**
+ * 动态换图类型
+ * @since 1.1.0
+ */
+export declare enum BackgroundType {
+    video = "video",
+    image = "image"
+}
+/**
+ * 多媒体资源类型
+ * @since 2.1.0
+ */
+export declare enum MultimediaType {
+    video = "video",
+    audio = "audio"
+}
+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 type ImageSource = Image | TemplateImage | CompressedImage;
+/**
+ * 纹理贴图属性
+ */
+export interface Image extends AssetBase {
+    /**
+     * WebP 地址
+     * 如果运行时支持 WebP，则优先使用 WebP
+     */
+    webp?: string;
+    /**
+     * AVIF 地址
+     * 如果运行时支持 AVIF，则优先使用 AVIF
+     * @since 2.0.0
+     */
+    avif?: string;
+    /**
+     * 是否使用 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/assets.js

@@ -0,0 +1,18 @@
+/**
+ * 动态换图类型
+ * @since 1.1.0
+ */
+export var BackgroundType;
+(function (BackgroundType) {
+    BackgroundType["video"] = "video";
+    BackgroundType["image"] = "image";
+})(BackgroundType || (BackgroundType = {}));
+/**
+ * 多媒体资源类型
+ * @since 2.1.0
+ */
+export var MultimediaType;
+(function (MultimediaType) {
+    MultimediaType["video"] = "video";
+    MultimediaType["audio"] = "audio";
+})(MultimediaType || (MultimediaType = {}));

package/es/buitin-object-guid.d.ts

@@ -1,5 +1,6 @@
 export declare const BuiltinObjectGUID: {
     WhiteTexture: string;
+    TransparentTexture: string;
     PBRShader: string;
     UnlitShader: string;
 };

package/es/buitin-object-guid.js

@@ -1,5 +1,6 @@
 export const BuiltinObjectGUID = {
     WhiteTexture: 'whitetexture00000000000000000000',
+    TransparentTexture: 'transparenttexture00000000000000000000',
     PBRShader: 'pbr00000000000000000000000000000',
     UnlitShader: 'unlit000000000000000000000000000',
 };

package/es/components.d.ts

@@ -32,6 +32,8 @@ export declare enum DataType {
     TreeComponent = "TreeComponent",
     AnimationComponent = "AnimationComponent",
     SpineComponent = "SpineComponent",
+    VideoComponent = "VideoComponent",
+    AudioComponent = "AudioComponent",
     TimelineClip = "TimelineClip"
 }
 export interface DataPath {
@@ -193,11 +195,6 @@ export interface ShaderData extends EffectsObjectData {
     fragment: string;
     properties?: string;
 }
-export interface EffectComponentData extends ComponentData {
-    _priority: number;
-    materials: DataPath[];
-    geometry: DataPath;
-}
 export interface EffectsPackageData {
     fileSummary: FileSummary;
     exportObjects: EffectsObjectData[];

package/es/components.js

@@ -34,6 +34,8 @@ export var DataType;
     DataType["TreeComponent"] = "TreeComponent";
     DataType["AnimationComponent"] = "AnimationComponent";
     DataType["SpineComponent"] = "SpineComponent";
+    DataType["VideoComponent"] = "VideoComponent";
+    DataType["AudioComponent"] = "AudioComponent";
     // Non-EffectObject
     DataType["TimelineClip"] = "TimelineClip";
 })(DataType || (DataType = {}));

package/es/index.d.ts

@@ -1,6 +1,6 @@
 export * from './type';
 export * from './composition';
-export * from './image';
+export * from './texture';
 export * from './constants';
 export * from './number-expression';
 export * from './scene';
@@ -17,6 +17,8 @@ export * from './item/sprite-item';
 export * from './item/spine-item';
 export * from './item/effect-item';
 export * from './item/text-item';
+export * from './item/video-item';
+export * from './item/audio-item';
 export * from './item/model';
 export * from './vfx-item-data';
 export * from './animation-clip-data';
@@ -26,3 +28,4 @@ export * from './components';
 export * from './vfx-item-data';
 export * from './buitin-object-guid';
 export * from './timeline';
+export * from './assets';

package/es/index.js

@@ -1,6 +1,6 @@
 export * from './type';
 export * from './composition';
-export * from './image';
+export * from './texture';
 export * from './constants';
 export * from './number-expression';
 export * from './scene';
@@ -17,6 +17,8 @@ export * from './item/sprite-item';
 export * from './item/spine-item';
 export * from './item/effect-item';
 export * from './item/text-item';
+export * from './item/video-item';
+export * from './item/audio-item';
 export * from './item/model';
 export * from './vfx-item-data';
 export * from './animation-clip-data';
@@ -26,3 +28,4 @@ export * from './components';
 export * from './vfx-item-data';
 export * from './buitin-object-guid';
 export * from './timeline';
+export * from './assets';

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

@@ -0,0 +1,46 @@
+import type { ComponentData, DataPath } from '../components';
+import type { ItemType } from '../type';
+import type { BaseItem } from './base-item';
+/**
+ * 音频元素
+ */
+export interface AudioItem extends BaseItem {
+    /**
+     * 元素类型（指定为 audio）
+     */
+    type: ItemType.audio;
+    /**
+     * 音频元素基础属性
+     */
+    content: AudioComponentData;
+}
+export interface AudioContentOptions {
+    /**
+     * 音频链接，索引到 scene 中的 audios 数组
+     */
+    audio: DataPath;
+    /**
+     * 音频播放速度
+     * @default 1
+     */
+    playbackRate?: number;
+    /**
+     * 是否静音播放
+     * @default false
+     */
+    muted?: boolean;
+    /**
+     * 音频音量大小
+     * @default 1
+     */
+    volume?: number;
+}
+/**
+ * 音频组件属性
+ */
+export interface AudioComponentData extends ComponentData {
+    /**
+     * 音频元素基础属性
+     */
+    options: AudioContentOptions;
+}

package/es/item/audio-item.js

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

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

@@ -1,3 +1,4 @@
+import type { ComponentData, DataPath } from '../components';
 import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
 import type { BaseItem, EndBehavior } from './base-item';
 /**
@@ -33,3 +34,8 @@ export interface EffectContent {
      */
     positionOverLifetime?: PositionOverLifetime;
 }
+export interface EffectComponentData extends ComponentData {
+    _priority: number;
+    materials: DataPath[];
+    geometry: DataPath;
+}

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

@@ -2,7 +2,7 @@ import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, Sp
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
 import type { BaseItem, EndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
-import type { ComponentData } from '../components';
+import type { ComponentData, DataPath } from '../components';
 /**
  * 粒子交互行为
  */
@@ -472,7 +472,7 @@ export interface ParticleTrail {
     /**
      * 拖尾贴图
      */
-    texture?: number;
+    texture?: DataPath;
     /**
      * 位置受父节点影响
      * 拖尾+图层绑定同一个父节点时使用

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

@@ -76,6 +76,10 @@ export interface PluginSpineOption {
      * @since 1.3.0
      */
     resizeRule: number;
+    /**
+     * 一组动作结束后是否循环最后一个动作
+     */
+    loopEnd?: boolean;
 }
 /**
  * spine资源信息

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

@@ -0,0 +1,82 @@
+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 } from './base-item';
+/**
+ * 视频元素
+ */
+export interface VideoItem extends BaseItem {
+    /**
+     * 元素类型（指定为 video）
+     */
+    type: ItemType.video;
+    /**
+     * 视频元素渲染信息
+     */
+    content: VideoComponentData;
+    endBehavior: EndBehavior;
+}
+export interface VideoContentOptions {
+    /**
+     * 元素基础颜色
+     * @default [255,255,255,255]
+     */
+    startColor?: RGBAColorValue;
+    /**
+     * 视频链接，索引到 scene 中的 videos 数组
+     */
+    video: DataPath;
+    /**
+     * 视频播放速度
+     * @default 1
+     */
+    playbackRate?: number;
+    /**
+     * 是否静音播放
+     * @default false
+     */
+    muted?: boolean;
+    /**
+     * 视频音量大小
+     * @default 1
+     */
+    volume?: number;
+}
+/**
+ * 视频组件属性
+ */
+export interface VideoComponentData extends ComponentData {
+    /**
+     * 视频元素基础属性
+     */
+    options: VideoContentOptions;
+    /**
+     * 视频元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 视频元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 视频元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 视频元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 视频元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 视频元素交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/es/item/video-item.js

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

package/es/item.d.ts

@@ -8,7 +8,9 @@ import type { ModelCameraItem, ModelLightItem, ModelMeshItem, ModelSkyboxItem, M
 import type { CameraItem } from './item/camera-item';
 import type { CompositionItem } from './item/composition-item';
 import type { TextItem } from './item/text-item';
+import type { VideoItem } from './item/video-item';
+import type { AudioItem } from './item/audio-item';
 /**
  * Item 基类，无对应元素
  */
-export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;
+export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | VideoItem | AudioItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/scene.d.ts

@@ -1,12 +1,13 @@
 import type { Composition, CompositionData } from './composition';
 import type { SpineResource } from './item/spine-item';
-import type { PlayerVersion, Shape } from './type';
-import type { TemplateImage, Image, CompressedImage, TextureDefine } from './image';
+import type { PlayerVersion, ShapeGeometry } from './type';
+import type { TextureDefine } from './texture';
 import type { FontBase, FontDefine } from './text';
 import type { BinaryFile } from './binary';
 import type { ComponentData, EffectsObjectData, GeometryData, MaterialData, ShaderData } from './components';
 import type { VFXItemData } from './vfx-item-data';
 import type { AnimationClipData } from './animation-clip-data';
+import type { AssetBase, ImageSource } from './assets';
 /**
  * runtime 2.0 之前的场景信息
  * 素材信息存放于统一数据结构中
@@ -50,7 +51,7 @@ export interface JSONSceneLegacy {
     /**
      * 贴图信息
      */
-    images: (TemplateImage | Image | CompressedImage)[];
+    images: ImageSource[];
     /**
      * 根据合成ID，每个合成用到的 image 的数组索引
      */
@@ -62,7 +63,7 @@ export interface JSONSceneLegacy {
     /**
      * 蒙版形状信息
      */
-    shapes: Shape[];
+    shapes: ShapeGeometry[];
     /**
      * 插件类型信息
      * 'model@1.0'
@@ -107,6 +108,7 @@ export interface JSONScene {
      * JSON 版本
      *
      * 3.0 EC 改造、移除滤镜元素
+     * 3.1 音视频
      */
     version: string;
     /**
@@ -131,7 +133,7 @@ export interface JSONScene {
     /**
      * 贴图信息
      */
-    images: (TemplateImage | Image | CompressedImage)[];
+    images: ImageSource[];
     /**
      * 根据合成 ID，每个合成用到的 image 的数组索引
      */
@@ -143,7 +145,7 @@ export interface JSONScene {
     /**
      * 蒙版形状信息
      */
-    shapes: Shape[];
+    shapes: ShapeGeometry[];
     /**
      * 插件类型信息
      * 'model@1.0'
@@ -154,6 +156,16 @@ export interface JSONScene {
      * 数据模板下掉可以不要 FontBase[]
      */
     fonts?: FontBase[] | FontDefine[];
+    /**
+     * 视频资源
+     * @since 2.0.0
+     */
+    videos?: AssetBase[];
+    /**
+     * 音频资源
+     * @since 2.0.0
+     */
+    audios?: AssetBase[];
     /**
      * 二进制文件地址
      */

package/es/texture.d.ts

@@ -0,0 +1,45 @@
+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;

package/es/texture.js

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

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[];
-}
 /**
  * 插件参数
  */
@@ -457,7 +445,7 @@ export interface RendererOptions {
     /**
      * 贴图，索引到 scene 中的 images 数组
      */
-    texture?: number;
+    texture?: DataPath;
     /**
      * 蒙版模式
      * @default none
@@ -543,7 +531,15 @@ export declare enum ItemType {
     /**
      * 节点元素
      */
-    node = "node"
+    node = "node",
+    /**
+     * 视频元素
+     */
+    video = "video",
+    /**
+     * 音频元素
+     */
+    audio = "audio"
 }
 /**
  * 渲染模式
@@ -670,3 +666,4 @@ export declare enum RenderFace {
     Back = "Back",
     Front = "Front"
 }
+export type HTMLImageLike = HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;

package/es/type.js

@@ -264,6 +264,14 @@ export var ItemType;
      * 节点元素
      */
     ItemType["node"] = "node";
+    /**
+     * 视频元素
+     */
+    ItemType["video"] = "video";
+    /**
+     * 音频元素
+     */
+    ItemType["audio"] = "audio";
 })(ItemType || (ItemType = {}));
 /**
  * 渲染模式

package/package.json

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

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 = {}));