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

package/es/animation-clip-data.d.ts

@@ -1,4 +1,4 @@
-import type { EffectsObjectData } from './components';
+import type { EffectsObjectData } from './effects-object-data';
 import type { FixedNumberExpression, FixedVec3Expression, FixedQuatExpression } from './number-expression';
 export interface AnimationClipData extends EffectsObjectData {
     positionCurves: PositionCurveData[];

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/binary.d.ts

@@ -1,6 +1,7 @@
-import type { DataType, EffectsObjectData } from './components';
 import type { RenderLevel } from './type';
 import type { ValueType } from './number-expression';
+import type { DataType } from './data-type';
+import type { EffectsObjectData } from './effects-object-data';
 /**
  * index: 指向 json 中 bins 数组
  * start: 二进制开始的 byte 偏移，默认为 0

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/component-data.d.ts

@@ -0,0 +1,7 @@
+import type { EffectsObjectData } from '../effects-object-data';
+export interface DataPath {
+    id: string;
+}
+export interface ComponentData extends EffectsObjectData {
+    item: DataPath;
+}

package/es/components/component-data.js

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

package/es/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './component-data';
+export * from './post-process-volume-data';

package/es/components/index.js

@@ -0,0 +1,2 @@
+export * from './component-data';
+export * from './post-process-volume-data';

package/es/components/post-process-volume-data.d.ts

@@ -0,0 +1,38 @@
+import type { ComponentData } from './component-data';
+export interface PostProcessVolumeData extends ComponentData {
+    /**
+     * 泛光
+     */
+    bloom?: Bloom;
+    /**
+     * 颜色调整
+     */
+    colorAdjustments?: ColorAdjustments;
+    /**
+     * 晕影
+     */
+    vignette?: Vignette;
+    /**
+     * 色调映射
+     */
+    tonemapping?: Tonemapping;
+}
+export interface PostProcessEffectSettings {
+    active: boolean;
+}
+export interface Bloom extends PostProcessEffectSettings {
+    threshold: number;
+    intensity: number;
+}
+export interface Tonemapping extends PostProcessEffectSettings {
+}
+export interface ColorAdjustments extends PostProcessEffectSettings {
+    brightness: number;
+    saturation: number;
+    contrast: number;
+}
+export interface Vignette extends PostProcessEffectSettings {
+    intensity: number;
+    smoothness: number;
+    roundness: number;
+}

package/es/components/post-process-volume-data.js

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

package/es/composition.d.ts

