@galacean/engine-core 0.0.0-experimental-double11.13 → 0.0.0-experimental-shaderlab.0

package/package.json

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

package/types/2d/atlas/types.d.ts

@@ -1,3 +1,4 @@
+import { AssetType } from "../../asset/AssetType";
 import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../../texture";
 /**
  * The original data type of the atlas.
@@ -16,6 +17,8 @@ export interface AtlasConfig {
     atlasItems: {
         /** The url of the sub atlas. */
         img: string;
+        /** Image type. */
+        type: AssetType;
         /** Sprites contained in the sub atlas. */
         sprites: AtlasSprite[];
     }[];

package/types/2d/enums/SpriteModifyFlags.d.ts

@@ -9,5 +9,6 @@ export declare enum SpriteModifyFlags {
     atlasRegionOffset = 16,
     region = 32,
     pivot = 64,
-    border = 128
+    border = 128,
+    destroy = 256
 }

package/types/animation/AnimatorLayerMask.d.ts

@@ -0,0 +1,45 @@
+import { Entity } from "../Entity";
+import { LayerPathMask } from "./LayerPathMask";
+/**
+ * AnimatorLayerMask is used to mask out certain entities from being animated by an AnimatorLayer.
+ */
+export declare class AnimatorLayerMask {
+    /**
+     * Creates an AnimatorLayerMask instance by specifying an entity.
+     * This will automatically add path masks for the entity and all its children.
+     * @param entity - The root entity to create path masks for
+     */
+    static createByEntity(entity: Entity): AnimatorLayerMask;
+    private static _addPathMaskWithChildren;
+    private _pathMasks;
+    private _pathMaskMap;
+    /**
+     * The list of path masks.
+     */
+    get pathMasks(): Readonly<LayerPathMask[]>;
+    /**
+     * Adds a path mask to the AnimatorLayerMask, the root path is "".
+     * @param path - The path to add a mask for
+     * @returns The created or existing LayerPathMask
+     */
+    addPathMask(path: string): LayerPathMask;
+    /**
+     * Removes a path mask from the AnimatorLayerMask.
+     * @param path - The path of the mask to remove
+     */
+    removePathMask(path: any): void;
+    /**
+     * Get a path mask based on the given path.
+     * @param path - The path of the mask to get
+     * @returns The LayerPathMask for the given path
+     */
+    getPathMask(path: string): LayerPathMask;
+    /**
+     * Sets the active state of a path mask.
+     * If recursive is true, it also sets the active state of all child path masks.
+     * @param path - The path of the mask to modify
+     * @param active - The active state to set
+     * @param withChildren - Whether to apply the active state recursively to child paths
+     */
+    setPathMaskActive(path: string, active: boolean, withChildren?: boolean): void;
+}

package/types/animation/LayerPathMask.d.ts

@@ -0,0 +1,16 @@
+/**
+ * LayerPathMask represents a mask for a specific entity in an animation layer.
+ * It is used to control the animation whether to be applied to the entity or not.
+ */
+export declare class LayerPathMask {
+    /**
+     * It identifies a particular entity in the hierarchy.
+     * Example: "arm/left/hand" could be a path to the left hand of a character.
+     */
+    path: string;
+    /**
+     * The active property is indicating whether the animation at this path is active or not.
+     * When true, the animation for this path is applied; when false, the animation for this path is ignored.
+     */
+    active: boolean;
+}

package/types/animation/animationCurve/AnimationStringCurve.d.ts

@@ -0,0 +1,7 @@
+import { AnimationCurve } from "./AnimationCurve";
+/**
+ * Store a collection of Keyframes that can be evaluated over time.
+ */
+export declare class AnimationStringCurve extends AnimationCurve<string> {
+    constructor();
+}

package/types/asset/AssetPromise.d.ts

@@ -13,6 +13,7 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     get [Symbol.toStringTag](): string;
     private _promise;
     private _state;
+    private _progress;
     private _onProgressCallback;
     private _onCancelHandler;
     private _reject;

package/types/asset/ResourceManager.d.ts

@@ -104,7 +104,6 @@ export declare class ResourceManager {
     private _gc;
     private _getResolveResource;
     private _parseURL;
-    private _getParameterByName;
     private _parseQueryPath;
 }
 /**

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -9,11 +9,11 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private static _jointCountProperty;
     private static _jointSamplerProperty;
     private static _jointMatrixProperty;
+    private _localBounds;
     private _jointDataCreateCache;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
     private _rootBone;
-    private _localBounds;
     private _jointMatrices;
     private _jointTexture;
     private _bones;

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

@@ -13,7 +13,6 @@ export declare class EmissionModule extends ParticleGeneratorModule {
     /** The shape of the emitter. */
     shape: BaseShape;
     private _bursts;
