@galacean/engine-core 1.2.0-alpha.1 → 1.2.0-alpha.11

package/package.json

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

package/types/Camera.d.ts

@@ -37,18 +37,18 @@ export declare class Camera extends Component {
     depthTextureMode: DepthTextureMode;
     private _priority;
     private _shaderData;
-    private _isProjMatSetting;
+    private _isCustomViewMatrix;
+    private _isCustomProjectionMatrix;
     private _nearClipPlane;
     private _farClipPlane;
     private _fieldOfView;
     private _orthographicSize;
     private _isProjectionDirty;
     private _isInvProjMatDirty;
-    private _isFrustumProjectDirty;
     private _customAspectRatio;
     private _renderTarget;
     private _depthBufferParams;
-    private _frustumViewChangeFlag;
+    private _frustumChangeFlag;
     private _transform;
     private _isViewMatrixDirty;
     private _isInvViewProjDirty;
@@ -112,12 +112,13 @@ export declare class Camera extends Component {
      * View matrix.
      */
     get viewMatrix(): Readonly<Matrix>;
+    set viewMatrix(value: Matrix);
     /**
      * The projection matrix is ​​calculated by the relevant parameters of the camera by default.
      * If it is manually set, the manual value will be maintained. Call resetProjectionMatrix() to restore it.
      */
+    get projectionMatrix(): Readonly<Matrix>;
     set projectionMatrix(value: Matrix);
-    get projectionMatrix(): Matrix;
     /**
      * Whether to enable HDR.
      * @todo When render pipeline modification
@@ -129,6 +130,10 @@ export declare class Camera extends Component {
      */
     get renderTarget(): RenderTarget | null;
     set renderTarget(value: RenderTarget | null);
+    /**
+     * Restore the view matrix to the world matrix of the entity.
+     */
+    resetViewMatrix(): void;
     /**
      * Restore the automatic calculation of projection matrix through fieldOfView, nearClipPlane and farClipPlane.
      */
@@ -237,7 +242,8 @@ export declare class Camera extends Component {
      */
     _onDisableInScene(): void;
     private _updatePixelViewport;
-    private _projMatChange;
+    private _viewMatrixChange;
+    private _projectionMatrixChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;
     /**

package/types/Canvas.d.ts

@@ -14,5 +14,6 @@ export declare abstract class Canvas {
      */
     get height(): number;
     set height(value: number);
-    protected abstract _onSizeChanged(width: number, height: number): void;
+    protected abstract _onWidthChanged(value: number): void;
+    protected abstract _onHeightChange(value: number): void;
 }

package/types/Engine.d.ts

@@ -1,4 +1,4 @@
-import { IHardwareRenderer, IPhysics, IShaderLab, IXRDevice } from "@galacean/engine-design";
+import { IHardwareRenderer, IInputOptions, IPhysics, IShaderLab, IXRDevice } from "@galacean/engine-design";
 import { Canvas } from "./Canvas";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
@@ -136,6 +136,8 @@ export interface EngineConfiguration {
     xrDevice?: IXRDevice;
     /** Color space. */
     colorSpace?: ColorSpace;
-    /** Shader lab */
+    /** Shader lab. */
     shaderLab?: IShaderLab;
+    /** Input options. */
+    input?: IInputOptions;
 }

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -0,0 +1,19 @@
+import { Mesh } from "../graphic/Mesh";
+import { SubMesh } from "../graphic/SubMesh";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { ShaderPass } from "../shader/ShaderPass";
+import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+/**
+ * Render element.
+ */
+export declare class MeshRenderElement extends RenderElement implements IPoolElement {
+    /** Mesh. */
+    mesh: Mesh;
+    /** Sub mesh. */
+    subMesh: SubMesh;
+    setValue(component: Renderer, mesh: Mesh, subMesh: SubMesh, material: Material, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteElement.d.ts

@@ -0,0 +1,15 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { ShaderPass } from "../shader";
+import { RenderState } from "../shader/state/RenderState";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+export declare class SpriteElement extends RenderElement implements IPoolElement {
+    renderData: RenderData2D;
+    texture: Texture2D;
+    constructor();
+    setValue(component: Renderer, renderDate: RenderData2D, material: Material, texture: Texture2D, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteMaskElement.d.ts

@@ -0,0 +1,12 @@
+import { RenderData2D } from "../2d/data/RenderData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+export declare class SpriteMaskElement extends RenderElement implements IPoolElement {
+    renderData: RenderData2D;
+    isAdd: boolean;
+    constructor();
+    setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderElement.d.ts

@@ -0,0 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
+import { RenderElement } from "./RenderElement";
+import { SpriteElement } from "./SpriteElement";
+export declare class TextRenderElement extends RenderElement implements IPoolElement {
+    charElements: SpriteElement[];
+    constructor();
+    dispose(): void;
+}

package/types/Scene.d.ts

@@ -30,6 +30,11 @@ export declare class Scene extends EngineObject {
     shadowFourCascadeSplits: Vector3;
     /** Max Shadow distance. */
     shadowDistance: number;
+    /**
+     * Last shadow fade distance in percentage, range [0,1].
+     * @remarks Value 0 is used for no shadow fade.
+     */
+    shadowFadeBorder: number;
     private _background;
     private _shaderData;
     private _shadowCascades;

package/types/Utils.d.ts

@@ -15,6 +15,12 @@ export declare class Utils {
      * @returns Whether the url is absolute url.
      */
     static isAbsoluteUrl(url: string): boolean;
+    /**
+     * Judge whether the url is base64 url.
+     * @param url - The url to be judged.
+     * @returns Whether the url is base64 url.
+     */
+    static isBase64Url(url: string): boolean;
     /**
      * Get the values of an object.
      */

package/types/asset/AssetType.d.ts

@@ -39,6 +39,8 @@ export declare enum AssetType {
     KTX2 = "KTX2",
     /** Sprite. */
     Sprite = "Sprite",
+    /** PrimitiveMesh. */
+    PrimitiveMesh = "PrimitiveMesh",
     /** Sprite Atlas. */
     SpriteAtlas = "SpriteAtlas",
     /** Ambient light. */

package/types/asset/IRefObject.d.ts

@@ -0,0 +1,2 @@
+export interface IRefObject {
+}

package/types/asset/Loader.d.ts

@@ -24,7 +24,14 @@ export declare abstract class Loader<T> {
     static getClass(className: string): {
         new (...args: any): any;
     };
+    /**
+     * Get the class name by class object.
+     * @param obj - class object
+     * @returns class name
+     */
+    static getClassName(obj: Object): string;
     private static _engineObjects;
+    private static _classNameMap;
     constructor(useCache: boolean);
     initialize?(engine: Engine, configuration: EngineConfiguration): Promise<void>;
     abstract load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<T>;

package/types/asset/RefObject.d.ts

@@ -0,0 +1,27 @@
+import { EngineObject } from "../base/EngineObject";
+import { Engine } from "../Engine";
+import { IRefObject } from "./IRefObject";
+/**
+ * The base class of assets, with reference counting capability.
+ */
+export declare abstract class RefObject extends EngineObject implements IRefObject {
+    /** Whether to ignore the garbage collection check, if it is true, it will not be affected by ResourceManager.gc(). */
+    isGCIgnored: boolean;
+    private _refCount;
+    /**
+     * Counted by valid references.
+     */
+    get refCount(): number;
+    protected constructor(engine: Engine);
+    /**
+     * Destroy self.
+     * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
+     * @returns Whether the release was successful.
+     */
+    destroy(force?: boolean): boolean;
+    /**
+     * Called when the resource is destroyed.
+     * Subclasses can override this function.
+     */
+    protected abstract _onDestroy(): void;
+}

package/types/asset/ResourceManager.d.ts

@@ -15,6 +15,8 @@ export declare class ResourceManager {
     retryInterval: number;
     /** The default timeout period for loading assets, in milliseconds. */
     timeout: number;
+    /** Base url for loading assets. */
+    baseUrl: string | null;
     private _loadingPromises;
     /** Asset path pool, key is the `instanceID` of resource, value is asset path. */
     private _assetPool;

package/types/base/Event.d.ts

@@ -0,0 +1,24 @@
+import { EventDispatcher } from "./EventDispatcher";
+export type Listener = ((e: Event) => any) & {
+    once?: boolean;
+};
+/** Event Object. * @class */
+export declare class Event {
+    get propagationStopped(): boolean;
+    get target(): EventDispatcher;
+    set target(t: EventDispatcher);
+    get timeStamp(): number;
+    get currentTarget(): EventDispatcher;
+    set currentTarget(t: EventDispatcher);
+    get bubbles(): boolean;
+    get type(): string | number;
+    data: any;
+    private _timeStamp;
+    private _target;
+    private _currentTarget;
+    private _bubbles;
+    private _propagationStopped;
+    private _type;
+    constructor(type: string | number, target?: EventDispatcher, data?: any, bubbles?: boolean);
+    stopPropagation(): void;
+}

package/types/base/Util.d.ts

@@ -0,0 +1,14 @@
+export declare const Util: {
+    isArray: (value: any) => boolean;
+    isArrayLike(x: any): boolean;
+    clone<T>(obj: T): T;
+    downloadBlob(blob: Blob, fileName?: string): void;
+};
+export declare const isArrayLike: <T>(x: any) => x is ArrayLike<T>;
+/**
+ * Fastly remove an element from array.
+ * @param array - Array
+ * @param item - Element
+ */
+export declare function removeFromArray(array: any[], item: any): boolean;
+export declare function ObjectValues(obj: any): any[];

package/types/input/InputManager.d.ts

@@ -62,6 +62,4 @@ export declare class InputManager {
      * @returns Whether the pointer is released during the current frame
      */
     isPointerUp(pointerButton?: PointerButton): boolean;
-    private _onBlur;
-    private _onFocus;
 }

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

@@ -7,12 +7,4 @@ export interface IInput {
      * Function called when the engine is destroyed.
      */
     _destroy(): void;
-    /**
-     * Function called when focused.
-     */
-    _onFocus(): void;
-    /**
-     * Function called when focus is lost.
-     */
-    _onBlur(): void;
 }

package/types/particle/modules/MainModule.d.ts

@@ -1,3 +1,4 @@
+import { Rand } from "@galacean/engine-math";
 import { ICustomClone } from "../../clone/ComponentCloner";
 import { ParticleScaleMode } from "../enums/ParticleScaleMode";
 import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
@@ -54,6 +55,7 @@ export declare class MainModule implements ICustomClone {
     scalingMode: ParticleScaleMode;
     /** If set to true, the Particle Generator automatically begins to play on startup. */
     playOnEnabled: boolean;
+    readonly _gravityModifierRand: Rand;
     private _generator;
     private _gravity;
     /**

package/types/particle/modules/shape/BaseShape.d.ts

@@ -4,9 +4,9 @@ import { ParticleShapeType } from "./enums/ParticleShapeType";
  */
 export declare abstract class BaseShape {
     /** The type of shape to emit particles from. */
-    shapeType: ParticleShapeType;
+    abstract readonly shapeType: ParticleShapeType;
     /** Specifies whether the ShapeModule is enabled or disabled. */
-    enable: boolean;
+    enabled: boolean;
     /** Randomizes the starting direction of particles. */
     randomDirectionAmount: number;
 }

package/types/particle/modules/shape/BoxShape.d.ts

@@ -1,11 +1,12 @@
 import { Vector3 } from "@galacean/engine-math";
 import { BaseShape } from "./BaseShape";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
 /**
  * Particle shape that emits particles from a box.
  */
 export declare class BoxShape extends BaseShape {
     private static _tempVector30;
+    readonly shapeType = ParticleShapeType.Box;
     /** The size of the box. */
     size: Vector3;
-    constructor();
 }

package/types/particle/modules/shape/CircleShape.d.ts

@@ -1,10 +1,12 @@
 import { BaseShape } from "./BaseShape";
 import { ParticleShapeArcMode } from "./enums/ParticleShapeArcMode";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
 /**
  * Particle shape that emits particles from a circle.
  */
 export declare class CircleShape extends BaseShape {
     private static _tempPositionPoint;
+    readonly shapeType = ParticleShapeType.Circle;
     /** Radius of the shape to emit particles from. */
     radius: number;
     /** Angle of the circle arc to emit particles from. */
@@ -13,5 +15,4 @@ export declare class CircleShape extends BaseShape {
     arcMode: ParticleShapeArcMode;
     /** The speed of complete 360 degree rotation. */
     arcSpeed: number;
-    constructor();
 }

package/types/particle/modules/shape/ConeShape.d.ts

@@ -1,4 +1,5 @@
 import { BaseShape } from "./BaseShape";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
 /**
  * Cone shape.
  */
@@ -7,6 +8,7 @@ export declare class ConeShape extends BaseShape {
     private static _tempVector21;
     private static _tempVector30;
     private static _tempVector31;
+    readonly shapeType = ParticleShapeType.Cone;
     /** Angle of the cone to emit particles from. */
     angle: number;
     /** Radius of the shape to emit particles from. */
@@ -15,7 +17,6 @@ export declare class ConeShape extends BaseShape {
     length: number;
     /** Cone emitter type. */
     emitType: ConeEmitType;
-    constructor();
 }
 /**
  * Cone emitter type.

package/types/particle/modules/shape/HemisphereShape.d.ts

@@ -1,9 +1,10 @@
 import { BaseShape } from "./BaseShape";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
 /**
  * Particle shape that emits particles from a hemisphere.
  */
 export declare class HemisphereShape extends BaseShape {
+    readonly shapeType = ParticleShapeType.Hemisphere;
     /** Radius of the shape to emit particles from. */
     radius: number;
-    constructor();
 }

package/types/particle/modules/shape/SphereShape.d.ts

@@ -1,9 +1,10 @@
 import { BaseShape } from "./BaseShape";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
 /**
  * Particle shape that emits particles from a sphere.
  */
 export declare class SphereShape extends BaseShape {
+    readonly shapeType = ParticleShapeType.Sphere;
     /** Radius of the shape to emit particles from. */
     radius: number;
-    constructor();
 }

package/types/particle/modules/shape/index.d.ts

@@ -4,3 +4,4 @@ export { ConeShape, ConeEmitType } from "./ConeShape";
 export { HemisphereShape } from "./HemisphereShape";
 export { SphereShape } from "./SphereShape";
 export { ParticleShapeArcMode } from "./enums/ParticleShapeArcMode";
+export { ParticleShapeType } from "./enums/ParticleShapeType";

package/types/physics/HitResult.d.ts

@@ -1,5 +1,6 @@
 import { Entity } from "../Entity";
 import { Vector3 } from "@galacean/engine-math";
+import { ColliderShape } from "./shape";
 /**
  * Structure used to get information back from a raycast or a sweep.
  */
@@ -12,4 +13,6 @@ export declare class HitResult {
     point: Vector3;
     /** The normal of the surface the ray hit. */
     normal: Vector3;
+    /** The shape of the collider that was hit. */
+    shape: ColliderShape;
 }

package/types/shaderlib/ShaderFactory.d.ts

@@ -1,7 +1,12 @@
 export declare class ShaderFactory {
     static parseCustomMacros(macros: string[]): string;
     static registerInclude(includeName: string, includeSource: string): void;
-    static parseIncludes(src: string): string;
+    static unRegisterInclude(includeName: string): void;
+    /**
+     * @param regex The default regex is for engine's builtin glsl `#include` syntax,
+     * since `ShaderLab` use the same parsing function but different syntax for `#include` --- `/^[ \t]*#include +"([\w\d.]+)"/gm`
+     */
+    static parseIncludes(src: string, regex?: RegExp): string;
     /**
      * Convert lower GLSL version to GLSL 300 es.
      * @param shader - code

package/types/shadow/CascadedShadowCasterPass.d.ts

@@ -28,7 +28,6 @@ export declare class CascadedShadowCasterPass extends PipelinePass {
     private _shadowSliceData;
     private _lightUp;
     private _lightSide;
-    private _existShadowMap;
     private _splitBoundSpheres;
     /** The end is project precision problem in shader. */
     private _shadowMatrices;

package/types/texture/Texture.d.ts

@@ -76,4 +76,5 @@ export declare abstract class Texture extends GraphicsResource {
      */
     protected _getMaxMiplevel(size: number): number;
     protected _getMipmapCount(): number;
+    protected _isIntFormat(): boolean;
 }

package/types/texture/enums/TextureFormat.d.ts

@@ -20,56 +20,58 @@ export declare enum TextureFormat {
     R16G16B16A16 = 7,
     /** RGBA format, 32 bits per channel. */
     R32G32B32A32 = 8,
+    /** RGBA unsigned integer format, 32 bits per channel. */
+    R32G32B32A32_UInt = 9,
     /** RGB compressed format, 4 bits per pixel. */
-    BC1 = 9,
+    BC1 = 10,
     /** RGBA compressed format, 8 bits per pixel. */
-    BC3 = 10,
+    BC3 = 11,
     /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
-    BC7 = 11,
+    BC7 = 12,
     /** RGB compressed format, 4 bits per pixel. */
-    ETC1_RGB = 12,
+    ETC1_RGB = 13,
     /** RGB compressed format, 4 bits per pixel. */
-    ETC2_RGB = 13,
+    ETC2_RGB = 14,
     /** RGBA compressed format, 5 bits per pixel, 4 bit in RGB, 1 bit in A. */
-    ETC2_RGBA5 = 14,
+    ETC2_RGBA5 = 15,
     /** RGB compressed format, 8 bits per pixel. */
-    ETC2_RGBA8 = 15,
+    ETC2_RGBA8 = 16,
     /** RGB compressed format, 2 bits per pixel. */
-    PVRTC_RGB2 = 16,
+    PVRTC_RGB2 = 17,
     /** RGBA compressed format, 2 bits per pixel. */
-    PVRTC_RGBA2 = 17,
+    PVRTC_RGBA2 = 18,
     /** RGB compressed format, 4 bits per pixel. */
-    PVRTC_RGB4 = 18,
+    PVRTC_RGB4 = 19,
     /** RGBA compressed format, 4 bits per pixel. */
-    PVRTC_RGBA4 = 19,
+    PVRTC_RGBA4 = 20,
     /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
-    ASTC_4x4 = 20,
+    ASTC_4x4 = 21,
     /** RGB(A) compressed format, 128 bits per 5x5 pixel block. */
-    ASTC_5x5 = 21,
+    ASTC_5x5 = 22,
     /** RGB(A) compressed format, 128 bits per 6x6 pixel block. */
-    ASTC_6x6 = 22,
+    ASTC_6x6 = 23,
     /** RGB(A) compressed format, 128 bits per 8x8 pixel block. */
-    ASTC_8x8 = 23,
+    ASTC_8x8 = 24,
     /** RGB(A) compressed format, 128 bits per 10x10 pixel block. */
-    ASTC_10x10 = 24,
+    ASTC_10x10 = 25,
     /** RGB(A) compressed format, 128 bits per 12x12 pixel block. */
-    ASTC_12x12 = 25,
+    ASTC_12x12 = 26,
     /** Automatic depth format, engine will automatically select the supported precision. */
-    Depth = 26,
+    Depth = 27,
     /** Automatic depth stencil format, engine will automatically select the supported precision. */
-    DepthStencil = 27,
+    DepthStencil = 28,
     /** 16-bit depth format. */
-    Depth16 = 28,
+    Depth16 = 29,
     /** 24-bit depth format. */
-    Depth24 = 29,
+    Depth24 = 30,
     /** 32-bit depth format. */
-    Depth32 = 30,
+    Depth32 = 31,
     /** 16-bit depth + 8-bit stencil format. */
-    Depth24Stencil8 = 31,
+    Depth24Stencil8 = 32,
     /** 32-bit depth + 8-bit stencil format. */
-    Depth32Stencil8 = 32,
+    Depth32Stencil8 = 33,
     /** @deprecated Use `TextureFormat.BC1` instead. */
-    DXT1 = 33,
+    DXT1 = 34,
     /** @deprecated Use `TextureFormat.BC3` instead. */
-    DXT5 = 34
+    DXT5 = 35
 }

package/types/xr/XRPose.d.ts

@@ -1,15 +0,0 @@
-import { IXRPose } from "@galacean/engine-design";
-import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
-/**
- * Data for describing pose in the XR space.
- */
-export declare class XRPose implements IXRPose {
-    /** The position of the pose in XR space. */
-    position: Vector3;
-    /** The rotation of the pose in XR space. */
-    rotation: Quaternion;
-    /** The matrix of the pose in XR space. */
-    matrix: Matrix;
-    /** The inverse matrix of the pose in XR space. */
-    inverseMatrix: Matrix;
-}

package/types/xr/feature/XRFeature.d.ts

@@ -1,16 +0,0 @@
-import { IXRPlatformFeature } from "@galacean/engine-design";
-import { XRManager } from "../XRManager";
-import { XRFeatureType } from "./XRFeatureType";
-/**
- * The base class of XR feature manager.
- */
-export declare abstract class XRFeature<T extends IXRPlatformFeature = IXRPlatformFeature> {
-    protected _xrManager: XRManager;
-    protected _type: XRFeatureType;
-    protected _enabled: boolean;
-    /**
-     * Returns whether the feature is enabled.
-     */
-    get enabled(): boolean;
-    set enabled(value: boolean);
-}