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

package/dist/material/material.d.ts

@@ -1,4 +1,4 @@
-import type { Matrix3, Matrix4, Quaternion, Vector2, Vector3, Vector4 } from '@galacean/effects-math/es/core/index';
+import type { Matrix3, Matrix4, Quaternion, Vector2, Vector3, Vector4, Color } from '@galacean/effects-math/es/core/index';
 import type { GlobalUniforms, Renderer, Shader, ShaderWithSource } from '../render';
 import type { Texture } from '../texture';
 import type { DestroyOptions, Disposable } from '../utils';
@@ -249,6 +249,17 @@ export declare abstract class Material extends EffectsObject implements Disposab
      * @param value - 要设置的 uniform 数据
      */
     abstract setVector4(name: string, value: Vector4): void;
+    /**
+     * 获取 Material 的 Color 类型的 uniform 数据
+     * @param name
+     */
+    abstract getColor(name: string): Color | null;
+    /**
+     * 设置 Color 类型的 uniform 的数据
+     * @param name - uniform 名称
+     * @param value - 要设置的 uniform 数据
+     */
+    abstract setColor(name: string, value: Color): void;
     /**
      * 获取 Material 的 Quaternion 类型的 uniform 数据
      * @param name

package/dist/plugin-system.d.ts

@@ -1,9 +1,8 @@
 import type * as spec from '@galacean/effects-specification';
-import type { SceneLoadOptions } from './asset-manager';
 import type { Composition } from './composition';
 import type { Plugin, PluginConstructor } from './plugins';
 import type { RenderFrame, Renderer } from './render';
-import type { Scene } from './scene';
+import type { Scene, SceneLoadOptions } from './scene';
 import type { VFXItemConstructor, VFXItemProps } from './vfx-item';
 import { VFXItem } from './vfx-item';
 export declare const pluginLoaderMap: Record<string, PluginConstructor>;

package/dist/plugins/plugin.d.ts

@@ -1,6 +1,5 @@
 import type * as spec from '@galacean/effects-specification';
-import type { SceneLoadOptions } from '../asset-manager';
-import type { Scene } from '../scene';
+import type { Scene, SceneLoadOptions } from '../scene';
 import type { VFXItem } from '../vfx-item';
 import type { RenderFrame, Renderer } from '../render';
 import type { Composition } from '../composition';

package/dist/plugins/sprite/sprite-item.d.ts

@@ -109,6 +109,19 @@ export declare class SpriteComponent extends RendererComponent {
      * 获取当前 Mesh 的可见性。
      */
     getVisible(): boolean;
+    /**
+     * 设置当前图层的颜色
+     * > Tips: 透明度也属于颜色的一部分，当有透明度/颜色 K 帧变化时，该 API 会失效
+     * @since 2.0.0
+     * @param color - 颜色值
+     */
+    setColor(color: vec4): void;
+    /**
+     * 设置当前 Mesh 的纹理
+     * @since 2.0.0
+     * @param texture - 纹理对象
+     */
+    setTexture(texture: Texture): void;
     render(renderer: Renderer): void;
     start(): void;
     update(dt: number): void;

package/dist/plugins/text/text-item.d.ts

@@ -4,6 +4,7 @@ import type { SpriteItemProps } from '../sprite/sprite-item';
 import { SpriteComponent } from '../sprite/sprite-item';
 import { TextLayout } from './text-layout';
 import { TextStyle } from './text-style';