-    private _frameRateTime;
     private _currentBurstIndex;
     private _burstRand;
     /**

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

@@ -54,7 +54,6 @@ export declare class MainModule implements ICustomClone {
     scalingMode: ParticleScaleMode;
     /** If set to true, the Particle Generator automatically begins to play on startup. */
     playOnEnabled: boolean;
-    private _maxParticles;
     private _generator;
     private _gravity;
     /**

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

@@ -63,32 +63,52 @@ export declare class ParticleGradient {
     setKeys(colorKeys: GradientColorKey[], alphaKeys: GradientAlphaKey[]): void;
     private _addKey;
     private _removeKey;
+    private _setColorTypeArrayDirty;
+    private _setAlphaTypeArrayDirty;
 }
 /**
  * The color key of the particle gradient.
  */
 export declare class GradientColorKey {
-    /** The key time. */
-    time: number;
-    /** The key color. */
-    color: Color;
-    constructor(
-    /** The key time. */
-    time: number, 
-    /** The key color. */
-    color: Color);
+    private _time;
+    private _color;
+    /**
+     * The key time.
+     */
+    get time(): number;
+    set time(value: number);
+    /**
+     * The key color.
+     */
+    get color(): Color;
+    set color(value: Color);
+    /**
+     * Constructor of GradientColorKey.
+     * @param time - The time of the gradient colorKey
+     * @param color - The alpha component of the gradient colorKey
+     */
+    constructor(time: number, color: Color);
 }
 /**
  * The alpha key of the particle gradient.
  */
 export declare class GradientAlphaKey {
-    /** The key time. */
-    time: number;
-    /** The key alpha. */
-    alpha: number;
-    constructor(
-    /** The key time. */
-    time: number, 
-    /** The key alpha. */
-    alpha: number);
+    private _time;
+    private _alpha;
+    /**
+     * The key time.
+     */
+    get time(): number;
+    set time(value: number);
+    /**
+     * The key alpha.
+     */
+    get alpha(): number;
+    set alpha(value: number);
+    /**
+     * Constructor of GradientAlphaKey.
+     * @param time - The time of the gradient alpha key
+     * @param alpha - The alpha component of the gradient alpha key
+     */
+    constructor(time: number, alpha: number);
 }

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;
     /**
@@ -19,7 +20,7 @@ export declare class Shader {
      * // Import shaderLab
      * import { ShaderLab } from "@galacean/engine-shader-lab";
      * // Create engine with shaderLab
-     * const engine = await WebGLEngine.create({ canvas: "canvas", new ShaderLab() });
+     * const engine = await WebGLEngine.create({ canvas: "canvas", shader: new ShaderLab() });
      * ...
      * ```
      *
@@ -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/xr/XRManager.d.ts

@@ -0,0 +1,5 @@
+/**
+ * XRManager located in the main package, its implementation logic is XRManagerExtended in the sub-package engine-xr.
+ */
+export declare class XRManager {
+}

package/types/2d/enums/SpriteDirtyFlag.d.ts

@@ -1,13 +0,0 @@
-/**
- * Sprite Property Dirty Flag.
- */
-export declare enum SpritePropertyDirtyFlag {
-    texture = 1,
-    size = 2,
-    atlasRotate = 4,
-    atlasRegion = 8,
-    atlasRegionOffset = 16,
-    region = 32,
-    pivot = 64,
-    border = 128
-}

package/types/ListenerUpdateFlag.d.ts

@@ -1,12 +0,0 @@
-import { UpdateFlag } from "./UpdateFlag";
-/**
- * Used to update tags.
- */
-export declare class ListenerUpdateFlag extends UpdateFlag {
-    /** Listener. */
-    listener: Function;
-    /**
-     * @inheritdoc
-     */
-    dispatch(param?: Object): void;
-}

package/types/animation/AnimatorStateTransition.d.ts

