@galacean/engine-core 0.0.0-experimental-1.3-xr.10 → 0.0.0-experimental-1.4-small-language.0

package/types/base/Constant.d.ts

@@ -3,37 +3,37 @@
  */
 export declare enum DataType {
     /** Float */
-    FLOAT = 5126,
+    FLOAT = 5126,// gl.FLOAT
     /** Floating-point two-dimensional vector */
-    FLOAT_VEC2 = 35664,
+    FLOAT_VEC2 = 35664,// gl.FLOAT_VEC2
     /** Floating-point three-dimensional vector */
-    FLOAT_VEC3 = 35665,
+    FLOAT_VEC3 = 35665,// gl.FLOAT_VEC3
     /** Floating-point four-dimensional vector */
-    FLOAT_VEC4 = 35666,
+    FLOAT_VEC4 = 35666,// gl.FLOAT_VEC4
     /** Integer */
-    INT = 5124,
+    INT = 5124,// gl.INT
     /** Integer two-dimensional vector */
-    INT_VEC2 = 35667,
+    INT_VEC2 = 35667,// gl.INT_VEC2
     /** Integer three-dimensional vector */
-    INT_VEC3 = 35668,
+    INT_VEC3 = 35668,// gl.INT_VEC3
     /** Integer four-dimensional vector */
-    INT_VEC4 = 35669,
+    INT_VEC4 = 35669,// gl.INT_VEC4
     /** Boolean */
-    BOOL = 35670,
+    BOOL = 35670,// gl.BOOL
     /** Boolean two-dimensional vector */
-    BOOL_VEC2 = 35671,
+    BOOL_VEC2 = 35671,// gl.BOOL_VEC2
     /** Boolean three-dimensional vector */
-    BOOL_VEC3 = 35672,
+    BOOL_VEC3 = 35672,// gl.BOOL_VEC3
     /** Boolean four-dimensional vector */
-    BOOL_VEC4 = 35673,
+    BOOL_VEC4 = 35673,// gl.BOOL_VEC4
     /** Second-order matrix */
-    FLOAT_MAT2 = 35674,
+    FLOAT_MAT2 = 35674,// gl.FLOAT_MAT2
     /** Third-order matrix */
-    FLOAT_MAT3 = 35675,
+    FLOAT_MAT3 = 35675,// gl.FLOAT_MAT3
     /** Fourth-order matrix */
-    FLOAT_MAT4 = 35676,
+    FLOAT_MAT4 = 35676,// gl.FLOAT_MAT4
     /** Float array */
-    FLOAT_ARRAY = 35677,
+    FLOAT_ARRAY = 35677,// gl.FLOAT_ARRAY
     /** Floating-point two-dimensional vector array */
     FLOAT_VEC2_ARRAY = 100000,
     /** Floating-point three-dimensional vector array */
@@ -59,17 +59,17 @@ export declare enum DataType {
     /** Cube map texture sampler array */
     SAMPLER_CUBE_ARRAY = 100011,
     /** 2D sampler */
-    SAMPLER_2D = 35678,
+    SAMPLER_2D = 35678,// gl.SAMPLER_2D
     /** Cube map Texture sampler */
-    SAMPLER_CUBE = 35680,
+    SAMPLER_CUBE = 35680,// gl.SAMPLER_CUBE
     /** Byte */
-    BYTE = 5120,
+    BYTE = 5120,// gl.BYTE
     /** Unsigned byte */
-    UNSIGNED_BYTE = 5121,
+    UNSIGNED_BYTE = 5121,// gl.UNSIGNED_BYTE
     /** Short */
-    SHORT = 5122,
+    SHORT = 5122,// gl.SHORT
     /** Unsigned short */
-    UNSIGNED_SHORT = 5123,
+    UNSIGNED_SHORT = 5123,// gl.UNSIGNED_SHORT
     /** Unsigned int */
     UNSIGNED_INT = 5125
 }

package/types/enums/CameraModifyFlags.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The camera modify flags.
+ */
+export declare enum CameraModifyFlags {
+    /** The types of camera projections changes. */
+    ProjectionType = 1,
+    /** The aspect ratio of the camera changes. */
+    AspectRatio = 2,
+    /** The field of view of the camera changes. */
+    FieldOfView = 4,
+    /** The orthographic size of the camera changes. */
+    OrthographicSize = 8,
+    /** The camera becomes active in the scene. */
+    EnableInScene = 16,
+    /** The camera becomes inactive in the scene. */
+    DisableInScene = 32
+}

package/types/enums/EntityModifyFlags.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The entity modify flags.
+ */
+export declare enum EntityModifyFlags {
+    /** The parent changes. */
+    Parent = 1,
+    /** The child changes. */
+    Child = 2
+}

package/types/{2d/enums → enums}/SpriteMaskLayer.d.ts

@@ -67,5 +67,7 @@ export declare enum SpriteMaskLayer {
     /** Mask layer 31. */
     Layer31 = 2147483648,
     /** All mask layers. */
-    Everything = 4294967295
+    Everything = 4294967295,
+    /** None mask layer. */
+    Nothing = 0
 }

package/types/index.d.ts

@@ -8,7 +8,7 @@ export { SceneManager } from "./SceneManager";
 export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
-export { Renderer } from "./Renderer";
+export { Renderer, RendererUpdateFlags } from "./Renderer";
 export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
@@ -16,6 +16,7 @@ export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
 export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
+export type { RequestConfig } from "./asset/request";
 export { Loader } from "./asset/Loader";
 export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
@@ -31,11 +32,14 @@ export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
 export { CameraType } from "./enums/CameraType";
+export { CameraModifyFlags } from "./enums/CameraModifyFlags";
+export { EntityModifyFlags } from "./enums/EntityModifyFlags";
 export { MSAASamples } from "./enums/MSAASamples";
 export { ReplacementFailureStrategy } from "./enums/ReplacementFailureStrategy";
 export { Downsampling } from "./enums/Downsampling";
 export { ColorSpace } from "./enums/ColorSpace";
 export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
+export { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 export { XRManager } from "./xr/XRManager";
 export * from "./utils/index";
 export * from "./input/index";
@@ -58,5 +62,6 @@ export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
 export * from "./Utils";
+export * from "./audio/index";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 export * from "./postProcess";

package/types/input/index.d.ts

@@ -1,5 +1,8 @@
-export { PointerPhase } from "./enums/PointerPhase";
-export { Pointer } from "./pointer/Pointer";
 export { InputManager } from "./InputManager";
 export { Keys } from "./enums/Keys";
 export { PointerButton } from "./enums/PointerButton";
+export { PointerPhase } from "./enums/PointerPhase";
+export { Pointer } from "./pointer/Pointer";
+export { PointerEventData } from "./pointer/PointerEventData";
+export { registerPointerEventEmitter } from "./pointer/PointerManager";
+export { PointerEventEmitter } from "./pointer/emitter/PointerEventEmitter";

package/types/input/pointer/Pointer.d.ts

@@ -20,6 +20,12 @@ export declare class Pointer {
     position: Vector2;
     /** The change of the pointer. */
     deltaPosition: Vector2;
-    private _currentPressedEntity;
-    private _currentEnteredEntity;
+}
+export declare enum PointerEventType {
+    None = 0,
+    Down = 1,
+    Up = 2,
+    Leave = 4,
+    Move = 8,
+    Cancel = 16
 }

package/types/input/pointer/PointerEventData.d.ts

@@ -0,0 +1,12 @@
+import { Vector3 } from "@galacean/engine-math";
+import { IPoolElement } from "../../utils/ObjectPool";
+import { Pointer } from "./Pointer";
+/**
+ * Pointer event data.
+ */
+export declare class PointerEventData implements IPoolElement {
+    /** The pointer that triggers this event. */
+    pointer: Pointer;
+    /** The position of the event trigger (in world space). */
+    worldPosition: Vector3;
+}

package/types/input/pointer/PointerManager.d.ts

@@ -1 +1,9 @@
-export {};
+import { ClearableObjectPool } from "../../utils/ClearableObjectPool";
+import { PointerEventData } from "./PointerEventData";
+import { PointerEventEmitter } from "./emitter/PointerEventEmitter";
+/**
+ * Declare pointer event emitter decorator.
+ */
+export declare function registerPointerEventEmitter(): <T extends PointerEventEmitter>(Target: {
+    new (pool: ClearableObjectPool<PointerEventData>): T;
+}) => void;

package/types/input/pointer/emitter/IHitResult.d.ts

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

package/types/input/pointer/emitter/PhysicsPointerEventEmitter.d.ts

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

package/types/input/pointer/emitter/PointerEventEmitter.d.ts

@@ -0,0 +1,30 @@
+import { Ray } from "@galacean/engine-math";
+import { Entity } from "../../../Entity";
+import { Scene } from "../../../Scene";
+import { ClearableObjectPool } from "../../../utils/ClearableObjectPool";
+import { Pointer } from "../Pointer";
+import { PointerEventData } from "../PointerEventData";
+import { IHitResult } from "./IHitResult";
+export declare abstract class PointerEventEmitter {
+    protected static _tempRay: Ray;
+    protected _hitResult: IHitResult;
+    protected _pool: ClearableObjectPool<PointerEventData>;
+    constructor(pool: ClearableObjectPool<PointerEventData>);
+    abstract processRaycast(scenes: readonly Scene[], pointer: Pointer): void;
+    abstract processDrag(pointer: Pointer): void;
+    abstract processDown(pointer: Pointer): void;
+    abstract processUp(pointer: Pointer): void;
+    abstract processLeave(pointer: Pointer): void;
+    abstract dispose(): void;
+    protected abstract _init(): void;
+    protected _createEventData(pointer: Pointer): PointerEventData;
+    protected _fireDown(entity: Entity, eventData: PointerEventData): void;
+    protected _fireUp(entity: Entity, eventData: PointerEventData): void;
+    protected _fireClick(entity: Entity, eventData: PointerEventData): void;
+    protected _fireEnter(entity: Entity, eventData: PointerEventData): void;
+    protected _fireExit(entity: Entity, eventData: PointerEventData): void;
+    protected _fireBeginDrag(entity: Entity, eventData: PointerEventData): void;
+    protected _fireDrag(entity: Entity, eventData: PointerEventData): void;
+    protected _fireEndDrag(entity: Entity, eventData: PointerEventData): void;
+    protected _fireDrop(entity: Entity, eventData: PointerEventData): void;
+}

package/types/lighting/DirectLight.d.ts

@@ -7,6 +7,11 @@ export declare class DirectLight extends Light {
     private static _cullingMaskProperty;
     private static _colorProperty;
     private static _directionProperty;
+    /**
+     * The offset distance in the opposite direction of light direction when generating shadows.
+     * @remarks Increasing this value can avoid the holes in the shadow caused by low polygon models.
+     */
+    shadowNearPlaneOffset: number;
     private _reverseDirection;
     /**
      * Get direction.

package/types/lighting/Light.d.ts

@@ -19,7 +19,10 @@ export declare abstract class Light extends Component {
     shadowBias: number;
     /** Shadow mapping normal-based bias. */
     shadowNormalBias: number;
-    /** Near plane value to use for shadow frustums. */
+    /**
+     * @deprecated
+     * Please use `shadowNearPlaneOffset` instead.
+     */
     shadowNearPlane: number;
     private _shadowStrength;
     private _color;

package/types/material/BaseMaterial.d.ts

@@ -16,10 +16,10 @@ export declare class BaseMaterial extends Material {
     protected static _normalIntensityProp: ShaderProperty;
     protected static _emissiveColorProp: ShaderProperty;
     protected static _emissiveTextureProp: ShaderProperty;
-    private static _alphaCutoffProp;
+    protected static _alphaCutoffProp: ShaderProperty;
     private static _alphaCutoffMacro;
     private _renderFace;
-    private _isTransparent;
+    protected _isTransparent: boolean;
     private _blendMode;
     /**
      * Shader used by the material.
@@ -83,4 +83,6 @@ export declare class BaseMaterial extends Material {
      * @param target - target material
      */
     cloneTo(target: BaseMaterial): void;
+    protected _seIsTransparent(value: boolean): void;
+    protected _setAlphaCutoff(value: number): void;
 }

package/types/material/Material.d.ts

@@ -44,6 +44,7 @@ export declare class Material extends ReferResource implements IClone {
      */
     cloneTo(target: Material): void;
     _addReferCount(value: number): void;
+    protected _cloneToAndModifyName(target: Material): void;
     /**
      * @override
      */

package/types/material/PBRMaterial.d.ts

@@ -1,6 +1,8 @@
+import { Color, Vector2 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Texture2D } from "../texture/Texture2D";
 import { PBRBaseMaterial } from "./PBRBaseMaterial";
+import { RefractionMode } from "./enums/Refraction";
 /**
  * PBR (Metallic-Roughness Workflow) Material.
  */
@@ -11,7 +13,27 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _iorProp;
     private static _anisotropyInfoProp;
     private static _anisotropyTextureProp;
+    private static _iridescenceInfoProp;
+    private static _iridescenceThicknessTextureProp;
+    private static _iridescenceTextureProp;
+    private static _sheenColorProp;
+    private static _sheenRoughnessProp;
+    private static _sheenTextureProp;
+    private static _sheenRoughnessTextureProp;
+    private static _transmissionMacro;
+    private static _thicknessMacro;
+    private static _thicknessTextureMacro;
+    private static _transmissionTextureMacro;
+    private static _transmissionProp;
+    private static _transmissionTextureProp;
+    private static _attenuationColorProp;
+    private static _attenuationDistanceProp;
+    private static _thicknessProp;
+    private static _thicknessTextureProp;
+    private _refractionMode;
     private _anisotropyRotation;
+    private _iridescenceRange;
+    private _sheenEnabled;
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -56,6 +78,112 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     get anisotropyTexture(): Texture2D;
     set anisotropyTexture(value: Texture2D);
+    /**
+     * The iridescence intensity factor, from 0.0 to 1.0.
+     * @defaultValue `0.0`
+     */
+    get iridescence(): number;
+    set iridescence(value: number);
+    /**
+     * The iridescence intensity texture, sampling red channel, and multiply 'iridescence'.
+     */
+    get iridescenceTexture(): Texture2D;
+    set iridescenceTexture(value: Texture2D);
+    /**
+     * The index of refraction of the dielectric thin-film layer, greater than or equal to 1.0.
+     * @defaultValue `1.3`
+     */
+    get iridescenceIOR(): number;
+    set iridescenceIOR(value: number);
+    /**
+     * The range of iridescence thickness, x is minimum, y is maximum.
+     *  @defaultValue `[100, 400]`
+     */
+    get iridescenceThicknessRange(): Vector2;
+    set iridescenceThicknessRange(value: Vector2);
+    /**
+     * The thickness texture of the thin-film layer, sampling green channel.
+     * @remarks
+     * If iridescenceThicknessTexture is defined, iridescence thickness between the 'iridescenceThicknessRange'.
+     * If iridescenceThicknessTexture is not defined, iridescence thickness will use only 'iridescenceThicknessRange.y'.
+     */
+    get iridescenceThicknessTexture(): Texture2D;
+    set iridescenceThicknessTexture(value: Texture2D);
+    /**
+     * Sheen color.
+     * @defaultValue `[0,0,0]`
+     */
+    get sheenColor(): Color;
+    set sheenColor(value: Color);
+    /**
+     * Sheen roughness, from 0.0 to 1.0.
+     * @defaultValue `0.0`
+     */
+    get sheenRoughness(): number;
+    set sheenRoughness(value: number);
+    /**
+     * Sheen color texture, multiply ‘sheenColor’.
+     */
+    get sheenColorTexture(): Texture2D;
+    set sheenColorTexture(value: Texture2D);
+    /**
+     * Sheen roughness texture.
+     * @remarks Use alpha channel, and multiply 'sheenRoughness'.
+     */
+    get sheenRoughnessTexture(): Texture2D;
+    set sheenRoughnessTexture(value: Texture2D);
+    /**
+     * Refraction switch.
+     * @remarks Use refractionMode to set the refraction shape.
+     */
+    get refractionMode(): RefractionMode;
+    set refractionMode(value: RefractionMode);
+    /**
+     * @inheritdoc
+     */
+    get isTransparent(): boolean;
+    set isTransparent(value: boolean);
+    /**
+     * @inheritdoc
+     */
+    get alphaCutoff(): number;
+    set alphaCutoff(value: number);
+    /**
+     * Transmission factor.
+     * @defaultValue `0.0`
+     */
+    get transmission(): number;
+    set transmission(value: number);
+    /**
+     * Transmission texture.
+     * @remarks Use red channel, and multiply 'transmission'.
+     */
+    get transmissionTexture(): Texture2D;
+    set transmissionTexture(value: Texture2D);
+    /**
+     * Attenuation color.
+     * @defaultValue `[1,1,1]`
+     */
+    get attenuationColor(): Color;
+    set attenuationColor(value: Color);
+    /**
+     * Attenuation distance, greater than 0.0.
+     * @defaultValue `infinity`
+     */
+    get attenuationDistance(): number;
+    set attenuationDistance(value: number);
+    /**
+     * Thickness, greater than or equal to 0.0.
+     * @defaultValue `0.0`
+     */
+    get thickness(): number;
+    set thickness(value: number);
+    /**
+     * Thickness texture.
+     * @remarks Use green channel, and multiply 'thickness', range is 0.0 to 1.0.
+     */
+    get thicknessTexture(): Texture2D;
+    set thicknessTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs
@@ -65,4 +193,6 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      * @inheritdoc
      */
     clone(): PBRMaterial;
+    private _onIridescenceRangeChanged;
+    private _onSheenColorChanged;
 }

package/types/material/enums/Refraction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Refraction mode.
+ */
+export declare enum RefractionMode {
+    /** Use the sphere refraction model when light passes through the surface. */
+    Sphere = 0,
+    /** Use the planar refraction model when light passes through the surface. */
+    Planar = 1
+}

package/types/material/index.d.ts

@@ -8,3 +8,4 @@ export { PBRBaseMaterial } from "./PBRBaseMaterial";
 export { PBRMaterial } from "./PBRMaterial";
 export { PBRSpecularMaterial } from "./PBRSpecularMaterial";
 export { UnlitMaterial } from "./UnlitMaterial";
+export { RefractionMode } from "./enums/Refraction";

package/types/material/utils/PrefilteredDFG.d.ts

@@ -0,0 +1,7 @@
+import { Engine } from "../../Engine";
+import { Texture2D } from "../../texture/Texture2D";
+export declare class PrefilteredDFG {
+    private static _size;
+    private static _base64;
+    static create(engine: Engine): Promise<Texture2D>;
+}

package/types/particle/ParticleGenerator.d.ts

@@ -46,6 +46,7 @@ export declare class ParticleGenerator {
     private _transformedBoundsCount;
     private _firstActiveTransformedBoundingBox;
     private _firstFreeTransformedBoundingBox;
+    private _playStartDelay;
     /**
      * Whether the particle generator is contain alive or is still creating particles.
      */

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

@@ -5,7 +5,7 @@ import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
 import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
 import { ParticleCompositeGradient } from "./ParticleCompositeGradient";
 export declare class MainModule implements ICustomClone {
-    private static _tempVector40;
+    private _tempVector40;
     private static _vector3One;
     private static readonly _positionScale;
     private static readonly _sizeScale;
@@ -50,7 +50,6 @@ export declare class MainModule implements ICustomClone {
     private _gravityModifier;
     private _simulationSpace;
     private _generator;
-    private _gravity;
     /**
      * The initial lifetime of particles when emitted.
      */

package/types/physics/CharacterController.d.ts

@@ -11,7 +11,8 @@ export declare class CharacterController extends Collider {
     private _upDirection;
     private _slopeLimit;
     /**
-     * The step offset for the controller.
+     * The step offset for the controller, the value must be greater than or equal to 0.
+     * @remarks Character can overcome obstacle less than the height(stepOffset + contractOffset of the shape).
      */
     get stepOffset(): number;
     set stepOffset(value: number);
@@ -26,7 +27,8 @@ export declare class CharacterController extends Collider {
     get upDirection(): Vector3;
     set upDirection(value: Vector3);
     /**
-     * The slope limit for the controller.
+     * The slope limit in degrees for the controller, the value is the cosine value of the maximum slope angle.
+     * @defaultValue 45 degrees
      */
     get slopeLimit(): number;
     set slopeLimit(value: number);
@@ -43,10 +45,7 @@ export declare class CharacterController extends Collider {
      * @param shape - Collider shape
      */
     addShape(shape: ColliderShape): void;
-    /**
-     * Remove all shape attached.
-     */
-    clearShapes(): void;
+    protected _syncNative(): void;
     private _syncWorldPositionFromPhysicalSpace;
     private _setUpDirection;
 }

package/types/physics/Collider.d.ts

@@ -27,5 +27,7 @@ export declare class Collider extends Component implements ICustomClone {
      * Remove all shape attached.
      */
     clearShapes(): void;
-    protected _addPhysicsShape(shape: ColliderShape): void;
+    protected _syncNative(): void;
+    protected _addNativeShape(shape: ColliderShape): void;
+    protected _removeNativeShape(shape: ColliderShape): void;
 }

package/types/physics/Collision.d.ts

@@ -1,4 +1,22 @@
+import { ContactPoint } from "./ContactPoint";
 import { ColliderShape } from "./shape";
+/**
+ * Collision information between two shapes when they collide.
+ */
 export declare class Collision {
+    /** The target shape be collided. */
     shape: ColliderShape;
+    /**
+     * Count of contact points.
+     */
+    get contactCount(): number;
+    /**
+     * Get contact points.
+     * @param outContacts - The result of contact points
+     * @returns The actual count of contact points
+     *
+     * @remarks To optimize performance, the engine does not modify the length of the array you pass.
+     * You need to obtain the actual number of contact points from the function's return value.
+     */
+    getContacts(outContacts: ContactPoint[]): number;
 }

package/types/physics/ContactPoint.d.ts

@@ -0,0 +1,14 @@
+import { Vector3 } from "@galacean/engine-math";
+/**
+ * Describes a contact point where the collision occurs.
+ */
+export declare class ContactPoint {
+    /** The position of the contact point between the shapes, in world space. */
+    readonly position: Vector3;
+    /** The normal of the contacting surfaces at the contact point. The normal direction points from the other shape to the self shape. */
+    readonly normal: Vector3;
+    /** The impulse applied at the contact point, in world space. Divide by the simulation time step to get a force value. */
+    readonly impulse: Vector3;
+    /** The separation of the shapes at the contact point.  A negative separation denotes a penetration. */
+    separation: number;
+}