@galacean/effects 2.0.0-alpha.2 → 2.0.0-alpha.20

package/dist/player.d.ts

@@ -1,4 +1,4 @@
-import type { Disposable, GPUCapability, LostHandler, RestoreHandler, SceneLoadOptions, math, SceneLoadType, SceneWithOptionsType } from '@galacean/effects-core';
+import type { Disposable, GLType, GPUCapability, LostHandler, RestoreHandler, SceneLoadOptions, math, SceneLoadType } from '@galacean/effects-core';
 import { Composition, Renderer, Ticker } from '@galacean/effects-core';
 /**
  * `onItemClicked` 点击回调函数的传入参数
@@ -53,7 +53,7 @@ export interface PlayerConfig {
     /**
      * 指定 WebGL 创建的上下文类型，`debug-disable` 表示不创建
      */
-    renderFramework?: 'webgl' | 'webgl2' | 'debug-disable';
+    renderFramework?: GLType | 'debug-disable';
     /**
      * player 的 name
      */
@@ -67,7 +67,7 @@ export interface PlayerConfig {
          * 图片预乘 Alpha
          * @default false
          */
-        premultiplyAlpha?: boolean;
+        premultipliedAlpha?: boolean;
     };
     /**
      * 是否通知 container touchend / mouseup 事件, 默认不通知
@@ -117,7 +117,6 @@ export interface PlayerConfig {
      * @param time - GPU 渲染使用的时间，秒
      */
     reportGPUTime?: (time: number) => void;
-    [key: string]: any;
 }
 /**
  * Galacean Effects 播放器
@@ -138,19 +137,20 @@ export declare class Player implements Disposable, LostHandler, RestoreHandler {
      * 手动渲染 `manualRender=true` 时不创建计时器
      */
     readonly ticker: Ticker;
-    /**
-     * 当前播放的合成对象数组，请不要修改内容
-     */
-    protected compositions: Composition[];
+    private readonly builtinObjects;
     private readonly event;
     private readonly handleWebGLContextLost?;
     private readonly handleWebGLContextRestored?;
     private readonly handleMessageItem?;
     private readonly handlePlayerPause?;
-    private readonly reportGPUTime?;
     private readonly handleItemClicked?;
     private readonly handlePlayableUpdate?;
     private readonly handleRenderError?;
+    private readonly reportGPUTime?;
+    /**
+     * 当前播放的合成对象数组，请不要修改内容
+     */
+    private compositions;
     private displayAspect;
     private displayScale;
     private forceRenderNextFrame;
@@ -158,7 +158,7 @@ export declare class Player implements Disposable, LostHandler, RestoreHandler {
     private resumePending;
     private offscreenMode;
     private disposed;
-    private assetManager;
+    private assetManagers;
     private speed;
     private baseCompositionIndex;
     /**
@@ -167,18 +167,26 @@ export declare class Player implements Disposable, LostHandler, RestoreHandler {
      */
     constructor(config: PlayerConfig);
     /**
-     * 设置 player 的播放速度，
+     * 设置当前 Player 的播放速度
      * @param speed - 播放速度
      */
     setSpeed(speed: number): void;
+    /**
+     * 获取当前 Player 的播放速度
+     * @returns
+     */
     getSpeed(): number;
     /**
-     * 根据名称查找对应的合成，可能找不到
+     * 根据名称查找对应的合成（可能找不到，如果有同名的合成，默认返回第一个）
+     * @example
+     * ``` ts
+     * const composition = player.getCompositionByName('新建合成1');
+     * ```
      * @param name - 目标合成名称
      */
     getCompositionByName(name: string): Composition | undefined;
     /**
-     * 获取当前播放的所有合成, 请不要修改返回数组的内容
+     * 获取当前播放的所有合成（请不要修改返回的数组内容）
      */
     getCompositions(): Composition[];
     /**
@@ -199,6 +207,60 @@ export declare class Player implements Disposable, LostHandler, RestoreHandler {
     set interactive(enable: boolean);
     /**
      * 加载动画资源
+     * @example
+     * ``` ts
+     * // 1. 加载单个合成链接并设置可选参数
+     * const composition = await player.loadScene('xxx.json', { ... });
+     * const composition = await player.loadScene({ url: 'xxx.json' }, { ... });
+     *
+     * // 2. 加载单个合成的 JSON 对象并设置可选参数
+     * const composition = await player.loadScene(JSONValue, { ... });
+     *
+     * // 3. 加载多个合成链接或 JSON 对象
+     * const [_, _, _] = await player.loadScene(['x1.json', 'x2.json', JSONValue]);
+     *
+     * // 4. 加载多个合成链接并各自设置可选参数
+     * const [_, _] = await player.loadScene([{
+     *   url: 'x1.json',
+     *   options: { autoplay: false, ... },
+     * }, {
+     *   url: 'x2.json',
+     *   options: { speed: 2, ... },
+     * }, { ... }]);
+     *
+     * // 5. 加载多个合成链接并统一设置可选参数（共用）
+     * const [_, _, _] = await player.loadScene(['x1.json', 'x2.json', ...], { ... });
+     * const [_, _] = await player.loadScene(
+     *   [{ url: 'x1.json' }, { url: 'x2.json' }, { ... }],
+     *   {
+     *     variables: {
+     *       'name': 'value',
+     *     },
+     *     speed: 2,
+     *     ...
+     *    },
+     * );
+     *
+     * // 6. 疯狂混合
+     * await player.loadScene([
+     *   {
+     *     url: 'x1.json',
+     *     options: {
+     *       variables: {
+     *         'name1': 'value1',
+     *       },
+     *       speed: 2,
+     *     },
+     *   },
+     *   'x2.json',
+     *   JSONValue,
+     * ], {
+     *   variables: {
+     *     'name2': 'value2',
+     *   },
+     *   speed: 0.1,
+     * });
+     * ```
      * @param scene - 一个或一组 URL 或者通过 URL 请求的 JSONObject 或者 Scene 对象
      * @param options - 加载可选参数
      * @returns
@@ -284,8 +346,8 @@ export declare class Player implements Disposable, LostHandler, RestoreHandler {
     private offloadTexture;
     private handleClick;
     private getTargetSize;
+    private destroyBuiltinObjects;
 }
-export declare function isSceneWithOptions(scene: any): scene is SceneWithOptionsType;
 /**
  * 禁止/允许创建新的播放器，已创建的不受影响
  * @param disable - 是否禁止

package/dist/utils.d.ts

@@ -1 +1,3 @@
 export declare function isDowngradeIOS(): boolean;
+export declare function throwError(destroyedErrorMessage: string): void;
+export declare function throwErrorPromise(destroyedErrorMessage: string): Promise<never>;