@galacean/effects-core 2.0.0-alpha.7 → 2.0.0-alpha.9

package/dist/asset-loader.d.ts

@@ -1,3 +1,4 @@
+import * as spec from '@galacean/effects-specification';
 import type { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
 import type { ShaderMarcos } from './render';
@@ -17,104 +18,26 @@ export declare class AssetLoader {
 export declare class Database {
     loadGUID(guid: string): Promise<EffectsObject | undefined>;
 }
-export declare enum DataType {
-    VFXItemData = "VFXItemData",
-    EffectComponent = "EffectComponent",
-    Material = "Material",
-    Shader = "Shader",
-    SpriteComponent = "SpriteComponent",
-    ParticleSystem = "ParticleSystem",
-    InteractComponent = "InteractComponent",
-    CameraController = "CameraController",
-    Geometry = "Geometry",
-    Texture = "Texture",
-    TextComponent = "TextComponent",
-    MeshComponent = "MeshComponent",
-    SkyboxComponent = "SkyboxComponent",
-    LightComponent = "LightComponent",
-    CameraComponent = "CameraComponent",
-    ModelPluginComponent = "ModelPluginComponent",
-    TreeComponent = "TreeComponent"
-}
-export interface DataPath {
-    id: string;
-}
-export interface EffectsObjectData {
-    id: string;
-    name?: string;
-    dataType: string;
-}
-export interface ColorData {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-export interface Vector4Data {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}
-export interface Vector2Data {
-    x: number;
-    y: number;
-}
-export interface MaterialTextureProperty {
-    texture: DataPath;
-    offset: Vector2Data;
-    scale: Vector2Data;
-}
-export interface MaterialData extends EffectsObjectData {
-    shader: DataPath;
-    blending?: boolean;
-    zWrite?: boolean;
-    zTest?: boolean;
-    ints: Record<string, number>;
-    floats: Record<string, number>;
-    vector4s: Record<string, Vector4Data>;
-    colors: Record<string, ColorData>;
-    textures: Record<string, MaterialTextureProperty>;
+export interface MaterialData extends spec.MaterialData {
     /**
      * shader的宏定义
      */
     marcos?: ShaderMarcos;
 }
-export interface GeometryData extends EffectsObjectData {
-    vertexData: VertexData;
+export interface GeometryData extends spec.EffectsObjectData {
+    vertexData: spec.VertexData;
     indexFormat: number;
     indexOffset: number;
     buffer: string;
 }
-export interface VertexData {
-    vertexCount: number;
-    channels: VertexChannel[];
-}
-export interface VertexChannel {
-    offset: number;
-    format: number;
-    dimension: number;
-}
-export interface ShaderData extends EffectsObjectData {
-    vertex: string;
-    fragment: string;
-    properties?: string;
-}
-export interface EffectComponentData extends EffectsObjectData {
+export interface EffectComponentData extends spec.EffectsObjectData {
     _priority: number;
-    item: DataPath;
-    materials: DataPath[];
-    geometry: DataPath;
+    item: spec.DataPath;
+    materials: spec.DataPath[];
+    geometry: spec.DataPath;
 }
 export type VFXItemData = VFXItemProps & {
-    dataType: DataType;
-    components: DataPath[];
+    dataType: spec.DataType;
+    components: spec.DataPath[];
 };
-export type SceneData = Record<string, EffectsObjectData>;
-export interface EffectsPackageData {
-    fileSummary: {
-        guid: string;
-        assetType: string;
-    };
-    exportObjects: EffectsObjectData[];
-}
+export type SceneData = Record<string, spec.EffectsObjectData>;

package/dist/asset-manager.d.ts

@@ -1,86 +1,7 @@
-import * as spec from '@galacean/effects-specification';
 import { Downloader } from './downloader';
-import type { Scene } from './scene';
+import type { Scene, SceneLoadOptions, SceneType } from './scene';
 import type { Disposable } from './utils';
 import type { Renderer } from './render';
-/**
- * 场景加载参数
- */
-export interface SceneLoadOptions {
-    /**
-     * 动态数据的参数
-     * key 是 JSON 中配置的字段名
-     * value 是要使用的值，图片使用 url 链接
-     * 图片链接可以使用数组传递，如果第一个加载失败，将尝试使用第二个地址
-     *
-     * @example
-     * ``` ts
-     * {
-     *   variables: {
-     *     bg: ['url','fallback_url'], // 如果两个图片都失败，将会触发加载失败
-     *     fg: 'url' // 如果图片加载失败，将会触发加载失败,
-     *     amount: 88.8,
-     *     name: 'abc'
-     *   }
-     * }
-     * ```
-     */
-    variables?: Record<string, number | string | string[]>;
-    /**
-     * 模板图片缩放倍数
-     * @default 1 如果图片比较糊，可以用 2（但会增大图片内存）
-     */
-    templateScale?: number;
-    /**
-     * 是否使用压缩纹理
-     */
-    useCompressedTexture?: boolean;
-    /**
-     * 渲染分级。
-     * 分级之后，只会加载当前渲染等级的资源。
-     * 当渲染等级被设置为 B 后，player 的 fps 会降到 30 帧
-     * @default 's'
-     */
-    renderLevel?: spec.RenderLevel;
-    /**
-     * 资源加载超时，时间单位秒
-     * @default 10s
-     */
-    timeout?: number;
-    /***
-     * 用于给 plugin 的加载数据
-     * key/value 的内容由 plugin 自己实现
-     */
-    pluginData?: Record<string, any>;
-    /**
-     * 场景加载时的环境（加载后把 env 结果写入 scene）
-     * @default '' - 编辑器中为 'editor'
-     */
-    env?: string;
-    /**
-     * 加载后是否自动播放
-     * @default true
-     */
-    autoplay?: boolean;
-    /**
-     * 合成播放完成后是否需要再使用，是的话生命周期结束后不会 `dispose`
-     * @default false
-     */
-    reusable?: boolean;
-    /**
-     * 播放速度，当速度为负数时，合成倒播
-     */
-    speed?: number;
-}
-/**
- * 接受用于加载的数据类型
- */
-export type SceneType = string | Scene | Record<string, unknown>;
-export type SceneWithOptionsType = {
-    scene: SceneType;
-    options: SceneLoadOptions;
-};
-export type SceneLoadType = SceneType | SceneWithOptionsType;
 /**
  * 资源管理器
  * 用于加载和动效中所有的资源文件，包括图片、插件、图层粒子数据等

package/dist/canvas-pool.d.ts

@@ -0,0 +1,10 @@
+declare class CanvasPool {
+    readonly elements: HTMLCanvasElement[];
+    constructor();
+    dispose(): void;
+    getCanvas(): HTMLCanvasElement;
+    saveCanvas(canvas: HTMLCanvasElement): void;
+}
+export declare const canvasPool: CanvasPool;
+export declare function getDefaultTemplateCanvasPool(): CanvasPool;
+export {};

package/dist/composition.d.ts

@@ -7,13 +7,12 @@ import type { PluginSystem } from './plugin-system';
 import type { EventSystem, Region } from './plugins';
 import type { MeshRendererOptions, Renderer } from './render';
 import { RenderFrame } from './render';
-import type { Scene } from './scene';
+import type { Scene, SceneType } from './scene';
 import type { Texture } from './texture';
 import { Transform } from './transform';
 import type { Disposable, LostHandler } from './utils';
 import type { VFXItemContent, VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
-import type { SceneType } from './asset-manager';
 export interface CompositionStatistic {
     loadTime: number;
     loadStart: number;
@@ -239,6 +238,12 @@ export declare class Composition implements Disposable, LostHandler {
      * @param speed - 速度
      */
     setSpeed(speed: number): void;
+    /**
+     * 设置合成的可见性
+     * @since 2.0.0
+     * @param visible - 是否可见
+     */
+    setVisible(visible: boolean): void;
     /**
      * 获取合成的动画速度
      * @returns

package/dist/constants.d.ts

@@ -4,7 +4,6 @@ export declare const SEMANTIC_PRE_COLOR_ATTACHMENT_SIZE_0 = "PRE_COLOR_SIZE_0";
 export declare const SEMANTIC_MAIN_PRE_COLOR_ATTACHMENT_0 = "PRE_MAIN_COLOR_0";
 export declare const SEMANTIC_MAIN_PRE_COLOR_ATTACHMENT_SIZE_0 = "PRE_MAIN_COLOR_SIZE_0";
 export declare const PLAYER_OPTIONS_ENV_EDITOR = "editor";
-export declare const FILTER_NAME_NONE = "none";
 export declare const HELP_LINK: {
     'Filter not imported': string;
     'Item duration can\'t be less than 0': string;

package/dist/downloader.d.ts

@@ -1,5 +1,8 @@
 type SuccessHandler<T> = (data: T) => void;
 type ErrorHandler = (status: number, responseText: string) => void;
+/**
+ *
+ */
 /**
  * JSON 值，它可以是字符串、数字、布尔值、对象或者 JSON 值的数组。
  *
@@ -70,4 +73,5 @@ export declare function loadBlob(url: string): Promise<Blob>;
  * @param url - 视频文件的 URL 或 MediaProvider 对象
  */
 export declare function loadVideo(url: string | MediaProvider): Promise<HTMLVideoElement>;
+export declare function loadMedia(url: string | string[], loadFn: (url: string) => Promise<HTMLImageElement | HTMLVideoElement>): Promise<HTMLImageElement | HTMLVideoElement>;
 export {};

package/dist/effects-object.d.ts

@@ -1,4 +1,4 @@
-import type { EffectsObjectData } from './asset-loader';
+import type * as spec from '@galacean/effects-specification';
 import type { Engine } from './engine';
 /**
  * @since 2.0.0
@@ -20,6 +20,6 @@ export declare abstract class EffectsObject {
      *
      * @param data - 对象的序列化的数据
      */
-    fromData(data: EffectsObjectData): void;
+    fromData(data: spec.EffectsObjectData): void;
     dispose(): void;
 }

package/dist/engine.d.ts

@@ -1,4 +1,5 @@
-import type { Database, EffectsObjectData, SceneData } from './asset-loader';
+import * as spec from '@galacean/effects-specification';
+import type { Database, SceneData } from './asset-loader';
 import { AssetLoader } from './asset-loader';
 import type { EffectsObject } from './effects-object';
 import type { Material } from './material';
@@ -30,8 +31,8 @@ export declare class Engine implements Disposable {
      */
     static create: (gl: WebGLRenderingContext | WebGL2RenderingContext) => Engine;
     clearResources(): void;
-    addEffectsObjectData(data: EffectsObjectData): void;
-    findEffectsObjectData(uuid: string): EffectsObjectData;
+    addEffectsObjectData(data: spec.EffectsObjectData): void;
+    findEffectsObjectData(uuid: string): spec.EffectsObjectData;
     addInstance(effectsObject: EffectsObject): void;
     getInstance(id: string): EffectsObject;
     removeInstance(id: string): void;

package/dist/index.d.ts

@@ -22,7 +22,6 @@ export * from './plugin-system';
 export * from './plugins';
 export * from './render';
 export * from './scene';
-export * from './semantic-map';
 export * from './shader';
 export * from './shape';
 export * from './template-image';
@@ -32,3 +31,4 @@ export * from './ticker';
 export * from './transform';
 export * from './utils';
 export * from './vfx-item';
+export * from './canvas-pool';