+export declare const DEFAULT_FONTS: string[];
 /**
  * @since 2.0.0
  * @internal

package/dist/render/index.d.ts

@@ -10,3 +10,4 @@ export * from './geometry';
 export * from './frame-buffer';
 export * from './renderer';
 export * from './global-volume';
+export * from './semantic-map';

package/dist/render/render-frame.d.ts

@@ -4,8 +4,8 @@ import { Vector2, Vector4 } from '@galacean/effects-math/es/core/index';
 import type { Camera } from '../camera';
 import type { UniformValue } from '../material';
 import { PassTextureCache } from '../paas-texture-cache';
-import type { SemanticFunc } from '../semantic-map';
-import { SemanticMap } from '../semantic-map';
+import type { SemanticFunc } from './semantic-map';
+import { SemanticMap } from './semantic-map';
 import { Texture } from '../texture';
 import type { Disposable } from '../utils';
 import { DestroyOptions } from '../utils';

package/dist/render/render-pass.d.ts

@@ -5,8 +5,8 @@ import type { RendererComponent } from '../components';
 import type { Engine } from '../engine';
 import type { MeshDestroyOptions, Renderer } from '../render';
 import { FrameBuffer } from '../render';
-import type { SemanticGetter } from '../semantic-map';
-import { SemanticMap } from '../semantic-map';
+import type { SemanticGetter } from './semantic-map';
+import { SemanticMap } from './semantic-map';
 import type { TextureConfigOptions, TextureLoadAction } from '../texture';
 import { Texture } from '../texture';
 import type { Disposable, Sortable } from '../utils';

package/dist/{semantic-map.d.ts → render/semantic-map.d.ts}

@@ -1,6 +1,6 @@
-import type { UniformValue } from './material';
-import type { RenderingData } from './render';
-import type { Disposable } from './utils';
+import type { UniformValue } from '../material';
+import type { RenderingData } from '.';
+import type { Disposable } from '../utils';
 export type SemanticFunc = (state: RenderingData) => UniformValue | undefined;
 export type SemanticGetter = UniformValue | SemanticFunc;
 export declare class SemanticMap implements Disposable {

package/dist/scene.d.ts

@@ -1,10 +1,9 @@
 import type * as spec from '@galacean/effects-specification';
-import type { SceneType } from './asset-manager';
 import type { Texture } from './texture';
 import type { PluginSystem } from './plugin-system';
 export type ImageSource = spec.TemplateImage | spec.Image | spec.CompressedImage;
 /**
- *
+ * 场景类型
  */
 export interface Scene {
     readonly jsonScene: spec.JSONScene;
@@ -27,4 +26,81 @@ export interface Scene {
     url: SceneType;
     usedImages: Record<number, boolean>;
 }
-export declare function isScene(scene: any): scene is Scene;
+/**
+ * 场景加载参数
+ */
+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[]>;
+    /**
+     * 是否使用压缩纹理
+     */
+    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 SceneURLType = {
+    url: string;
+};
+export type SceneType = string | Scene | SceneURLType | Record<string, any>;
+export type SceneWithOptionsType = {
+    options: SceneLoadOptions;
+};
+export type SceneLoadType = SceneType | SceneWithOptionsType;
+export declare function isSceneJSON(scene: any): scene is Scene;
+export declare function isSceneURL(scene: any): scene is Scene;
+export declare function isSceneWithOptions(scene: any): scene is SceneWithOptionsType;

package/dist/template-image.d.ts

@@ -1,14 +1,4 @@
 import type { TemplateContent } from '@galacean/effects-specification';
-export declare const DEFAULT_FONTS: string[];
-declare class CanvasPool {
-    readonly elements: HTMLCanvasElement[];
-    constructor();
-    dispose(): void;
-    getCanvas(): HTMLCanvasElement;
-    saveCanvas(cvs: HTMLCanvasElement): void;
-}
-export declare const canvasPool: CanvasPool;
-export declare function getDefaultTemplateCanvasPool(): CanvasPool;
 export declare function getBackgroundImage(template: TemplateContent, variables?: Record<string, number | string | string[]>): string | number | string[] | undefined;
 /**
  * @param url
@@ -17,5 +7,4 @@ export declare function getBackgroundImage(template: TemplateContent, variables?
  * @param options
  * @returns
  */
-export declare function combineImageTemplate(url: string | HTMLImageElement, template?: TemplateContent, variables?: Record<string, number | string>): Promise<number | HTMLImageElement | string[]>;
-export {};
+export declare function combineImageTemplate(url: string | HTMLImageElement, template?: TemplateContent, variables?: Record<string, number | string>): Promise<HTMLImageElement>;

package/dist/texture/texture.d.ts

@@ -31,6 +31,12 @@ export declare abstract class Texture extends EffectsObject {
      * 创建一个新的 Texture 对象。
      */
     static create: (engine: Engine, options?: TextureSourceOptions) => Texture;
+    /**
+     * 通过 URL 创建 Texture 对象。
+     * @param url - 要创建的 Texture URL
+     * @since 2.0.0
+     */
+    static fromImage(url: string, engine: Engine): Promise<Texture>;
     /**
      * 通过数据创建 Texture 对象。
      * @param data - 要创建的 Texture 数据

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.0.0-alpha.8",
+  "version": "2.0.0-alpha.9",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",