@galacean/engine-core 0.9.0-beta.80 → 1.0.0-alpha.6

package/types/physics/PhysicsManager.d.ts

@@ -1,4 +1,3 @@
-import { IPhysics } from "@galacean/engine-design";
 import { Ray, Vector3 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Layer } from "../Layer";
@@ -7,6 +6,7 @@ import { HitResult } from "./HitResult";
  * A physics manager is a collection of colliders and constraints which can interact.
  */
 export declare class PhysicsManager {
+    private static _collision;
     private _engine;
     private _restTime;
     private _colliders;
@@ -21,31 +21,12 @@ export declare class PhysicsManager {
     private _onTriggerStay;
     /** The fixed time step in seconds at which physics are performed. */
     fixedTimeStep: number;
-    /**
-     * The max allowed time step in seconds one frame.
-     *
-     * @remarks
-     * When the frame rate is low or stutter occurs, the maximum execution time of physics will not exceed this value.
-     * So physics will slow down a bit when performance hitch occurs.
-     */
-    maxAllowedTimeStep: number;
     /**
      * The gravity of physics scene.
      */
     get gravity(): Vector3;
     set gravity(value: Vector3);
-    /**
-     * @deprecated
-     * Please use `maxAllowedTimeStep` instead.
-     */
-    get maxSumTimeStep(): number;
-    set maxSumTimeStep(value: number);
     constructor(engine: Engine);
-    /**
-     * initialize PhysicsManager.
-     * @param physics - Physics Engine
-     */
-    initialize(physics: IPhysics): void;
     /**
      * Casts a ray through the Scene and returns the first hit.
      * @param ray - The ray

package/types/physics/joint/Joint.d.ts

@@ -1,11 +1,11 @@
 import { IJoint } from "@galacean/engine-design";
 import { Vector3 } from "@galacean/engine-math";
 import { Component } from "../../Component";
-import { Collider } from "../Collider";
 import { Entity } from "../../Entity";
+import { Collider } from "../Collider";
 /**
  * A base class providing common functionality for joints.
- * @decorator `@dependentComponents(Collider)`
+ * @decorator `@dependentComponents(Collider, DependentMode.CheckOnly)`
  */
 export declare class Joint extends Component {
     protected _connectedCollider: JointCollider;

package/types/renderingHardwareInterface/index.d.ts

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

package/types/shader/Shader.d.ts

@@ -2,15 +2,13 @@ import { Engine } from "../Engine";
 import { ShaderMacro } from "./ShaderMacro";
 import { ShaderPass } from "./ShaderPass";
 import { ShaderProperty } from "./ShaderProperty";
+import { SubShader } from "./SubShader";
 /**
  * Shader for rendering.
  */
 export declare class Shader {
+    readonly name: string;
     private static _shaderMap;
-    private static _propertyNameMap;
-    private static _macroMaskMap;
-    private static _macroCounter;
-    private static _macroMap;
     /**
      * Create a shader.
      * @param name - Name of the shader
@@ -26,18 +24,46 @@ export declare class Shader {
      * @returns Shader
      */
     static create(name: string, shaderPasses: ShaderPass[]): Shader;
+    /**
+     * Create a shader.
+     * @param name - Name of the shader
+     * @param subShaders - Sub shaders
+     * @returns Shader
+     */
+    static create(name: string, subShaders: SubShader[]): Shader;
     /**
      * Find a shader by name.
      * @param name - Name of the shader
      */
     static find(name: string): Shader;
+    private _subShaders;
+    /**
+     * Sub shaders of the shader.
+     */
+    get subShaders(): ReadonlyArray<SubShader>;
+    private constructor();
+    /**
+     * Compile shader variant by macro name list.
+     *
+     * @remarks
+     * Usually a shader contains some macros,any combination of macros is called shader variant.
+     *
+     * @param engine - Engine to which the shader variant belongs
+     * @param macros - Macro name list
+     * @returns Is the compiled shader variant valid
+     */
+    compileVariant(engine: Engine, macros: string[]): boolean;
     /**
+     * @deprecated Please use `ShaderMacro.getByName` instead
+     *
      * Get shader macro by name.
      * @param name - Name of the shader macro
      * @returns Shader macro
      */
     static getMacroByName(name: string): ShaderMacro;
     /**
+     * @deprecated Please use `ShaderMacro.getByName` instead
+     *
      * Get shader macro by name.
      * @param name - Name of the shader macro
      * @param value - Value of the shader macro
@@ -45,28 +71,11 @@ export declare class Shader {
      */
     static getMacroByName(name: string, value: string): ShaderMacro;
     /**
+     * @deprecated Please use `ShaderProperty.getByName` instead
+     *
      * Get shader property by name.
      * @param name - Name of the shader property
      * @returns Shader property
      */
     static getPropertyByName(name: string): ShaderProperty;
-    /** The name of shader. */
-    readonly name: string;
-    /**
-     *  Shader passes.
-     */
-    get passes(): ReadonlyArray<ShaderPass>;
-    private _passes;
-    private constructor();
-    /**
-     * Compile shader variant by macro name list.
-     *
-     * @remarks
-     * Usually a shader contains some macros,any combination of macros is called shader variant.
-     *
-     * @param engine - Engine to which the shader variant belongs
-     * @param macros - Macro name list
-     * @returns Is the compiled shader variant valid
-     */
-    compileVariant(engine: Engine, macros: string[]): boolean;
 }

package/types/shader/ShaderData.d.ts

@@ -1,13 +1,13 @@
 import { IClone } from "@galacean/engine-design";
 import { Color, Matrix, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
-import { IRefObject } from "../asset/IRefObject";
+import { IReferable } from "../asset/IReferable";
 import { Texture } from "../texture/Texture";
 import { ShaderMacro } from "./ShaderMacro";
 import { ShaderProperty } from "./ShaderProperty";
 /**
  * Shader data collection,Correspondence includes shader properties data and macros data.
  */
-export declare class ShaderData implements IRefObject, IClone {
+export declare class ShaderData implements IReferable, IClone {
     private _macroMap;
     private _refCount;
     /**
@@ -18,7 +18,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getFloat(propertyName: string): number;
     /**
      * Get float by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Float
      */
     getFloat(property: ShaderProperty): number;
@@ -32,7 +32,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set float by shader property.
      * @remarks Corresponding float shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Float
      */
     setFloat(property: ShaderProperty, value: number): void;
@@ -44,7 +44,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getInt(propertyName: string): number;
     /**
      * Get int by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Int
      */
     getInt(property: ShaderProperty): number;
@@ -58,7 +58,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set int by shader property.
      * @remarks Correspondence includes int and bool shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Int
      */
     setInt(property: ShaderProperty, value: number): void;
@@ -70,7 +70,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getFloatArray(propertyName: string): Float32Array;
     /**
      * Get float array by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Float array
      */
     getFloatArray(property: ShaderProperty): Float32Array;
@@ -84,7 +84,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set float array by shader property.
      * @remarks Correspondence includes float array、vec2 array、vec3 array、vec4 array and matrix array shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Float array
      */
     setFloatArray(property: ShaderProperty, value: Float32Array): void;
@@ -96,7 +96,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getIntArray(propertyName: string): Int32Array;
     /**
      * Get int array by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Int Array
      */
     getIntArray(property: ShaderProperty): Int32Array;
@@ -110,7 +110,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set int array by shader property.
      * @remarks Correspondence includes bool array、int array、bvec2 array、bvec3 array、bvec4 array、ivec2 array、ivec3 array and ivec4 array shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Int Array
      */
     setIntArray(property: ShaderProperty, value: Int32Array): void;
@@ -122,7 +122,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getVector2(propertyName: string): Vector2;
     /**
      * Get two-dimensional from shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Two-dimensional vector
      */
     getVector2(property: ShaderProperty): Vector2;
@@ -136,7 +136,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set two-dimensional vector from shader property.
      * @remarks Correspondence includes vec2、ivec2 and bvec2 shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Two-dimensional vector
      */
     setVector2(property: ShaderProperty, value: Vector2): void;
@@ -148,7 +148,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getVector3(propertyName: string): Vector3;
     /**
      * Get vector3 by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Three-dimensional vector
      */
     getVector3(property: ShaderProperty): Vector3;
@@ -162,7 +162,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set three dimensional vector by shader property.
      * @remarks Correspondence includes vec3、ivec3 and bvec3 shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Three-dimensional vector
      */
     setVector3(property: ShaderProperty, value: Vector3): void;
@@ -174,7 +174,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getVector4(propertyName: string): Vector4;
     /**
      * Get vector4 by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Four-dimensional vector
      */
     getVector4(property: ShaderProperty): Vector4;
@@ -188,7 +188,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set four-dimensional vector by shader property.
      * @remarks Correspondence includes vec4、ivec4 and bvec4 shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Four-dimensional vector
      */
     setVector4(property: ShaderProperty, value: Vector4): void;
@@ -200,7 +200,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getMatrix(propertyName: string): Matrix;
     /**
      * Get matrix by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Matrix
      */
     getMatrix(property: ShaderProperty): Matrix;
@@ -214,7 +214,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set matrix by shader property.
      * @remarks Correspondence includes matrix shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Matrix
      */
     setMatrix(property: ShaderProperty, value: Matrix): any;
@@ -226,7 +226,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getColor(propertyName: string): Color;
     /**
      * Get color by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Color
      */
     getColor(property: ShaderProperty): Color;
@@ -240,7 +240,7 @@ export declare class ShaderData implements IRefObject, IClone {
     /**
      * Set color by shader property.
      * @remarks Correspondence includes vec4 shader property type.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Color
      */
     setColor(property: ShaderProperty, value: Color): void;
@@ -252,7 +252,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getTexture(propertyName: string): Texture;
     /**
      * Get texture by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Texture
      */
     getTexture(property: ShaderProperty): Texture;
@@ -264,7 +264,7 @@ export declare class ShaderData implements IRefObject, IClone {
     setTexture(propertyName: string, value: Texture): void;
     /**
      * Set texture by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Texture
      */
     setTexture(property: ShaderProperty, value: Texture): void;
@@ -276,7 +276,7 @@ export declare class ShaderData implements IRefObject, IClone {
     getTextureArray(propertyName: string): Texture[];
     /**
      * Get texture array by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @returns Texture array
      */
     getTextureArray(property: ShaderProperty): Texture[];
@@ -288,7 +288,7 @@ export declare class ShaderData implements IRefObject, IClone {
     setTextureArray(propertyName: string, value: Texture[]): void;
     /**
      * Set texture array by shader property.
-     * @param property - Shader property, use `Shader.getPropertyByName` to get
+     * @param property - Shader property, use `ShaderProperty.getByName` to get
      * @param value - Texture array
      */
     setTextureArray(property: ShaderProperty, value: Texture[]): void;

package/types/shader/ShaderMacro.d.ts

@@ -3,8 +3,24 @@
  */
 export declare class ShaderMacro {
     private static _macroNameCounter;
+    private static _macroCounter;
+    private static _macroMap;
+    /**
+     * Get shader macro by name.
+     * @param name - Name of the shader macro
+     * @returns Shader macro
+     */
+    static getByName(name: string): ShaderMacro;
+    /**
+     * Get shader macro by name.
+     * @param name - Name of the shader macro
+     * @param value - Value of the shader macro
+     * @returns Shader macro
+     */
+    static getByName(name: string, value: string): ShaderMacro;
     /** Name. */
     readonly name: string;
     /** Value. */
     readonly value: string;
+    private constructor();
 }

package/types/shader/ShaderPass.d.ts

@@ -1,9 +1,16 @@
+import { ShaderPart } from "./ShaderPart";
 /**
  * Shader pass containing vertex and fragment source.
  */
-export declare class ShaderPass {
+export declare class ShaderPass extends ShaderPart {
     private static _shaderPassCounter;
     private _vertexSource;
     private _fragmentSource;
-    constructor(vertexSource: string, fragmentSource: string);
+    /**
+     * Create a shader pass.
+     * @param vertexSource - Vertex shader source
+     * @param fragmentSource - Fragment shader source
+     * @param tags - Tags
+     */
+    constructor(vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
 }

package/types/shader/ShaderProperty.d.ts

@@ -4,6 +4,13 @@ import { ShaderPropertyType } from "./enums/ShaderPropertyType";
  */
 export declare class ShaderProperty {
     private static _propertyNameCounter;
+    private static _propertyNameMap;
+    /**
+     * Get shader property by name.
+     * @param name - Name of the shader property
+     * @returns Shader property
+     */
+    static getByName(name: string): ShaderProperty;
     /** Shader property name. */
     readonly name: string;
     /**

package/types/shader/index.d.ts

@@ -1,12 +1,15 @@
-export { RenderQueueType } from "./enums/RenderQueueType";
 export { BlendFactor } from "./enums/BlendFactor";
 export { BlendOperation } from "./enums/BlendOperation";
 export { ColorWriteMask } from "./enums/ColorWriteMask";
 export { CompareFunction } from "./enums/CompareFunction";
 export { CullMode } from "./enums/CullMode";
+export { RenderQueueType } from "./enums/RenderQueueType";
 export { ShaderPropertyType } from "./enums/ShaderPropertyType";
 export { StencilOperation } from "./enums/StencilOperation";
 export { Shader } from "./Shader";
 export { ShaderData } from "./ShaderData";
+export { ShaderMacro } from "./ShaderMacro";
 export { ShaderPass } from "./ShaderPass";
 export { ShaderProperty } from "./ShaderProperty";
+export { ShaderTagKey } from "./ShaderTagKey";
+export { SubShader } from "./SubShader";

package/types/shadow/CascadedShadowCasterPass.d.ts

@@ -17,7 +17,6 @@ export declare class CascadedShadowCasterPass {
     private static _tempMatrix0;
     private readonly _camera;
     private readonly _engine;
-    private readonly _shadowCasterShader;
     private readonly _supportDepthTexture;
     private _shadowMapResolution;
     private _shadowMapSize;

package/types/texture/RenderTarget.d.ts

@@ -1,11 +1,11 @@
-import { EngineObject } from "../base";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
 import { Texture } from "./Texture";
 /**
  * The render target used for off-screen rendering.
  */
-export declare class RenderTarget extends EngineObject {
+export declare class RenderTarget extends GraphicsResource {
     private _autoGenerateMipmaps;
     private _width;
     private _height;
@@ -89,7 +89,7 @@ export declare class RenderTarget extends EngineObject {
      */
     generateMipmaps(): void;
     /**
-     * Destroy render target.
+     * @override
      */
-    destroy(): void;
+    protected _onDestroy(): void;
 }

package/types/texture/Texture.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
 import { TextureFilterMode } from "./enums/TextureFilterMode";
 import { TextureFormat } from "./enums/TextureFormat";
@@ -6,7 +6,7 @@ import { TextureWrapMode } from "./enums/TextureWrapMode";
 /**
  * The base class of texture, contains some common functions of texture-related classes.
  */
-export declare abstract class Texture extends RefObject {
+export declare abstract class Texture extends GraphicsResource {
     name: string;
     protected _format: TextureFormat;
     protected _width: number;
@@ -64,10 +64,6 @@ export declare abstract class Texture extends RefObject {
      * Generate multi-level textures based on the 0th level data.
      */
     generateMipmaps(): void;
-    /**
-     * @override
-     */
-    _onDestroy(): void;
     /**
      * Get the maximum mip level of the corresponding size:rounding down.
      * @remarks http://download.nvidia.com/developer/Papers/2005/NP2_Mipmapping/NP2_Mipmap_Creation.pdf

package/types/texture/Texture2DArray.d.ts

@@ -78,4 +78,8 @@ export declare class Texture2DArray extends Texture {
      * @param out - Color buffer
      */
     getPixelBuffer(elementIndex: number, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
+    /**
+     * @override
+     */
+    _rebuild(): void;
 }

package/types/texture/TextureCube.d.ts

@@ -67,4 +67,8 @@ export declare class TextureCube extends Texture {
      * @param out - Color buffer
      */
     getPixelBuffer(face: TextureCubeFace, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
+    /**
+     * @override
+     */
+    _rebuild(): void;
 }