@@ -1,12 +0,0 @@
-import { AnimatorTransitionBase } from "./AnimatorTransitionBase";
-/**
- * Transitions define when and how the state machine switch from one state to another. AnimatorStateTransition always originate from an Animator State and have timing parameters.
- */
-export declare class AnimatorStateTransition extends AnimatorTransitionBase {
-    /** The duration of the transition. This is represented in normalized time. */
-    duration: number;
-    /** The time at which the destination state will start. This is represented in normalized time. */
-    offset: number;
-    /** ExitTime represents the exact time at which the transition can take effect. This is represented in normalized time. */
-    exitTime: number;
-}

package/types/animation/AnimatorTransitionBase.d.ts

@@ -1,10 +0,0 @@
-import { AnimatorStateMachine } from "./AnimatorStateMachine";
-import { AnimatorState } from "./AnimatorState";
-/**
- * Base class for animator transitions. Transitions define when and how the state machine switches from one state to another.
- */
-export declare class AnimatorTransitionBase {
-    /** The destination state of the transition. */
-    destinationState?: AnimatorState;
-    destinationStateMachine?: AnimatorStateMachine;
-}

package/types/animation/enums/StateMachineState.d.ts

@@ -1,13 +0,0 @@
-/**
- * StateMachine state.
- */
-export declare enum StateMachineState {
-    /** Standby state. */
-    Standby = 0,
-    /** Playing state. */
-    Playing = 1,
-    /** CrossFading state. */
-    CrossFading = 2,
-    /** FixedCrossFading state. */
-    FixedCrossFading = 3
-}

package/types/animation/internal/AnimatorPlayableObject.d.ts

@@ -1,23 +0,0 @@
-import { AnimatorStateTransition } from "../AnimatorTransition";
-export declare class AnimatorPlayableObject {
-    private _transitions;
-    /**
-     * The transitions that are going out of the object.
-     */
-    get transitions(): Readonly<AnimatorStateTransition[]>;
-    /**
-     * Add an outgoing transition to the destination object.
-     * @param transition - The transition
-     */
-    addTransition(transition: AnimatorStateTransition): void;
-    /**
-     * Remove a transition from the object.
-     * @param transition - The transition
-     */
-    removeTransition(transition: AnimatorStateTransition): void;
-    /**
-     * Clears all transitions from the object.
-     */
-    clearTransitions(): void;
-    getDuration(): void;
-}

package/types/animation/internal/AnimatorStateInfo.d.ts

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

package/types/animation/internal/AnimatorStateMachineData.d.ts

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

package/types/animation/internal/CrossCurveData.d.ts

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

package/types/fog/EXP2Fog.d.ts

@@ -1,15 +0,0 @@
-import { Entity } from "../Entity";
-import { Fog } from "./Fog";
-/**
- * Exponential fog.
- */
-export declare class EXP2Fog extends Fog {
-    private static _densityProperty;
-    /**
-     * Density of fog.
-     */
-    get density(): number;
-    set density(value: number);
-    private _density;
-    constructor(entity: Entity);
-}

package/types/fog/Fog.d.ts

@@ -1,14 +0,0 @@
-import { Color } from "@oasis-engine/math";
-import { Component } from "../Component";
-/**
- * Fog.
- */
-export declare class Fog extends Component {
-    protected static _colorProperty: import("..").ShaderProperty;
-    /**
-     * Fog color.
-     */
-    get color(): Color;
-    set color(value: Color);
-    private _color;
-}

package/types/fog/LinearFog.d.ts

@@ -1,22 +0,0 @@
-import { Entity } from "../Entity";
-import { Fog } from "./Fog";
-/**
- * Linear fog, according to the distance of the camera linear difference fog density.
- */
-export declare class LinearFog extends Fog {
-    private static _nearProperty;
-    private static _farProperty;
-    /**
-     * Start of fog.
-     */
-    get near(): number;
-    set near(value: number);
-    /**
-     * End of fog.
-     */
-    get far(): number;
-    set far(value: number);
-    private _near;
-    private _far;
-    constructor(entity: Entity);
-}

package/types/fog/index.d.ts

@@ -1,3 +0,0 @@
-export { EXP2Fog } from "./EXP2Fog";
-export { Fog } from "./Fog";
-export { LinearFog } from "./LinearFog";

package/types/shadow/enum/ShadowMode.d.ts

@@ -1,13 +0,0 @@
-/**
- * Determines which type of shadows should be used.
- */
-export declare enum ShadowMode {
-    /** Disable Shadows. */
-    None = 0,
-    /** Hard Shadows Only. */
-    Hard = 1,
-    /** Cast "soft" shadows with low range. */
-    SoftLow = 2,
-    /** Cast "soft" shadows with large range. */
-    SoftHigh = 3
-}