@@ -74,10 +74,6 @@ interface CompositionBase {
      * @default [0,0]
      */
     previewSize?: [width: number, height: number];
-    /**
-     * 降级图
-     */
-    fallbackImage?: string;
 }
 /**
  * 合成信息

package/es/curve-data/color-curve-data.d.ts

@@ -0,0 +1,7 @@
+import type { BezierValue } from '../number-expression';
+export type ColorCurveData = [
+    r: BezierValue,
+    g: BezierValue,
+    b: BezierValue,
+    a: BezierValue
+];

package/es/curve-data/color-curve-data.js

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

package/es/curve-data/index.d.ts

@@ -0,0 +1,2 @@
+export * from './color-curve-data';
+export * from './vector4-curve-data';

package/es/curve-data/index.js

@@ -0,0 +1,2 @@
+export * from './color-curve-data';
+export * from './vector4-curve-data';

package/es/curve-data/vector4-curve-data.d.ts

@@ -0,0 +1,7 @@
+import type { BezierValue } from '../number-expression';
+export type Vector4CurveData = [
+    x: BezierValue,
+    y: BezierValue,
+    z: BezierValue,
+    w: BezierValue
+];

package/es/curve-data/vector4-curve-data.js

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

package/es/data-type.d.ts

@@ -0,0 +1,47 @@
+export declare enum DataType {
+    VFXItemData = "VFXItemData",
+    EffectComponent = "EffectComponent",
+    Material = "Material",
+    Shader = "Shader",
+    SpriteComponent = "SpriteComponent",
+    ParticleSystem = "ParticleSystem",
+    InteractComponent = "InteractComponent",
+    CameraController = "CameraController",
+    PostProcessVolume = "PostProcessVolume",
+    Geometry = "Geometry",
+    Texture = "Texture",
+    Image = "Image",
+    AnimationClip = "AnimationClip",
+    TextComponent = "TextComponent",
+    BinaryAsset = "BinaryAsset",
+    TrackAsset = "TrackAsset",
+    TimelineAsset = "TimelineAsset",
+    ObjectBindingTrack = "ObjectBindingTrack",
+    TransformTrack = "TransformTrack",
+    SpriteColorTrack = "SpriteColorTrack",
+    ActivationTrack = "ActivationTrack",
+    SubCompositionTrack = "SubCompositionTrack",
+    FloatPropertyTrack = "FloatPropertyTrack",
+    ColorPropertyTrack = "ColorPropertyTrack",
+    Vector4PropertyTrack = "Vector4PropertyTrack",
+    TransformPlayableAsset = "TransformPlayableAsset",
+    SpriteColorPlayableAsset = "SpriteColorPlayableAsset",
+    ActivationPlayableAsset = "ActivationPlayableAsset",
+    SubCompositionPlayableAsset = "SubCompositionPlayableAsset",
+    FloatPropertyPlayableAsset = "FloatPropertyPlayableAsset",
+    ColorPropertyPlayableAsset = "ColorPropertyPlayableAsset",
+    MeshComponent = "MeshComponent",
+    SkyboxComponent = "SkyboxComponent",
+    LightComponent = "LightComponent",
+    CameraComponent = "CameraComponent",
+    ModelPluginComponent = "ModelPluginComponent",
+    TreeComponent = "TreeComponent",
+    AnimationComponent = "AnimationComponent",
+    SpineComponent = "SpineComponent",
+    VideoComponent = "VideoComponent",
+    AudioComponent = "AudioComponent",
+    RichTextComponent = "RichTextComponent",
+    OrientationComponent = "OrientationComponent",
+    ShapeComponent = "ShapeComponent",
+    TimelineClip = "TimelineClip"
+}

package/es/data-type.js

@@ -0,0 +1,50 @@
+export var DataType;
+(function (DataType) {
+    DataType["VFXItemData"] = "VFXItemData";
+    DataType["EffectComponent"] = "EffectComponent";
+    DataType["Material"] = "Material";
+    DataType["Shader"] = "Shader";
+    DataType["SpriteComponent"] = "SpriteComponent";
+    DataType["ParticleSystem"] = "ParticleSystem";
+    DataType["InteractComponent"] = "InteractComponent";
+    DataType["CameraController"] = "CameraController";
+    DataType["PostProcessVolume"] = "PostProcessVolume";
+    DataType["Geometry"] = "Geometry";
+    DataType["Texture"] = "Texture";
+    DataType["Image"] = "Image";
+    DataType["AnimationClip"] = "AnimationClip";
+    DataType["TextComponent"] = "TextComponent";
+    DataType["BinaryAsset"] = "BinaryAsset";
+    // Timeline
+    DataType["TrackAsset"] = "TrackAsset";
+    DataType["TimelineAsset"] = "TimelineAsset";
+    DataType["ObjectBindingTrack"] = "ObjectBindingTrack";
+    DataType["TransformTrack"] = "TransformTrack";
+    DataType["SpriteColorTrack"] = "SpriteColorTrack";
+    DataType["ActivationTrack"] = "ActivationTrack";
+    DataType["SubCompositionTrack"] = "SubCompositionTrack";
+    DataType["FloatPropertyTrack"] = "FloatPropertyTrack";
+    DataType["ColorPropertyTrack"] = "ColorPropertyTrack";
+    DataType["Vector4PropertyTrack"] = "Vector4PropertyTrack";
+    DataType["TransformPlayableAsset"] = "TransformPlayableAsset";
+    DataType["SpriteColorPlayableAsset"] = "SpriteColorPlayableAsset";
+    DataType["ActivationPlayableAsset"] = "ActivationPlayableAsset";
+    DataType["SubCompositionPlayableAsset"] = "SubCompositionPlayableAsset";
+    DataType["FloatPropertyPlayableAsset"] = "FloatPropertyPlayableAsset";
+    DataType["ColorPropertyPlayableAsset"] = "ColorPropertyPlayableAsset";
+    DataType["MeshComponent"] = "MeshComponent";
+    DataType["SkyboxComponent"] = "SkyboxComponent";
+    DataType["LightComponent"] = "LightComponent";
+    DataType["CameraComponent"] = "CameraComponent";
+    DataType["ModelPluginComponent"] = "ModelPluginComponent";
+    DataType["TreeComponent"] = "TreeComponent";
+    DataType["AnimationComponent"] = "AnimationComponent";
+    DataType["SpineComponent"] = "SpineComponent";
+    DataType["VideoComponent"] = "VideoComponent";
+    DataType["AudioComponent"] = "AudioComponent";
+    DataType["RichTextComponent"] = "RichTextComponent";
+    DataType["OrientationComponent"] = "OrientationComponent";
+    DataType["ShapeComponent"] = "ShapeComponent";
+    // Non-EffectObject
+    DataType["TimelineClip"] = "TimelineClip";
+})(DataType || (DataType = {}));

package/es/effects-object-data.d.ts

@@ -0,0 +1,6 @@
+import type { DataType } from './data-type';
+export interface EffectsObjectData {
+    id: string;
+    name?: string;
+    dataType: DataType;
+}

package/es/effects-object-data.js

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

package/es/effects-package-data.d.ts

@@ -0,0 +1,9 @@
+import type { EffectsObjectData } from './effects-object-data';
+export interface EffectsPackageData {
+    fileSummary: FileSummary;
+    exportObjects: EffectsObjectData[];
+}
+export interface FileSummary {
+    guid: string;
+    assetType: string;
+}

package/es/effects-package-data.js

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

package/es/{components.d.ts → geometry-data.d.ts}

@@ -1,80 +1,4 @@
-import type { Vector2Data } from './item/base-item';
-export declare enum DataType {
-    VFXItemData = "VFXItemData",
-    EffectComponent = "EffectComponent",
-    Material = "Material",
-    Shader = "Shader",
-    SpriteComponent = "SpriteComponent",
-    ParticleSystem = "ParticleSystem",
-    InteractComponent = "InteractComponent",
-    CameraController = "CameraController",
-    Geometry = "Geometry",
-    Texture = "Texture",
-    AnimationClip = "AnimationClip",
-    TextComponent = "TextComponent",
-    BinaryAsset = "BinaryAsset",
-    TrackAsset = "TrackAsset",
-    TimelineAsset = "TimelineAsset",
-    ObjectBindingTrack = "ObjectBindingTrack",
-    TransformTrack = "TransformTrack",
-    SpriteColorTrack = "SpriteColorTrack",
-    ActivationTrack = "ActivationTrack",
-    SubCompositionTrack = "SubCompositionTrack",
-    TransformPlayableAsset = "TransformPlayableAsset",
-    SpriteColorPlayableAsset = "SpriteColorPlayableAsset",
-    ActivationPlayableAsset = "ActivationPlayableAsset",
-    SubCompositionPlayableAsset = "SubCompositionPlayableAsset",
-    MeshComponent = "MeshComponent",
-    SkyboxComponent = "SkyboxComponent",
-    LightComponent = "LightComponent",
-    CameraComponent = "CameraComponent",
-    ModelPluginComponent = "ModelPluginComponent",
-    TreeComponent = "TreeComponent",
-    AnimationComponent = "AnimationComponent",
-    SpineComponent = "SpineComponent",
-    TimelineClip = "TimelineClip"
-}
-export interface DataPath {
-    id: string;
-}
-export interface EffectsObjectData {
-    id: string;
-    name?: string;
-    dataType: DataType;
-}
-export interface ComponentData extends EffectsObjectData {
-    item: DataPath;
-}
-export interface ColorData {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-export interface Vector4Data {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}
-export interface MaterialTextureProperty {
-    texture: DataPath;
-    offset?: Vector2Data;
-    scale?: Vector2Data;
-}
-export interface MaterialData extends EffectsObjectData {
-    shader: DataPath;
-    blending?: boolean;
-    zWrite?: boolean;
-    zTest?: boolean;
-    stringTags: Record<string, string>;
-    macros: string[];
-    ints: Record<string, number>;
-    floats: Record<string, number>;
-    vector4s: Record<string, Vector4Data>;
-    colors: Record<string, ColorData>;
-    textures: Record<string, MaterialTextureProperty>;
-}
+import type { EffectsObjectData } from './effects-object-data';
 export interface GeometryData extends EffectsObjectData {
     vertexData: VertexData;
     indexFormat: IndexFormatType;
@@ -188,21 +112,3 @@ export declare enum VertexBufferSemantic {
     TangentBS2 = "TANGENT_BS2",
     TangentBS3 = "TANGENT_BS3"
 }
-export interface ShaderData extends EffectsObjectData {
-    vertex: string;
-    fragment: string;
-    properties?: string;
-}
-export interface EffectComponentData extends ComponentData {
-    _priority: number;
-    materials: DataPath[];
-    geometry: DataPath;
-}
-export interface EffectsPackageData {
-    fileSummary: FileSummary;
-    exportObjects: EffectsObjectData[];
-}
-export interface FileSummary {
-    guid: string;
-    assetType: string;
-}

package/es/{components.js → geometry-data.js}

@@ -1,42 +1,3 @@
-export var DataType;
-(function (DataType) {
-    DataType["VFXItemData"] = "VFXItemData";
-    DataType["EffectComponent"] = "EffectComponent";
-    DataType["Material"] = "Material";
-    DataType["Shader"] = "Shader";
-    DataType["SpriteComponent"] = "SpriteComponent";
-    DataType["ParticleSystem"] = "ParticleSystem";
-    DataType["InteractComponent"] = "InteractComponent";
-    DataType["CameraController"] = "CameraController";
-    DataType["Geometry"] = "Geometry";
-    DataType["Texture"] = "Texture";
-    DataType["AnimationClip"] = "AnimationClip";
-    DataType["TextComponent"] = "TextComponent";
-    DataType["BinaryAsset"] = "BinaryAsset";
-    // Timeline
-    DataType["TrackAsset"] = "TrackAsset";
-    DataType["TimelineAsset"] = "TimelineAsset";
-    DataType["ObjectBindingTrack"] = "ObjectBindingTrack";
-    DataType["TransformTrack"] = "TransformTrack";
-    DataType["SpriteColorTrack"] = "SpriteColorTrack";
-    DataType["ActivationTrack"] = "ActivationTrack";
-    DataType["SubCompositionTrack"] = "SubCompositionTrack";
-    DataType["TransformPlayableAsset"] = "TransformPlayableAsset";
-    DataType["SpriteColorPlayableAsset"] = "SpriteColorPlayableAsset";
-    DataType["ActivationPlayableAsset"] = "ActivationPlayableAsset";
-    DataType["SubCompositionPlayableAsset"] = "SubCompositionPlayableAsset";
-    // FIXME: 先完成ECS的场景转换，后面移到spec中
-    DataType["MeshComponent"] = "MeshComponent";
-    DataType["SkyboxComponent"] = "SkyboxComponent";
-    DataType["LightComponent"] = "LightComponent";
-    DataType["CameraComponent"] = "CameraComponent";
-    DataType["ModelPluginComponent"] = "ModelPluginComponent";
-    DataType["TreeComponent"] = "TreeComponent";
-    DataType["AnimationComponent"] = "AnimationComponent";
-    DataType["SpineComponent"] = "SpineComponent";
-    // Non-EffectObject
-    DataType["TimelineClip"] = "TimelineClip";
-})(DataType || (DataType = {}));
 export var GeometryType;
 (function (GeometryType) {
     /**

package/es/index.d.ts

@@ -1,9 +1,10 @@
 export * from './type';
 export * from './composition';
-export * from './image';
+export * from './texture';
 export * from './constants';
 export * from './number-expression';
 export * from './scene';
+export * from './math';
 export * from './item';
 export * from './item/base-item';
 export * from './item/camera-item';
@@ -17,12 +18,24 @@ export * from './item/sprite-item';
 export * from './item/spine-item';
 export * from './item/effect-item';
 export * from './item/text-item';
+export * from './item/rich-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';
 export * from './binary';
 export * from './text';
 export * from './components';
-export * from './vfx-item-data';
 export * from './buitin-object-guid';
+export * from './shape';
 export * from './timeline';
+export * from './assets';
+export * from './render-settings';
+export * from './curve-data';
+export * from './data-type';
+export * from './effects-object-data';
+export * from './material-data';
+export * from './geometry-data';
+export * from './shader-data';
+export * from './effects-package-data';

package/es/index.js

@@ -1,9 +1,10 @@
 export * from './type';
 export * from './composition';
-export * from './image';
+export * from './texture';
 export * from './constants';
 export * from './number-expression';
 export * from './scene';
+export * from './math';
 export * from './item';
 export * from './item/base-item';
 export * from './item/camera-item';
@@ -17,12 +18,24 @@ export * from './item/sprite-item';
 export * from './item/spine-item';
 export * from './item/effect-item';
 export * from './item/text-item';
+export * from './item/rich-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';
 export * from './binary';
 export * from './text';
 export * from './components';
-export * from './vfx-item-data';
 export * from './buitin-object-guid';
+export * from './shape';
 export * from './timeline';
+export * from './assets';
+export * from './render-settings';
+export * from './curve-data';
+export * from './data-type';
+export * from './effects-object-data';
+export * from './material-data';
+export * from './geometry-data';
+export * from './shader-data';
+export * from './effects-package-data';

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