@galacean/engine-core 1.4.0-alpha.2 → 1.4.0-beta.0

package/types/postProcess/PostProcessEffectParameter.d.ts

@@ -1,25 +1,119 @@
 import { Color, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
-import { Texture } from "../texture/Texture";
+import { Texture } from "../texture";
 /**
  * Represents a parameter of a post process effect.
  * @remarks
  * The parameter will be mixed to a final value and be used in post process manager.
  */
-export declare class PostProcessEffectParameter<T extends Number | Boolean | Color | Vector2 | Vector3 | Vector4 | Texture> {
+export declare abstract class PostProcessEffectParameter<T> {
     /**
      * Whether the parameter is enabled.
      */
     enabled: boolean;
-    private _value;
-    private _needLerp;
-    private _min?;
-    private _max?;
+    protected _needLerp: boolean;
+    protected _value: T;
     /**
      * The value of the parameter.
      */
     get value(): T;
     set value(value: T);
-    constructor(value: Exclude<T, number>, needLerp?: boolean);
-    constructor(value: Exclude<T, Boolean | Color | Vector2 | Vector3 | Vector4 | Texture>, needLerp?: boolean);
-    constructor(value: Exclude<T, Boolean | Color | Vector2 | Vector3 | Vector4 | Texture>, min?: number, max?: number, needLerp?: boolean);
+    constructor(value: T, needLerp?: boolean);
+}
+/**
+ * Represents a float parameter of a post process effect.
+ */
+export declare class PostProcessEffectFloatParameter extends PostProcessEffectParameter<number> {
+    readonly min: number;
+    readonly max: number;
+    get value(): number;
+    set value(v: number);
+    /**
+     * Create a new float parameter.
+     * @param value - The default value of the parameter
+     * @param _min - The minimum value of the parameter, default is Number.NEGATIVE_INFINITY
+     * @param _max - The maximum value of the parameter, default is Number.POSITIVE_INFINITY
+     * @param needLerp - Whether the parameter needs to be lerp, default is true
+     */
+    constructor(value: number, min?: number, max?: number, needLerp?: boolean);
+    _lerp(to: number, factor: number): void;
+}
+/**
+ * Represents a boolean parameter of a post process effect.
+ */
+export declare class PostProcessEffectBoolParameter extends PostProcessEffectParameter<boolean> {
+    /**
+     * Create a new boolean parameter.
+     * @param value - The default value of the parameter
+     */
+    constructor(value: boolean);
+}
+/**
+ * Represents a texture parameter of a post process effect.
+ */
+export declare class PostProcessEffectTextureParameter extends PostProcessEffectParameter<Texture> {
+    /**
+     * Create a new texture parameter.
+     * @param value - The default texture of the parameter
+     */
+    constructor(value: Texture);
+}
+/**
+ * Represents a color parameter of a post process effect.
+ */
+export declare class PostProcessEffectColorParameter extends PostProcessEffectParameter<Color> {
+    /**
+     * Create a new color parameter.
+     * @param value - The default color of the parameter
+     * @param needLerp - Whether the parameter needs to be lerp, default is true
+     */
+    constructor(value: Color, needLerp?: boolean);
+    _lerp(to: Color, factor: number): void;
+}
+/**
+ * Represents a vector2 parameter of a post process effect.
+ */
+export declare class PostProcessEffectVector2Parameter extends PostProcessEffectParameter<Vector2> {
+    /**
+     * Create a new vector2 parameter.
+     * @param value - The default vector2 of the parameter
+     * @param needLerp - Whether the parameter needs to be lerp, default is true
+     */
+    constructor(value: Vector2, needLerp?: boolean);
+    _lerp(to: Vector2, factor: number): void;
+}
+/**
+ * Represents a vector3 parameter of a post process effect.
+ */
+export declare class PostProcessEffectVector3Parameter extends PostProcessEffectParameter<Vector3> {
+    /**
+     * Create a new vector3 parameter.
+     * @param value - The default vector3 of the parameter
+     * @param needLerp - Whether the parameter needs to be lerp, default is true
+     */
+    constructor(value: Vector3, needLerp?: boolean);
+    _lerp(to: Vector3, factor: number): void;
+}
+/**
+ * Represents a vector4 parameter of a post process effect.
+ */
+export declare class PostProcessEffectVector4Parameter extends PostProcessEffectParameter<Vector4> {
+    /**
+     * Create a new vector4 parameter.
+     * @param value - The default vector4 of the parameter
+     * @param needLerp - Whether the parameter needs to be lerp, default is true
+     */
+    constructor(value: Vector4, needLerp?: boolean);
+    _lerp(to: Vector4, factor: number): void;
+}
+/**
+ * Represents a enum parameter of a post process effect.
+ */
+export declare class PostProcessEffectEnumParameter<T> extends PostProcessEffectParameter<T> {
+    readonly enumType: Record<string, number | string>;
+    /**
+     * Create a new enum parameter.
+     * @param enumType - The type of the enum
+     * @param value - The default enum value of the parameter
+     */
+    constructor(enumType: Record<string, number | string>, value: T);
 }

package/types/postProcess/effects/BloomEffect.d.ts

@@ -1,7 +1,5 @@
-import { Color } from "@galacean/engine-math";
-import { Texture2D } from "../../texture";
 import { PostProcessEffect } from "../PostProcessEffect";
-import { PostProcessEffectParameter } from "../PostProcessEffectParameter";
+import { PostProcessEffectBoolParameter, PostProcessEffectColorParameter, PostProcessEffectEnumParameter, PostProcessEffectFloatParameter, PostProcessEffectTextureParameter } from "../PostProcessEffectParameter";
 /**
  * This controls the size of the bloom texture.
  */
@@ -17,36 +15,36 @@ export declare class BloomEffect extends PostProcessEffect {
      * Controls whether to use bicubic sampling instead of bilinear sampling for the upSampling passes.
      * @remarks This is slightly more expensive but helps getting smoother visuals.
      */
-    highQualityFiltering: PostProcessEffectParameter<boolean>;
+    highQualityFiltering: PostProcessEffectBoolParameter;
     /**
      * Controls the starting resolution that this effect begins processing.
      */
-    downScale: PostProcessEffectParameter<BloomDownScaleMode>;
+    downScale: PostProcessEffectEnumParameter<BloomDownScaleMode>;
     /**
      * Specifies a Texture to add smudges or dust to the bloom effect.
      */
-    dirtTexture: PostProcessEffectParameter<Texture2D>;
+    dirtTexture: PostProcessEffectTextureParameter;
     /**
      * Set the level of brightness to filter out pixels under this level.
      * @remarks This value is expressed in gamma-space.
      */
-    threshold: PostProcessEffectParameter<number>;
+    threshold: PostProcessEffectFloatParameter;
     /**
      * Controls the radius of the bloom effect.
      */
-    scatter: PostProcessEffectParameter<number>;
+    scatter: PostProcessEffectFloatParameter;
     /**
      * Controls the strength of the bloom effect.
      */
-    intensity: PostProcessEffectParameter<number>;
+    intensity: PostProcessEffectFloatParameter;
     /**
      * Controls the strength of the lens dirt.
      */
-    dirtIntensity: PostProcessEffectParameter<number>;
+    dirtIntensity: PostProcessEffectFloatParameter;
     /**
      * Specifies the tint of the bloom effect.
      */
-    tint: PostProcessEffectParameter<Color>;
+    tint: PostProcessEffectColorParameter;
     /** @inheritdoc */
     isValid(): boolean;
 }

package/types/postProcess/effects/TonemappingEffect.d.ts

@@ -1,5 +1,5 @@
 import { PostProcessEffect } from "../PostProcessEffect";
-import { PostProcessEffectParameter } from "../PostProcessEffectParameter";
+import { PostProcessEffectEnumParameter } from "../PostProcessEffectParameter";
 /**
  * Options to select a tonemapping algorithm to use.
  */
@@ -21,5 +21,5 @@ export declare class TonemappingEffect extends PostProcessEffect {
     /**
      * Use this to select a tonemapping algorithm to use.
      */
-    mode: PostProcessEffectParameter<TonemappingMode>;
+    mode: PostProcessEffectEnumParameter<TonemappingMode>;
 }

package/types/postProcess/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./effects";
 export { PostProcess } from "./PostProcess";
 export { PostProcessEffect } from "./PostProcessEffect";
-export { PostProcessEffectParameter } from "./PostProcessEffectParameter";
+export { PostProcessEffectBoolParameter, PostProcessEffectColorParameter, PostProcessEffectEnumParameter, PostProcessEffectFloatParameter, PostProcessEffectParameter, PostProcessEffectTextureParameter, PostProcessEffectVector2Parameter, PostProcessEffectVector3Parameter, PostProcessEffectVector4Parameter } from "./PostProcessEffectParameter";
 export { PostProcessManager } from "./PostProcessManager";
 export { PostProcessPass, PostProcessPassEvent } from "./PostProcessPass";
 export { PostProcessUberPass } from "./PostProcessUberPass";

package/types/shader/Shader.d.ts

@@ -18,7 +18,7 @@ export declare class Shader implements IReferable {
      * ShaderLab must be enabled first as follows:
      * ```ts
      * // Import shaderLab
-     * import { ShaderLab } from "@galacean/engine-shader-lab";
+     * import { ShaderLab } from "@galacean/engine-shaderlab";
      * // Create engine with shaderLab
      * const engine = await WebGLEngine.create({ canvas: "canvas", shader: new ShaderLab() });
      * ...

package/types/shader/index.d.ts

@@ -5,6 +5,7 @@ export { CompareFunction } from "./enums/CompareFunction";
 export { CullMode } from "./enums/CullMode";
 export { RenderStateElementKey as RenderStateDataKey } from "./enums/RenderStateElementKey";
 export { RenderQueueType } from "./enums/RenderQueueType";
+export { ShaderDataGroup } from "./enums/ShaderDataGroup";
 export { ShaderPropertyType } from "./enums/ShaderPropertyType";
 export { StencilOperation } from "./enums/StencilOperation";
 export { ShaderPlatformTarget } from "./enums/ShaderPlatformTarget";

package/types/ui/IUICanvas.d.ts

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

package/types/ui/UIUtils.d.ts

@@ -0,0 +1,9 @@
+import { Engine } from "../Engine";
+import { DisorderedArray } from "../utils/DisorderedArray";
+import { IUICanvas } from "./IUICanvas";
+export declare class UIUtils {
+    private static _renderQueue;
+    private static _virtualCamera;
+    private static _viewport;
+    static renderOverlay(engine: Engine, uiCanvases: DisorderedArray<IUICanvas>): void;
+}