@galacean/engine-core 0.0.0-experimental-renderSort.4 → 0.0.0-experimental-shaderlab.2

package/types/asset/AssetPromise.d.ts

@@ -13,8 +13,10 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     get [Symbol.toStringTag](): string;
     private _promise;
     private _state;
-    private _progress;
-    private _onProgressCallback;
+    private _taskCompleteProgress;
+    private _taskDetailProgress;
+    private _onTaskCompleteCallbacks;
+    private _onTaskDetailCallbacks;
     private _onCancelHandler;
     private _reject;
     /**
@@ -27,10 +29,11 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     constructor(executor: AssetPromiseExecutor<T>);
     /**
      * Progress callback.
-     * @param callback
+     * @param onTaskComplete - This callback function provides information about the overall progress of the task. For example, in batch processing tasks, you can use the loaded and total parameters to calculate the percentage of task completion or display a progress bar
+     * @param onTaskDetail - This callback function provides detailed progress information about the task. For instance, in file downloading scenarios, you can use the loaded and total parameters to calculate the download progress percentage and utilize the url parameter to provide additional details such as download speed and estimated remaining time
      * @returns AssetPromise
      */
-    onProgress(callback: (progress: number) => void): AssetPromise<T>;
+    onProgress(onTaskComplete: (loaded: number, total: number) => void, onTaskDetail?: (identifier: string, loaded: number, total: number) => void): AssetPromise<T>;
     then<TResult1 = T, TResult2 = never>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): AssetPromise<TResult1 | TResult2>;
     /**
      * Attaches a callback for only the rejection of the Promise.
@@ -52,6 +55,8 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     cancel(): AssetPromise<T>;
 }
 interface AssetPromiseExecutor<T> {
-    (resolve: (value?: T | PromiseLike<T>) => void, reject?: (reason?: any) => void, setProgress?: (progress: number) => void, onCancel?: (callback: () => void) => void): void;
+    (resolve: (value?: T | PromiseLike<T>) => void, reject?: (reason?: any) => void, setTaskCompleteProgress?: TaskCompleteCallback, setTaskDetailProgress?: TaskDetailCallback, onCancel?: (callback: () => void) => void): void;
 }
+type TaskCompleteCallback = (loaded: number, total: number) => void;
+type TaskDetailCallback = (url: string, loaded: number, total: number) => void;
 export {};

package/types/asset/AssetType.d.ts

@@ -23,6 +23,10 @@ export declare enum AssetType {
     TextureCube = "TextureCube",
     /** Material. */
     Material = "Material",
+    /** Shader */
+    Shader = "Shader",
+    /** Shader Chunk */
+    ShaderChunk = "ShaderChunk",
     /** Mesh. */
     Mesh = "Mesh",
     /** AnimationClip. */
@@ -39,6 +43,8 @@ export declare enum AssetType {
     KTX2 = "KTX2",
     /** Sprite. */
     Sprite = "Sprite",
+    /** PrimitiveMesh. */
+    PrimitiveMesh = "PrimitiveMesh",
     /** Sprite Atlas. */
     SpriteAtlas = "SpriteAtlas",
     /** Ambient light. */

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/ReferResource.d.ts

@@ -8,6 +8,7 @@ export declare abstract class ReferResource extends EngineObject implements IRef
     /** Whether to ignore the garbage collection check, if it is true, it will not be affected by ResourceManager.gc(). */
     isGCIgnored: boolean;
     private _refCount;
+    private _superResources;
     /**
      * Counted by valid references.
      */
@@ -15,8 +16,8 @@ export declare abstract class ReferResource extends EngineObject implements IRef
     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.
+     * @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;
 }

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/Constant.d.ts

