@galacean/engine-core 1.1.0-alpha.0 → 1.1.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.1.0-alpha.0",
+  "version": "1.1.0-alpha.2",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.1.0-alpha.0"
+    "@galacean/engine-math": "1.1.0-alpha.2"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.1.0-alpha.0"
+    "@galacean/engine-design": "1.1.0-alpha.2"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/sprite/Sprite.d.ts

@@ -100,4 +100,7 @@ export declare class Sprite extends ReferResource {
     private _updatePositions;
     private _updateUVs;
     private _dispatchSpriteChange;
+    private _onRegionChange;
+    private _onPivotChange;
+    private _onBorderChange;
 }

package/types/Camera.d.ts

@@ -1,7 +1,8 @@
-import { Matrix, Ray, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { Matrix, Ray, Rect, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { Layer } from "./Layer";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
+import { DepthTextureMode } from "./enums/DepthTextureMode";
 import { Shader } from "./shader/Shader";
 import { ShaderData } from "./shader/ShaderData";
 import { ShaderTagKey } from "./shader/ShaderTagKey";
@@ -12,8 +13,9 @@ import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 export declare class Camera extends Component {
-    /** Shader data. */
-    readonly shaderData: ShaderData;
+    private static _inverseViewMatrixProperty;
+    private static _cameraPositionProperty;
+    private static _cameraDepthBufferParamsProperty;
     /** Whether to enable frustum culling, it is enabled by default. */
     enableFrustumCulling: boolean;
     /**
@@ -26,7 +28,13 @@ export declare class Camera extends Component {
      * @remarks Support bit manipulation, corresponding to `Layer`.
      */
     cullingMask: Layer;
+    /**
+     * Depth texture mode.
+     * @defaultValue `DepthTextureMode.None`
+     */
+    depthTextureMode: DepthTextureMode;
     private _priority;
+    private _shaderData;
     private _isProjMatSetting;
     private _nearClipPlane;
     private _farClipPlane;
@@ -37,14 +45,20 @@ export declare class Camera extends Component {
     private _isFrustumProjectDirty;
     private _customAspectRatio;
     private _renderTarget;
+    private _depthBufferParams;
     private _frustumViewChangeFlag;
     private _transform;
     private _isViewMatrixDirty;
     private _isInvViewProjDirty;
     private _viewport;
+    private _pixelViewport;
     private _inverseProjectionMatrix;
     private _lastAspectSize;
     private _invViewProjMat;
+    /**
+     * Shader data.
+     */
+    get shaderData(): ShaderData;
     /**
      * Near clip plane - the closest point to the camera when rendering occurs.
      */
@@ -67,11 +81,17 @@ export declare class Camera extends Component {
     get aspectRatio(): number;
     set aspectRatio(value: number);
     /**
-     * Viewport, normalized expression, the upper left corner is (0, 0), and the lower right corner is (1, 1).
+     * The viewport of the camera in normalized coordinates on the screen.
+     * In normalized screen coordinates, the upper-left corner is (0, 0), and the lower-right corner is (1.0, 1.0).
      * @remarks Re-assignment is required after modification to ensure that the modification takes effect.
      */
     get viewport(): Vector4;
     set viewport(value: Vector4);
+    /**
+     * The viewport of the camera in pixel coordinates on the screen.
+     * In pixel screen coordinates, the upper-left corner is (0, 0), and the lower-right corner is (1.0, 1.0).
+     */
+    get pixelViewport(): Rect;
     /**
      * Rendering priority, higher priority will be rendered on top of a camera with lower priority.
      */
@@ -215,6 +235,7 @@ export declare class Camera extends Component {
      * @inheritdoc
      */
     _onDisableInScene(): void;
+    private _updatePixelViewport;
     private _projMatChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;

package/types/DisorderedArray.d.ts

@@ -7,11 +7,12 @@ export declare class DisorderedArray<T> {
     constructor(count?: number);
     add(element: T): void;
     delete(element: T): void;
+    set(index: number, element: T): void;
     get(index: number): T;
     /**
-     *
-     * @param index
-     * @returns The replaced item is used to reset its index.
+     * Delete the element at the specified index.
+     * @param index - The index of the element to be deleted
+     * @returns The replaced item is used to reset its index
      */
     deleteByIndex(index: number): T;
     garbageCollection(): void;

package/types/Engine.d.ts

@@ -1,4 +1,4 @@
-import { IPhysics } from "@galacean/engine-design";
+import { IPhysics, IShaderLab } from "@galacean/engine-design";
 import { Canvas } from "./Canvas";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
@@ -30,6 +30,7 @@ export declare class Engine extends EventDispatcher {
     private _frameInProcess;
     private _waitingDestroy;
     private _isDeviceLost;
+    private _waitingGC;
     private _animate;
     /**
      * Settings of Engine.
@@ -116,6 +117,7 @@ export declare class Engine extends EventDispatcher {
     private _createSpriteMaskMaterial;
     private _onDeviceLost;
     private _onDeviceRestored;
+    private _gc;
     /**
      * @deprecated
      * The first scene physics manager.
@@ -130,4 +132,6 @@ export interface EngineConfiguration {
     physics?: IPhysics;
     /** Color space. */
     colorSpace?: ColorSpace;
+    /** Shader lab */
+    shaderLab?: IShaderLab;
 }

package/types/Entity.d.ts

@@ -65,7 +65,7 @@ export declare class Entity extends EngineObject {
      * @param type - The type of the component
      * @returns	The first component which match type
      */
-    getComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;
     /**
      * Get components which match the type.
      * @param type - The type of the component
@@ -130,6 +130,8 @@ export declare class Entity extends EngineObject {
      * @returns Cloned entity
      */
     clone(): Entity;
+    private _createCloneEntity;
+    private _parseCloneEntity;
     /**
      * Destroy self.
      */

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -9,13 +9,12 @@ import { RenderPass } from "./RenderPass";
  * Basic render pipeline.
  */
 export declare class BasicRenderPipeline {
-    private static _shadowCasterPipelineStageTagValue;
-    private static _forwardPipelineStageTagValue;
     private _camera;
     private _defaultPass;
     private _renderPassArray;
     private _lastCanvasSize;
     private _cascadedShadowCaster;
+    private _depthOnlyPass;
     /**
      * Create a basic render pipeline.
      * @param camera - Camera

package/types/RenderPipeline/ClassPool.d.ts

@@ -1,7 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 /**
  * Class pool utils.
  */
-export declare class ClassPool<T> {
+export declare class ClassPool<T extends IPoolElement> {
     private _elementPoolIndex;
     private _elementPool;
     private _type;
@@ -14,4 +15,5 @@ export declare class ClassPool<T> {
      * Reset pool.
      */
     resetPool(): void;
+    garbageCollection(): void;
 }

package/types/RenderPipeline/CullingResults.d.ts

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

package/types/RenderPipeline/DepthOnlyPass.d.ts

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

package/types/RenderPipeline/IPoolElement.d.ts

@@ -0,0 +1,3 @@
+export interface IPoolElement {
+    dispose?(): void;
+}

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -2,14 +2,16 @@ import { Mesh } from "../graphic/Mesh";
 import { SubMesh } from "../graphic/SubMesh";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
 /**
  * Render element.
  */
-export declare class MeshRenderData extends RenderData {
+export declare class MeshRenderData extends RenderData implements IPoolElement {
     /** Mesh. */
     mesh: Mesh;
     /** Sub mesh. */
     subMesh: SubMesh;
     set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
+    dispose(): void;
 }

package/types/RenderPipeline/PipelinePass.d.ts

@@ -0,0 +1,16 @@
+import { Engine } from "../Engine";
+import { CullingResults } from "../RenderPipeline/CullingResults";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+/**
+ * PipelinePass is a base class for all pipeline passes.
+ */
+export declare abstract class PipelinePass {
+    protected _engine: Engine;
+    constructor(engine: Engine);
+    /**
+     * Called before rendering a camera, override this method to configure the camera If you need to configure the camera clear flag or render target.
+     * @param context - Rendering context
+     * @param cullingResults - Culling results
+     */
+    abstract onRender(context: RenderContext, cullingResults: CullingResults): void;
+}

package/types/RenderPipeline/PipelineUtils.d.ts

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

package/types/RenderPipeline/RenderElement.d.ts

@@ -1,9 +1,9 @@
 import { ShaderPass } from "../shader/ShaderPass";
-import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
-export declare class RenderElement {
+export declare class RenderElement implements IPoolElement {
     data: RenderData;
-    shaderPass: ShaderPass;
-    renderState: RenderState;
-    set(data: RenderData, shaderPass: ShaderPass, renderState: RenderState): void;
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    set(data: RenderData, shaderPasses: ReadonlyArray<ShaderPass>): void;
+    dispose(): void;
 }

package/types/RenderPipeline/RenderElementX.d.ts

@@ -0,0 +1,12 @@
+import { Renderer } from "../Renderer";
+import { Primitive } from "../graphic/Primitive";
+import { Material } from "../material/Material";
+import { ShaderPass } from "../shader/ShaderPass";
+import { IPoolElement } from "./IPoolElement";
+export declare class RenderElementX implements IPoolElement {
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    component: Renderer;
+    material: Material;
+    primitive: Primitive;
+    dispose(): void;
+}

package/types/RenderPipeline/RenderQueue.d.ts

@@ -13,7 +13,7 @@ export declare class RenderQueue {
      * Push a render element.
      */
     pushRenderElement(element: RenderElement): void;
-    render(camera: Camera, mask: Layer): void;
+    render(camera: Camera, mask: Layer, pipelineStageTagValue: string): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/SpriteMaskRenderData.d.ts

@@ -1,10 +1,12 @@
 import { VertexData2D } from "../2d/data/VertexData2D";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
-export declare class SpriteMaskRenderData extends RenderData {
+export declare class SpriteMaskRenderData extends RenderData implements IPoolElement {
     isAdd: boolean;
     verticesData: VertexData2D;
     constructor();
     set(component: Renderer, material: Material, verticesData: VertexData2D): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteRenderData.d.ts

@@ -2,11 +2,13 @@ import { VertexData2D } from "../2d/data/VertexData2D";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
 import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
-export declare class SpriteRenderData extends RenderData {
+export declare class SpriteRenderData extends RenderData implements IPoolElement {
     verticesData: VertexData2D;
     texture: Texture2D;
     dataIndex: number;
     constructor();
     set(component: Renderer, material: Material, verticesData: VertexData2D, texture: Texture2D, dataIndex?: number): void;
+    dispose(): void;
 }

package/types/RenderPipeline/TextRenderData.d.ts

@@ -1,6 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 import { RenderData } from "./RenderData";
 import { SpriteRenderData } from "./SpriteRenderData";
-export declare class TextRenderData extends RenderData {
+export declare class TextRenderData extends RenderData implements IPoolElement {
     charsData: SpriteRenderData[];
     constructor();
+    dispose(): void;
 }

package/types/RenderPipeline/enums/PipelineStage.d.ts

@@ -2,6 +2,8 @@
  * Pipeline stage.
  */
 export declare enum PipelineStage {
+    /** DepthOnly stage. */
+    DepthOnly = "DepthOnly",
     /** Shadow caster stage. */
     ShadowCaster = "ShadowCaster",
     /** Forward shading stage. */

package/types/Renderer.d.ts

@@ -17,12 +17,11 @@ export declare class Renderer extends Component implements ICustomClone {
     private static _mvInvMatrixProperty;
     private static _normalMatrixProperty;
     private static _rendererLayerProperty;
-    /** ShaderData related to renderer. */
-    readonly shaderData: ShaderData;
     _renderFrameCount: number;
     protected _overrideUpdate: boolean;
     protected _materials: Material[];
     protected _dirtyUpdateFlag: number;
+    private _shaderData;
     private _mvMatrix;
     private _mvpMatrix;
     private _mvInvMatrix;
@@ -31,6 +30,10 @@ export declare class Renderer extends Component implements ICustomClone {
     private _priority;
     private _receiveShadows;
     protected _rendererLayer: Vector4;
+    /**
+     * ShaderData related to renderer.
+     */
+    get shaderData(): ShaderData;
     /**
      * Whether it is culled in the current frame and does not participate in rendering.
      */

package/types/Scene.d.ts

@@ -21,10 +21,6 @@ export declare class Scene extends EngineObject {
     name: string;
     /** Physics. */
     readonly physics: PhysicsScene;
-    /** The background of the scene. */
-    readonly background: Background;
-    /** Scene-related shader data. */
-    readonly shaderData: ShaderData;
     /** If cast shadows. */
     castShadows: boolean;
     /** The resolution of the shadow maps. */
@@ -35,6 +31,8 @@ export declare class Scene extends EngineObject {
     shadowFourCascadeSplits: Vector3;
     /** Max Shadow distance. */
     shadowDistance: number;
+    private _background;
+    private _shaderData;
     private _shadowCascades;
     private _ambientLight;
     private _fogMode;
@@ -43,6 +41,14 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    /**
+     * Scene-related shader data.
+     */
+    get shaderData(): ShaderData;
+    /**
+     * The background of the scene.
+     */
+    get background(): Background;
     /**
      *  Number of cascades to use for directional light shadows.
      */

package/types/Ticker.d.ts

@@ -0,0 +1,30 @@
+export declare class Ticker {
+    private _vSyncCount;
+    private _vSyncCounter;
+    private _requestId;
+    private _animationLoop;
+    private _requestAnimationFrame;
+    private _cancelAnimationFrame;
+    /**
+     * The number of vertical synchronization means the number of vertical blanking for one frame.
+     * @remarks 0 means that the vertical synchronization is turned off.
+     */
+    get vSyncCount(): number;
+    set vSyncCount(value: number);
+    get requestAnimationFrame(): (...params: any[]) => any;
+    set requestAnimationFrame(func: (...params: any[]) => any);
+    get cancelAnimationFrame(): (...params: any[]) => any;
+    set cancelAnimationFrame(func: (...params: any[]) => any);
+    get animationLoop(): (...params: any[]) => any;
+    set animationLoop(func: (...params: any[]) => any);
+    /**
+     * Pause the engine.
+     */
+    pause(): void;
+    /**
+     * Resume the engine.
+     */
+    resume(): void;
+    private _onAnimationFrame;
+    constructor();
+}

package/types/Transform.d.ts

@@ -195,6 +195,7 @@ export declare class Transform extends Component {
      * @returns Change flag
      */
     registerWorldChangeFlag(): BoolUpdateFlag;
+    protected _onDestroy(): void;
     /**
      * Get worldMatrix: Will trigger the worldMatrix update of itself and all parent entities.
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.

package/types/animation/Animator.d.ts

@@ -13,6 +13,7 @@ export declare class Animator extends Component {
     speed: number;
     protected _animatorController: AnimatorController;
     protected _controllerUpdateFlag: BoolUpdateFlag;
+    protected _updateMark: number;
     private _animatorLayersData;
     private _curveOwnerPool;
     private _animationEventHandlerPool;
@@ -55,7 +56,6 @@ export declare class Animator extends Component {
      */
     findAnimatorState(stateName: string, layerIndex?: number): AnimatorState;
     private _getAnimatorStateInfo;
-    private _saveDefaultValues;
     private _getAnimatorStateData;
     private _saveAnimatorStateData;
     private _saveAnimatorEventHandlers;
@@ -71,6 +71,7 @@ export declare class Animator extends Component {
     private _updatePlayingState;
     private _updateCrossFade;
     private _updateCrossFadeFromPose;
+    private _updateFinishedState;
     private _updateCrossFadeData;
     private _preparePlay;
     private _checkTransition;
@@ -82,4 +83,5 @@ export declare class Animator extends Component {
     private _callAnimatorScriptOnUpdate;
     private _callAnimatorScriptOnExit;
     private _checkAutoPlay;
+    private _checkRevertOwner;
 }

package/types/animation/enums/LayerState.d.ts

@@ -9,5 +9,7 @@ export declare enum LayerState {
     /** CrossFading state. */
     CrossFading = 2,
     /** FixedCrossFading state. */
-    FixedCrossFading = 3
+    FixedCrossFading = 3,
+    /** Finished state. */
+    Finished = 4
 }

package/types/asset/AssetType.d.ts

@@ -35,6 +35,8 @@ export declare enum AssetType {
     KTX = "KTX",
     /** Cube Compress Texture. */
     KTXCube = "KTXCube",
+    /** KTX2 Compress Texture */
+    KTX2 = "KTX2",
     /** Sprite. */
     Sprite = "Sprite",
     /** Sprite Atlas. */

package/types/asset/LoadItem.d.ts

@@ -1,15 +1,12 @@
+type PickOnlyOne<T extends {}, Keys extends keyof T = keyof T> = Keys extends unknown ? {
+    [K in Keys]: T[Keys];
+} & {
+    [K in Exclude<keyof T, Keys>]?: never;
+} : never;
 /**
  * Used to describe loading asset.
  */
 export type LoadItem = {
-    /**
-     * Loading url.
-     */
-    url?: string;
-    /**
-     * Available when AssetType is TextureCube.
-     */
-    urls?: string[];
     /**
      * Asset Type.
      */
@@ -30,4 +27,14 @@ export type LoadItem = {
      * Additional parameters for specified loader.
      */
     params?: Record<string, any>;
-};
+} & PickOnlyOne<{
+    /**
+     * Loading url.
+     */
+    url: string;
+    /**
+     * Available when AssetType is TextureCube.
+     */
+    urls: string[];
+}>;
+export {};

package/types/asset/Loader.d.ts

@@ -1,3 +1,4 @@
+import { Engine, EngineConfiguration } from "../Engine";
 import { AssetPromise } from "./AssetPromise";
 import { LoadItem } from "./LoadItem";
 import { RequestConfig } from "./request";
@@ -25,6 +26,7 @@ export declare abstract class Loader<T> {
     };
     private static _engineObjects;
     constructor(useCache: boolean);
+    initialize?(engine: Engine, configuration: EngineConfiguration): Promise<void>;
+    abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T>;
     request: <U>(url: string, config: RequestConfig) => AssetPromise<U>;
-    abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T> | Record<string, AssetPromise<any>>;
 }

package/types/asset/ResourceManager.d.ts

@@ -7,8 +7,6 @@ import { LoadItem } from "./LoadItem";
  */
 export declare class ResourceManager {
     readonly engine: Engine;
-    /** Loader collection. */
-    private static _loaders;
     private static _extTypeMapping;
     private static _getTypeByUrl;
     /** The number of retries after failing to load assets. */
@@ -28,6 +26,7 @@ export declare class ResourceManager {
     private _graphicResourcePool;
     /** Restorable resource information pool, key is the `instanceID` of resource. */
     private _contentRestorerPool;
+    private _subAssetPromiseCallbacks;
     /**
      * Create a ResourceManager.
      * @param engine - Engine to which the current ResourceManager belongs
@@ -63,6 +62,12 @@ export declare class ResourceManager {
      * @returns Resource object
      */
     getFromCache<T>(url: string): T;
+    /**
+     * Find the resource by type.
+     * @param type - Resource type
+     * @returns - Resource collection
+     */
+    findResourcesByType<T extends EngineObject>(type: new (...args: any[]) => T): T[];
     /**
      * Get asset url from instanceId.
      * @param instanceId - Engine instance id
@@ -95,6 +100,7 @@ export declare class ResourceManager {
     addContentRestorer<T extends EngineObject>(restorer: ContentRestorer<T>): void;
     private _assignDefaultOptions;
     private _loadSingleItem;
+    private _pushSubAssetPromiseCallback;
     private _gc;
     private _getResolveResource;
     private _parseURL;

package/types/asset/request.d.ts

@@ -17,9 +17,13 @@ export declare class MultiExecutor {
     private interval;
     private _timeoutId;
     private _currentCount;
+    private _onComplete;
+    private _onError;
+    private _error;
     constructor(execFunc: (count?: number) => Promise<any>, totalCount: number, interval: number);
-    private done;
-    start(done?: Function): void;
-    stop(): void;
+    start(): this;
+    onComplete(func: Function): this;
+    onError(func: Function): this;
+    cancel(): void;
     private exec;
 }

package/types/base/Constant.d.ts

@@ -106,6 +106,7 @@ export declare enum GLCapabilityType {
     pvrtc_webkit = "WEBKIT_WEBGL_compressed_texture_pvrtc",
     s3tc = "WEBGL_compressed_texture_s3tc",
     s3tc_webkit = "WEBKIT_WEBGL_compressed_texture_s3tc",
+    bptc = "EXT_texture_compression_bptc",
     WEBGL_lose_context = "WEBGL_lose_context"
 }
 export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;

package/types/base/EventDispatcher.d.ts

@@ -2,9 +2,9 @@
  * EventDispatcher, which can be inherited as a base class.
  */
 export declare class EventDispatcher {
+    private static _dispatchingListenersPool;
     private _events;
     private _eventCount;
-    private _dispatchingListeners;
     /**
      * Determine whether there is event listening.
      * @param event - Event name

package/types/clone/ComponentCloner.d.ts

@@ -1,4 +1,5 @@
 import { Component } from "../Component";
+import { Entity } from "../Entity";
 /**
  * Custom clone interface.
  */
@@ -10,5 +11,5 @@ export declare class ComponentCloner {
      * @param source - Clone source
      * @param target - Clone target
      */
-    static cloneComponent(source: Component, target: Component): void;
+    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity): void;
 }

package/types/enums/DepthTextureMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Depth texture mode.
+ */
+export declare enum DepthTextureMode {
+    None = 0,
+    PrePass = 1
+}