@galacean/engine-core 0.0.0-experimental-0.9-plus.7 → 0.0.0-experimental-ktx2.0

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);
-    request: <U>(url: string, config: RequestConfig) => AssetPromise<U>;
+    initialize?(engine: Engine, configuration: EngineConfiguration): Promise<void>;
     abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T> | Record<string, AssetPromise<any>>;
+    request: <U>(url: string, config: RequestConfig) => AssetPromise<U>;
 }

package/types/asset/ResourceManager.d.ts

@@ -1,4 +1,4 @@
-import { Engine } from "..";
+import { ContentRestorer, Engine, EngineObject } from "..";
 import { AssetPromise } from "./AssetPromise";
 import { Loader } from "./Loader";
 import { LoadItem } from "./LoadItem";
@@ -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. */
@@ -17,14 +15,17 @@ export declare class ResourceManager {
     retryInterval: number;
     /** The default timeout period for loading assets, in milliseconds. */
     timeout: number;
-    /** Asset path pool, key is asset ID, value is asset path */
+    private _loadingPromises;
+    /** Asset path pool, key is the `instanceID` of resource, value is asset path. */
     private _assetPool;
-    /** Asset pool, the key is the asset path and the value is the asset. */
+    /** Asset url pool, key is the asset path and the value is the asset. */
     private _assetUrlPool;
-    /** Reference counted object pool, key is the object ID, and reference counted objects are put into this pool. */
-    private _refObjectPool;
-    /** Loading promises. */
-    private _loadingPromises;
+    /** Referable resource pool, key is the `instanceID` of resource. */
+    private _referResourcePool;
+    /** Graphic resource pool, key is the `instanceID` of resource. */
+    private _graphicResourcePool;
+    /** Restorable resource information pool, key is the `instanceID` of resource. */
+    private _contentRestorerPool;
     /**
      * Create a ResourceManager.
      * @param engine - Engine to which the current ResourceManager belongs
@@ -60,6 +61,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
@@ -85,6 +92,11 @@ export declare class ResourceManager {
      * @remarks The release principle is that it is not referenced by the components, including direct and indirect reference.
      */
     gc(): void;
+    /**
+     * Add content restorer.
+     * @param restorer - The restorer
+     */
+    addContentRestorer<T extends EngineObject>(restorer: ContentRestorer<T>): void;
     private _assignDefaultOptions;
     private _loadSingleItem;
     private _gc;
@@ -96,6 +108,6 @@ export declare class ResourceManager {
 /**
  * Declare ResourceLoader's decorator.
  * @param assetType - Type of asset
- * @param extnames - Name of file extension
+ * @param extNames - Name of file extension
  */
-export declare function resourceLoader(assetType: string, extnames: string[], useCache?: boolean): <T extends Loader<any>>(Target: new (useCache: boolean) => T) => void;
+export declare function resourceLoader(assetType: string, extNames: string[], useCache?: boolean): <T extends Loader<any>>(Target: new (useCache: boolean) => T) => void;

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

@@ -105,6 +105,8 @@ export declare enum GLCapabilityType {
     pvrtc = "WEBGL_compressed_texture_pvrtc",
     pvrtc_webkit = "WEBKIT_WEBGL_compressed_texture_pvrtc",
     s3tc = "WEBGL_compressed_texture_s3tc",
-    s3tc_webkit = "WEBKIT_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/EngineObject.d.ts

@@ -21,4 +21,5 @@ export declare abstract class EngineObject {
      * Destroy self.
      */
     destroy(): void;
+    protected _onDestroy(): void;
 }

package/types/base/EventDispatcher.d.ts

@@ -1,11 +1,10 @@
-import { Event } from "./Event";
 /**
  * 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
@@ -44,15 +43,6 @@ export declare class EventDispatcher {
      * @returns This
      */
     once(event: string, fn: Function): EventDispatcher;
-    /**
-     * @deprecated Use `on/once` instead.
-     * Add a listener function with the specified event name.
-     * @param event - Event name
-     * @param fn - Function
-     * @param once - Is it a one-time listener
-     * @returns this
-     */
-    addEventListener(event: string, fn: Function, once?: boolean): EventDispatcher;
     /**
      * Remove the event listener(s) of the specified event name.
      * @param event - Event name
@@ -71,9 +61,6 @@ export declare class EventDispatcher {
      * @param event - Event name, delete all events if not passed
      */
     removeAllEventListeners(event?: string): void;
-    /**
-     * @deprecated Use `dispatch` instead.
-     */
-    trigger(e: Event): void;
+    private _addEventListener;
     private _clearEvent;
 }

package/types/base/Time.d.ts

@@ -1,43 +1,44 @@
 /**
- * Tools for calculating the time per frame.
+ * Provide time related information.
  */
 export declare class Time {
     private static _elapsedTimeProperty;
-    private _clock;
-    private _timeScale;
+    private static _deltaTimeProperty;
+    private _frameCount;
     private _deltaTime;
-    private _startTime;
-    private _lastTickTime;
+    private _actualDeltaTime;
+    private _elapsedTime;
+    private _actualElapsedTime;
+    private _lastSystemTime;
     private _elapsedTimeValue;
+    private _deltaTimeValue;
+    /** Maximum delta time allowed per frame in seconds. */
+    maximumDeltaTime: number;
+    /** The scale of time. */
+    timeScale: number;
     get frameCount(): number;
     /**
-     * Constructor of the Time.
-     */
-    constructor();
-    reset(): void;
-    /**
-     * Current Time
-     */
-    get nowTime(): number;
-    /**
-     * Time between two ticks
+     * The delta time in seconds from the last frame to the current frame.
+     *
+     * @remarks When the frame rate is low or stutter occurs, `deltaTime` will not exceed the value of `maximumDeltaTime` * `timeScale`.
      */
     get deltaTime(): number;
     /**
-     * Scaled delta time.
+     * The amount of elapsed time in seconds since the start of the engine.
      */
-    get timeScale(): number;
-    set timeScale(s: number);
+    get elapsedTime(): number;
     /**
-     * Unscaled delta time.
+     * The actual delta time in seconds from the last frame to the current frame.
+     *
+     * @remarks The actual delta time is not affected by `maximumDeltaTime` and `timeScale`.
      */
-    get unscaledDeltaTime(): number;
+    get actualDeltaTime(): number;
     /**
-     * The elapsed time, after the clock is initialized.
+     * The amount of actual elapsed time in seconds since the start of the engine.
      */
-    get timeSinceStartup(): number;
+    get actualElapsedTime(): number;
     /**
-     * Call every frame, update delta time and other data.
+     * Constructor of the Time.
      */
-    tick(): void;
+    constructor();
 }

package/types/base/index.d.ts

@@ -1,7 +1,5 @@
-export { Event } from "./Event";
 export { EventDispatcher } from "./EventDispatcher";
 export { Logger } from "./Logger";
 export { Time } from "./Time";
-export { Util, ObjectValues } from "./Util";
 export { EngineObject } from "./EngineObject";
 export * from "./Constant";

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
+}

package/types/env-probe/CubeProbe.d.ts

@@ -9,15 +9,8 @@ export declare class CubeProbe extends Probe {
      * The position of the probe can be set, the default is the origin [0,0,0].
      */
     position: Vector3;
-    /**
-     * @override
-     */
-    protected readonly _isCube: boolean;
     private oriViewMatrix;
     private _oriFieldOfView;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
     /**
      * Store original camera parameters.

package/types/env-probe/Probe.d.ts

@@ -46,13 +46,7 @@ export declare abstract class Probe extends Script {
      * @remarks Prevent issue: Feedback Loops Between Textures and the Framebuffer.
      */
     onTextureChange(renderColorTexture: Texture): void;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
-    /**
-     * @override
-     */
     onEndRender(camera: Camera): void;
     protected _reset(): void;
 }

package/types/graphic/Buffer.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { BufferBindFlag } from "./enums/BufferBindFlag";
 import { BufferUsage } from "./enums/BufferUsage";
@@ -6,14 +6,13 @@ import { SetDataOptions } from "./enums/SetDataOptions";
 /**
  * Buffer.
  */
-export declare class Buffer extends RefObject {
-    _glBindTarget: number;
-    _glBufferUsage: number;
-    _nativeBuffer: WebGLBuffer;
-    private _hardwareRenderer;
+export declare class Buffer extends GraphicsResource {
     private _type;
     private _byteLength;
     private _bufferUsage;
+    private _platformBuffer;
+    private _readable;
+    private _data;
     /**
      * Buffer binding flag.
      */
@@ -26,22 +25,36 @@ export declare class Buffer extends RefObject {
      * Buffer usage.
      */
     get bufferUsage(): BufferUsage;
+    /**
+     * If buffer is readable.
+     */
+    get readable(): boolean;
+    /**
+     * Buffer data cache.
+     *
+     * @remarks
+     * Buffer must be readable.
+     * If the data you get is modified, must call `setData()` to update buffer to GPU.
+     */
+    get data(): Uint8Array;
     /**
      * Create Buffer.
      * @param engine - Engine
      * @param type - Buffer binding flag
      * @param byteLength - Byte length
      * @param bufferUsage - Buffer usage
+     * @param readable - If buffer is readable
      */
-    constructor(engine: Engine, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage);
+    constructor(engine: Engine, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, readable?: boolean);
     /**
      * Create Buffer.
      * @param engine - Engine
      * @param type - Buffer binding flag
-     * @param data - Byte
+     * @param data - Buffer data, if `readable` is true, the`data` property will store a copy of this
      * @param bufferUsage - Buffer usage
+     * @param readable - If buffer is readable
      */
-    constructor(engine: Engine, type: BufferBindFlag, data: ArrayBuffer | ArrayBufferView, bufferUsage?: BufferUsage);
+    constructor(engine: Engine, type: BufferBindFlag, data: ArrayBuffer | ArrayBufferView, bufferUsage?: BufferUsage, readable?: boolean);
     /**
      * Bind buffer.
      */
@@ -94,12 +107,8 @@ export declare class Buffer extends RefObject {
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
     /**
-     * @override
-     * Destroy.
-     */
-    _onDestroy(): void;
-    /**
-     * @deprecated
+     * Mark buffer as readable, the `data` property will be not accessible anymore.
      */
-    resize(dataLength: number): void;
+    markAsUnreadable(): void;
+    _rebuild(): void;
 }

package/types/graphic/BufferUtil.d.ts

@@ -4,6 +4,7 @@ export interface ElementInfo {
     size: number;
     type: DataType;
     normalized: boolean;
+    normalizedScaleFactor: number;
 }
 export declare class BufferUtil {
     static _getGLIndexType(indexFormat: IndexFormat): DataType;

package/types/graphic/Mesh.d.ts

@@ -1,14 +1,12 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { RefObject } from "../asset/RefObject";
 import { Engine } from "../Engine";
-import { MeshTopology } from "../graphic/enums/MeshTopology";
-import { IndexBufferBinding } from "../graphic/IndexBufferBinding";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { SubMesh } from "../graphic/SubMesh";
-import { VertexElement } from "../graphic/VertexElement";
+import { MeshTopology } from "../graphic/enums/MeshTopology";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends RefObject {
+export declare abstract class Mesh extends GraphicsResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -55,16 +53,7 @@ export declare abstract class Mesh extends RefObject {
      * Clear all sub-mesh.
      */
     clearSubMesh(): void;
-    /**
-     * @override
-     */
-    _addRefCount(value: number): void;
-    /**
-     * @override
-     * Destroy.
-     */
-    _onDestroy(): void;
-    protected _setVertexElements(elements: VertexElement[]): void;
-    protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
+    _addReferCount(value: number): void;
+    _rebuild(): void;
     private _onBoundsChanged;
 }

package/types/graphic/SubMesh.d.ts

@@ -1,8 +1,9 @@
+import { IPoolElement } from "../RenderPipeline/IPoolElement";
 import { MeshTopology } from "./enums/MeshTopology";
 /**
  * Sub-mesh, mainly contains drawing information.
  */
-export declare class SubMesh {
+export declare class SubMesh implements IPoolElement {
     /** Start drawing offset. */
     start: number;
     /** Drawing count. */
@@ -16,4 +17,5 @@ export declare class SubMesh {
      * @param topology - Drawing topology
      */
     constructor(start?: number, count?: number, topology?: MeshTopology);
+    dispose?(): void;
 }

package/types/graphic/VertexElement.d.ts

@@ -4,16 +4,16 @@ import { VertexElementFormat } from "./enums/VertexElementFormat";
  * Vertex element.
  */
 export declare class VertexElement {
-    _glElementInfo: ElementInfo;
-    private _semantic;
+    _formatMetaInfo: ElementInfo;
+    private _attributeName;
     private _offset;
     private _format;
     private _bindingIndex;
     private _instanceStepRate;
     /**
-     * Vertex semantic.
+     * Vertex attribute.
      */
-    get semantic(): string;
+    get attribute(): string;
     /**
      * Vertex data byte offset.
      */
@@ -34,11 +34,15 @@ export declare class VertexElement {
     get instanceStepRate(): number;
     /**
      * Create vertex element.
-     * @param semantic - Input vertex semantic
+     * @param attribute - Input attribute
      * @param offset - Vertex data byte offset
      * @param format - Vertex data format
      * @param bindingIndex - Vertex buffer binding index
      * @param instanceStepRate - Instance cadence, the number of instances drawn for each vertex in the buffer, non-instance elements must be 0.
      */
-    constructor(semantic: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    constructor(attribute: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    /**
+     * @deprecated use `attributeName` instead
+     */
+    get semantic(): string;
 }

package/types/index.d.ts

@@ -8,26 +8,25 @@ export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
 export { Renderer } from "./Renderer";
-export { dependentComponents } from "./ComponentsDependencies";
+export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
 export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
+export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
 export { Loader } from "./asset/Loader";
+export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
 export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
-export { RefObject } from "./asset/RefObject";
-export { BasicRenderPipeline } from "./RenderPipeline/BasicRenderPipeline";
-export { RenderQueue } from "./RenderPipeline/RenderQueue";
-export { RenderPass } from "./RenderPipeline/RenderPass";
-export { MeshRenderElement } from "./RenderPipeline/MeshRenderElement";
-export { SpriteElement } from "./RenderPipeline/SpriteElement";
+export { ReferResource } from "./asset/ReferResource";
+export * from "./RenderPipeline/index";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";
+export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
 export { ColorSpace } from "./enums/ColorSpace";
@@ -51,3 +50,6 @@ export * from "./Layer";
 export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
+export * from "./Utils";
+export { Basic2DBatcher } from "./RenderPipeline/Basic2DBatcher";
+export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";

package/types/input/InputManager.d.ts

@@ -1,14 +1,14 @@
+import { Vector3 } from "@galacean/engine-math";
 import { Keys } from "./enums/Keys";
-import { Pointer } from "./pointer/Pointer";
 import { PointerButton } from "./enums/PointerButton";
-import { Vector3 } from "@galacean/engine-math";
+import { Pointer } from "./pointer/Pointer";
 /**
  * InputManager manages device input such as mouse, touch, keyboard, etc.
  */
 export declare class InputManager {
+    private _engine;
     /** Sometimes the input module will not be initialized, such as off-screen rendering. */
     private _initialized;
-    private _curFrameCount;
     private _wheelManager;
     private _pointerManager;
     private _keyboardManager;

package/types/input/interface/IInput.d.ts

@@ -2,7 +2,7 @@ export interface IInput {
     /**
      * Handler function updated every frame.
      */
-    _update(frameCount?: number): void;
+    _update(): void;
     /**
      * Function called when the engine is destroyed.
      */

package/types/lighting/AmbientLight.d.ts

@@ -1,10 +1,12 @@
 import { Color, SphericalHarmonics3 } from "@galacean/engine-math";
 import { TextureCube } from "../texture";
 import { DiffuseMode } from "./enums/DiffuseMode";
+import { ReferResource } from "../asset/ReferResource";
+import { Engine } from "../Engine";
 /**
  * Ambient light.
  */
-export declare class AmbientLight {
+export declare class AmbientLight extends ReferResource {
     private static _shMacro;
     private static _specularMacro;
     private static _decodeRGBMMacro;
@@ -60,6 +62,7 @@ export declare class AmbientLight {
      */
     get specularIntensity(): number;
     set specularIntensity(value: number);
+    constructor(engine: Engine);
     private _setDiffuseMode;
     private _setSpecularTexture;
     private _setSpecularTextureDecodeRGBM;

package/types/lighting/DirectLight.d.ts

@@ -8,7 +8,6 @@ export declare class DirectLight extends Light {
     private static _colorProperty;
     private static _directionProperty;
     private static _combinedData;
-    private _forward;
     private _reverseDirection;
     /**
      * Get direction.

package/types/lighting/Light.d.ts

@@ -44,5 +44,4 @@ export declare abstract class Light extends Component {
      * Inverse view matrix.
      */
     get inverseViewMatrix(): Matrix;
-    protected _getLightColor(): Color;
 }

package/types/lighting/LightManager.d.ts

@@ -2,4 +2,5 @@
  * Light manager.
  */
 export declare class LightManager {
+    private _getSunLightIndex;
 }

package/types/lighting/SpotLight.d.ts

@@ -18,7 +18,6 @@ export declare class SpotLight extends Light {
     angle: number;
     /** Angle, in radians, from falloff begins to ends. */
     penumbra: number;
-    private _forward;
     private _inverseDirection;
     private _projectMatrix;
     /**