@@ -96,6 +96,7 @@ export declare enum GLCapabilityType {
     colorBufferHalfFloat = "EXT_color_buffer_half_float",
     textureFilterAnisotropic = "EXT_texture_filter_anisotropic",
     blendMinMax = "EXT_blend_minmax",
+    fragDepth = "EXT_frag_depth",
     astc = "WEBGL_compressed_texture_astc",
     astc_webkit = "WEBKIT_WEBGL_compressed_texture_astc",
     etc = "WEBGL_compressed_texture_etc",

package/types/enums/CameraType.d.ts

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

package/types/enums/Downsampling.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Down sampling.
+ */
+export declare enum Downsampling {
+    /** No down sampling. */
+    None = 1,
+    /** Half resolution down sampling. */
+    TwoX = 2,
+    /** Quarter resolution down sampling. */
+    FourX = 4
+}

package/types/enums/MSAASamples.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Multi-sample anti-aliasing samples.
+ */
+export declare enum MSAASamples {
+    /** No multi-sample anti-aliasing. */
+    None = 1,
+    /** Multi-sample anti-aliasing with 2 samples. */
+    TwoX = 2,
+    /** Multi-sample anti-aliasing with 4 samples. */
+    FourX = 4,
+    /** Multi-sample anti-aliasing with 8 samples. */
+    EightX = 8
+}

package/types/index.d.ts

@@ -1,7 +1,7 @@
 export { Platform } from "./Platform";
 export { Engine } from "./Engine";
 export { SystemInfo } from "./SystemInfo";
-export type { Canvas } from "./Canvas";
+export { Canvas } from "./Canvas";
 export { Scene } from "./Scene";
 export { SceneManager } from "./SceneManager";
 export { Entity } from "./Entity";
@@ -29,8 +29,12 @@ export { BackgroundMode } from "./enums/BackgroundMode";
 export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
+export { CameraType } from "./enums/CameraType";
+export { MSAASamples } from "./enums/MSAASamples";
+export { Downsampling } from "./enums/Downsampling";
 export { ColorSpace } from "./enums/ColorSpace";
 export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
+export { XRManager } from "./xr/XRManager";
 export * from "./input/index";
 export * from "./lighting/index";
 export * from "./shadow/index";

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/lighting/Light.d.ts

@@ -26,7 +26,6 @@ export declare abstract class Light extends Component {
     private _color;
     private _viewMat;
     private _inverseViewMat;
-    private _lightColor;
     /**
      * Light Color.
      */

package/types/lighting/LightManager.d.ts

@@ -9,5 +9,4 @@ export declare class LightManager {
     private _directData;
     private _pointData;
     private _spotData;
-    private _getSunLightIndex;
 }

package/types/material/PBRMaterial.d.ts

@@ -9,6 +9,9 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _roughnessProp;
     private static _roughnessMetallicTextureProp;
     private static _iorProp;
+    private static _anisotropyInfoProp;
+    private static _anisotropyTextureProp;
+    private _anisotropyRotation;
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -33,6 +36,26 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     get roughnessMetallicTexture(): Texture2D;
     set roughnessMetallicTexture(value: Texture2D);
+    /**
+     * The strength of anisotropy, when anisotropyTexture is present, this value is multiplied by the blue channel.
+     * @defaultValue `0`
+     */
+    get anisotropy(): number;
+    set anisotropy(value: number);
+    /**
+     * The rotation of the anisotropy in tangent, bitangent space, value in degrees.
+     * @defaultValue `0`
+     */
+    get anisotropyRotation(): number;
+    set anisotropyRotation(value: number);
+    /**
+     * The anisotropy texture.
+     * @remarks
+     * Red and green channels represent the anisotropy direction in [-1, 1] tangent, bitangent space, to be rotated by anisotropyRotation.
+     * The blue channel contains strength as [0, 1] to be multiplied by anisotropy.
+     */
+    get anisotropyTexture(): Texture2D;
+    set anisotropyTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -1,5 +1,6 @@
 import { BoundingBox } from "@galacean/engine-math";
 import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
 import { MeshRenderer } from "./MeshRenderer";
 import { Skin } from "./Skin";
 /**
@@ -38,6 +39,7 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get bones(): ReadonlyArray<Entity>;
     set bones(value: ReadonlyArray<Entity>);
+    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
     private _checkBlendShapeWeightLength;
     private _onLocalBoundsChanged;
     private _getEntityHierarchyPath;

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/renderingHardwareInterface/IPlatformRenderTarget.d.ts

@@ -5,10 +5,10 @@ import { TextureCubeFace } from "../texture";
 export interface IPlatformRenderTarget {
     /**
      * Set which face and mipLevel of the cube texture to render to.
-     * @param faceIndex - Cube texture face
      * @param mipLevel - Set mip level the data want to write
+     * @param faceIndex - Cube texture face
      */
-    setRenderTargetInfo(faceIndex: TextureCubeFace, mipLevel: number): void;
+    activeRenderTarget(mipLevel: number, faceIndex?: TextureCubeFace): void;
     /**
      * Blit FBO.
      */

package/types/renderingHardwareInterface/index.d.ts

@@ -1,4 +1,3 @@
-export type { IHardwareRenderer } from "./IHardwareRenderer";
 export type { IPlatformBuffer } from "./IPlatformBuffer";
 export type { IPlatformRenderTarget } from "./IPlatformRenderTarget";
 export type { IPlatformTexture } from "./IPlatformTexture";

package/types/shader/Shader.d.ts

@@ -1,4 +1,5 @@
 import { Engine } from "../Engine";
+import { IReferable } from "../asset/IReferable";
 import { ShaderMacro } from "./ShaderMacro";
 import { ShaderPass } from "./ShaderPass";
 import { ShaderProperty } from "./ShaderProperty";
@@ -6,7 +7,7 @@ import { SubShader } from "./SubShader";
 /**
  * Shader for rendering.
  */
-export declare class Shader {
+export declare class Shader implements IReferable {
     readonly name: string;
     private static _shaderMap;
     /**
@@ -57,11 +58,18 @@ export declare class Shader {
      * @param name - Name of the shader
      */
     static find(name: string): Shader;
+    private static _applyConstRenderStates;
+    private _refCount;
+    private _destroyed;
     private _subShaders;
     /**
      * Sub shaders of the shader.
      */
     get subShaders(): ReadonlyArray<SubShader>;
+    /**
+     * Whether it has been destroyed.
+     */
+    get destroyed(): boolean;
     private constructor();
     /**
      * Compile shader variant by macro name list.
@@ -74,7 +82,12 @@ export declare class Shader {
      * @returns Is the compiled shader variant valid
      */
     compileVariant(engine: Engine, macros: string[]): boolean;
-    private static _applyConstRenderStates;
+    /**
+     * Destroy the shader.
+     * @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;
     /**
      * @deprecated Please use `ShaderMacro.getByName` instead
      *

package/types/shader/state/DepthState.d.ts

@@ -6,9 +6,9 @@ export declare class DepthState {
     private static _getGLCompareFunction;
     /** Whether to enable the depth test. */
     enabled: boolean;
-    /** Whether the depth value can be written.*/
-    writeEnabled: boolean;
     /** Depth comparison function. */
     compareFunction: CompareFunction;
+    /** Whether the depth value can be written.*/
+    writeEnabled: boolean;
     private _platformApply;
 }

package/types/shaderlib/ShaderFactory.d.ts

@@ -1,12 +1,19 @@
 export declare class ShaderFactory {
+    private static readonly _has300OutInFragReg;
     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
      * @param isFrag - Whether it is a fragment shader.
      * */
     static convertTo300(shader: string, isFrag?: boolean): string;
+    private static _has300Output;
     private static _replaceMRTShader;
 }

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/RenderTarget.d.ts

@@ -1,6 +1,7 @@
 import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
+import { TextureFormat } from "./enums/TextureFormat";
 import { Texture } from "./Texture";
 /**
  * The render target used for off-screen rendering.
@@ -43,10 +44,10 @@ export declare class RenderTarget extends GraphicsResource {
      * @param width - Render target width
      * @param height - Render target height
      * @param colorTexture - Render color texture
-     * @param depthFormat - Depth format. default RenderBufferDepthFormat.Depth, engine will automatically select the supported precision
+     * @param depthFormat - Depth format. default TextureFormat.Depth, engine will automatically select the supported precision
      * @param antiAliasing - Anti-aliasing level, default is 1
      */
-    constructor(engine: Engine, width: number, height: number, colorTexture: Texture, depthFormat?: RenderBufferDepthFormat | null, antiAliasing?: number);
+    constructor(engine: Engine, width: number, height: number, colorTexture: Texture, depthFormat?: TextureFormat | null | RenderBufferDepthFormat, antiAliasing?: number);
     /**
      * Create a render target through color texture and depth format.
      * @remarks If the color texture is not transmitted, only the depth texture is generated.
@@ -64,10 +65,10 @@ export declare class RenderTarget extends GraphicsResource {
      * @param width - Render target width
      * @param height - Render target height
      * @param colorTextures - Render color texture array
-     * @param depthFormat - Depth format. default RenderBufferDepthFormat.Depth,engine will automatically select the supported precision
+     * @param depthFormat - Depth format. default TextureFormat.Depth,engine will automatically select the supported precision
      * @param antiAliasing - Anti-aliasing level, default is 1
      */
-    constructor(engine: Engine, width: number, height: number, colorTextures: Texture[], depthFormat?: RenderBufferDepthFormat | null, antiAliasing?: number);
+    constructor(engine: Engine, width: number, height: number, colorTextures: Texture[], depthFormat?: TextureFormat | null | RenderBufferDepthFormat, antiAliasing?: number);
     /**
      * Create a render target with color texture array and depth texture.
      * @param engine - Define the engine to use for this off-screen rendering

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/RenderBufferDepthFormat.d.ts

@@ -1,21 +1,23 @@
 /**
+ * @deprecated Please use `TextureFormat` instead.
+ *
  * Render buffer depth format enumeration.
  */
 export declare enum RenderBufferDepthFormat {
     /** Render to depth buffer,engine will automatically select the supported precision. */
-    Depth = 0,
-    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
-    DepthStencil = 1,
+    Depth = 27,
     /** Render to stencil buffer. */
-    Stencil = 2,
+    Stencil = 28,
+    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
+    DepthStencil = 29,
     /** Force 16-bit depth buffer. */
-    Depth16 = 3,
+    Depth16 = 30,
     /** Force 24-bit depth buffer. */
-    Depth24 = 4,
+    Depth24 = 31,
     /** Force 32-bit depth buffer. */
-    Depth32 = 5,
+    Depth32 = 32,
     /** Force 16-bit depth + 8-bit stencil buffer. */
-    Depth24Stencil8 = 6,
+    Depth24Stencil8 = 33,
     /** Force 32-bit depth + 8-bit stencil buffer. */
-    Depth32Stencil8 = 7
+    Depth32Stencil8 = 34
 }