@galacean/engine-core 1.4.15 → 1.5.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.4.15",
+  "version": "1.5.0-alpha.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -18,10 +18,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.4.15"
+    "@galacean/engine-math": "1.5.0-alpha.0"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.4.15"
+    "@galacean/engine-design": "1.5.0-alpha.0"
   },
   "scripts": {
     "b:types": "tsc"

package/types/Background.d.ts

@@ -15,18 +15,20 @@ export declare class Background {
      * @remarks If using `BackgroundMode.Sky` mode and material or mesh of the `sky` is not defined, it will downgrade to `BackgroundMode.SolidColor`.
      */
     mode: BackgroundMode;
-    /**
-     * Background solid color.
-     * @defaultValue `new Color(0.25, 0.25, 0.25, 1.0)`
-     * @remarks When `mode` is `BackgroundMode.SolidColor`, the property will take effects.
-     */
-    solidColor: Color;
     /**
      * Background sky.
      * @remarks When `mode` is `BackgroundMode.Sky`, the property will take effects.
      */
     readonly sky: Sky;
+    private _solidColor;
     private _texture;
+    /**
+     * Background solid color.
+     * @defaultValue `new Color(0.25, 0.25, 0.25, 1.0)`
+     * @remarks When `mode` is `BackgroundMode.SolidColor`, the property will take effects.
+     */
+    get solidColor(): Color;
+    set solidColor(value: Color);
     /**
      * Background texture.
      * @remarks When `mode` is `BackgroundMode.Texture`, the property will take effects.

package/types/Camera.d.ts

@@ -1,6 +1,7 @@
 import { Matrix, Ray, Rect, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { Layer } from "./Layer";
+import { AntiAliasing } from "./enums/AntiAliasing";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
 import { DepthTextureMode } from "./enums/DepthTextureMode";
 import { Downsampling } from "./enums/Downsampling";
@@ -57,6 +58,11 @@ export declare class Camera extends Component {
      * @remarks It will take effect when `independentCanvasEnabled` property is `true`, otherwise it will be invalid.
      */
     msaaSamples: MSAASamples;
+    /**
+     * Anti-aliasing mode.
+     * @defaultValue `AntiAliasing.None`
+     */
+    antiAliasing: AntiAliasing;
     private _priority;
     private _shaderData;
     private _isCustomViewMatrix;

package/types/Engine.d.ts

@@ -5,7 +5,6 @@ import { Entity } from "./Entity";
 import { SceneManager } from "./SceneManager";
 import { ResourceManager } from "./asset/ResourceManager";
 import { EventDispatcher, Time } from "./base";
-import { ColorSpace } from "./enums/ColorSpace";
 import { InputManager } from "./input";
 import { ParticleBufferUtils } from "./particle/ParticleBufferUtils";
 import { PhysicsScene } from "./physics/PhysicsScene";
@@ -146,8 +145,6 @@ export interface EngineConfiguration {
     physics?: IPhysics;
     /** XR Device. */
     xrDevice?: IXRDevice;
-    /** Color space. */
-    colorSpace?: ColorSpace;
     /** Shader lab. */
     shaderLab?: IShaderLab;
     /** Input options. */

package/types/EngineSettings.d.ts

@@ -1,8 +1,5 @@
-import { ColorSpace } from "./enums/ColorSpace";
 /**
  * Render settings.
  */
 export interface EngineSettings {
-    /** Color space.*/
-    colorSpace?: ColorSpace;
 }

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -13,10 +13,10 @@ export declare class BasicRenderPipeline {
     private _cascadedShadowCasterPass;
     private _depthOnlyPass;
     private _opaqueTexturePass;
-    private _grabTexture;
+    private _finalPass;
+    private _copyBackgroundTexture;
     private _canUseBlitFrameBuffer;
-    private _shouldGrabColor;
-    private _sourceScaleOffset;
+    private _shouldCopyBackgroundColor;
     /**
      * Create a basic render pipeline.
      * @param camera - Camera

package/types/RenderPipeline/Blitter.d.ts

@@ -22,7 +22,7 @@ export declare class Blitter {
      * @param viewport - Viewport
      * @param material - The material to use when blit
      * @param passIndex - Pass index to use of the provided material
-     * @param flipYOfSource - Whether flip Y axis of source texture
+     * @param sourceScaleOffset - Source scale and offset
      */
     static blitTexture(engine: Engine, source: Texture2D, destination: RenderTarget | null, mipLevel?: number, viewport?: Vector4, material?: Material, passIndex?: number, sourceScaleOffset?: Vector4): void;
 }

package/types/SystemInfo.d.ts

@@ -1,6 +1,8 @@
+import { Engine } from "./Engine";
 import { Platform } from "./Platform";
+import { TextureFormat } from "./texture";
 /**
- * System info.
+ * Access operating system, platform and hardware information.
  */
 export declare class SystemInfo {
     /** The platform is running on. */
@@ -13,4 +15,10 @@ export declare class SystemInfo {
      * The pixel ratio of the device.
      */
     static get devicePixelRatio(): number;
+    /**
+     * Checks whether the system supports the given texture format.
+     * @param format - The texture format
+     * @returns Whether support the texture format
+     */
+    static supportsTextureFormat(engine: Engine, format: TextureFormat): boolean;
 }

package/types/base/Constant.d.ts

@@ -107,7 +107,9 @@ export declare enum GLCapabilityType {
     pvrtc_webkit = "WEBKIT_WEBGL_compressed_texture_pvrtc",
     s3tc = "WEBGL_compressed_texture_s3tc",
     s3tc_webkit = "WEBKIT_WEBGL_compressed_texture_s3tc",
+    s3tc_srgb = "WEBGL_compressed_texture_s3tc_srgb",
     bptc = "EXT_texture_compression_bptc",
-    WEBGL_lose_context = "WEBGL_lose_context"
+    WEBGL_lose_context = "WEBGL_lose_context",
+    sRGB = "EXT_sRGB"
 }
 export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;

package/types/enums/AntiAliasing.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The anti-aliasing mode.
+ */
+export declare enum AntiAliasing {
+    None = 0,
+    FXAA = 1
+}

package/types/index.d.ts

@@ -37,7 +37,6 @@ 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";
@@ -65,3 +64,4 @@ export * from "./Utils";
 export * from "./audio/index";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 export * from "./postProcess";
+export { AntiAliasing } from "./enums/AntiAliasing";

package/types/particle/ParticleGenerator.d.ts

@@ -6,6 +6,7 @@ import { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule
 import { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
 import { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
 import { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
+import { ForceOverLifetimeModule } from "./modules/ForceOverLifetimeModule";
 /**
  * Particle Generator.
  */
@@ -28,6 +29,8 @@ export declare class ParticleGenerator {
     readonly emission: EmissionModule;
     /** Velocity over lifetime module. */
     readonly velocityOverLifetime: VelocityOverLifetimeModule;
+    /** Force over lifetime module. */
+    readonly forceOverLifetime: ForceOverLifetimeModule;
     /** Size over lifetime module. */
     readonly sizeOverLifetime: SizeOverLifetimeModule;
     /** Rotation over lifetime module. */

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

@@ -0,0 +1,51 @@
+import { ShaderMacro, ShaderProperty } from "../../shader";
+import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
+import { ParticleGenerator } from "../ParticleGenerator";
+import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
+import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
+/**
+ * Force over lifetime module.
+ */
+export declare class ForceOverLifetimeModule extends ParticleGeneratorModule {
+    static readonly _constantModeMacro: ShaderMacro;
+    static readonly _curveModeMacro: ShaderMacro;
+    static readonly _isRandomMacro: ShaderMacro;
+    static readonly _minConstantProperty: ShaderProperty;
+    static readonly _maxConstantProperty: ShaderProperty;
+    static readonly _minGradientXProperty: ShaderProperty;
+    static readonly _minGradientYProperty: ShaderProperty;
+    static readonly _minGradientZProperty: ShaderProperty;
+    static readonly _maxGradientXProperty: ShaderProperty;
+    static readonly _maxGradientYProperty: ShaderProperty;
+    static readonly _maxGradientZProperty: ShaderProperty;
+    static readonly _spaceProperty: ShaderProperty;
+    private _forceMinConstant;
+    private _forceMaxConstant;
+    private _forceMacro;
+    private _randomModeMacro;
+    private _forceX;
+    private _forceY;
+    private _forceZ;
+    private _space;
+    /**
+     * Force over lifetime for x axis.
+     */
+    get forceX(): ParticleCompositeCurve;
+    set forceX(value: ParticleCompositeCurve);
+    /**
+     * Force over lifetime for y axis.
+     */
+    get forceY(): ParticleCompositeCurve;
+    set forceY(value: ParticleCompositeCurve);
+    /**
+     * Force over lifetime for z axis.
+     */
+    get forceZ(): ParticleCompositeCurve;
+    set forceZ(value: ParticleCompositeCurve);
+    /**
+     * Force space.
+     */
+    get space(): ParticleSimulationSpace;
+    set space(value: ParticleSimulationSpace);
+    constructor(generator: ParticleGenerator);
+}

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

@@ -1,5 +1,6 @@
 import { ShaderData, ShaderMacro } from "../../shader";
 import { ParticleGenerator } from "../ParticleGenerator";
+import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
 /**
  * Particle generator module.
  */
@@ -12,4 +13,5 @@ export declare abstract class ParticleGeneratorModule {
     get enabled(): boolean;
     set enabled(value: boolean);
     protected _enableMacro(shaderData: ShaderData, lastEnableMacro: ShaderMacro, enableMacro: ShaderMacro): ShaderMacro;
+    protected _onCompositeCurveChange(lastValue: ParticleCompositeCurve, value: ParticleCompositeCurve): void;
 }

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

@@ -49,5 +49,4 @@ export declare class SizeOverLifetimeModule extends ParticleGeneratorModule {
     get size(): ParticleCompositeCurve;
     set size(value: ParticleCompositeCurve);
     constructor(generator: ParticleGenerator);
-    private _onCompositeCurveChange;
 }

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

@@ -1,17 +1,16 @@
 import { ShaderMacro } from "../../shader";
 import { ShaderProperty } from "../../shader/ShaderProperty";
 import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
+import { ParticleGenerator } from "../ParticleGenerator";
 import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
 import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
-import { ParticleGenerator } from "../ParticleGenerator";
 /**
  * Velocity over lifetime module.
  */
 export declare class VelocityOverLifetimeModule extends ParticleGeneratorModule {
-    static readonly _constantMacro: ShaderMacro;
-    static readonly _curveMacro: ShaderMacro;
-    static readonly _randomConstantMacro: ShaderMacro;
-    static readonly _randomCurveMacro: ShaderMacro;
+    static readonly _constantModeMacro: ShaderMacro;
+    static readonly _curveModeMacro: ShaderMacro;
+    static readonly _isRandomMacro: ShaderMacro;
     static readonly _minConstantProperty: ShaderProperty;
     static readonly _maxConstantProperty: ShaderProperty;
     static readonly _minGradientXProperty: ShaderProperty;
@@ -24,6 +23,7 @@ export declare class VelocityOverLifetimeModule extends ParticleGeneratorModule
     private _velocityMinConstant;
     private _velocityMaxConstant;
     private _velocityMacro;
+    private _randomModeMacro;
     private _velocityX;
     private _velocityY;
     private _velocityZ;
@@ -51,5 +51,4 @@ export declare class VelocityOverLifetimeModule extends ParticleGeneratorModule
     get enabled(): boolean;
     set enabled(value: boolean);
     constructor(generator: ParticleGenerator);
-    private _onCompositeCurveChange;
 }

package/types/particle/modules/shape/MeshShape.d.ts

@@ -0,0 +1,21 @@
+import { ModelMesh } from "../../../mesh";
+import { BaseShape } from "./BaseShape";
+import { ParticleShapeType } from "./enums/ParticleShapeType";
+/**
+ * Particle shape that emits particles from a mesh.
+ */
+export declare class MeshShape extends BaseShape {
+    readonly shapeType = ParticleShapeType.Mesh;
+    private _mesh;
+    private _positionBuffer;
+    private _normalBuffer;
+    private _positionElementInfo;
+    private _normalElementInfo;
+    /**
+     * Mesh to emit particles from.
+     */
+    get mesh(): ModelMesh;
+    set mesh(value: ModelMesh);
+    private _getAttributeBuffer;
+    private _onMeshChanged;
+}

package/types/particle/modules/shape/enums/ParticleShapeType.d.ts

@@ -11,5 +11,7 @@ export declare enum ParticleShapeType {
     /** Emit from a half-sphere. */
     Hemisphere = 3,
     /** Emit from a sphere. */
-    Sphere = 4
+    Sphere = 4,
+    /** Emit from a mesh. */
+    Mesh = 5
 }

package/types/particle/modules/shape/index.d.ts

@@ -1,7 +1,8 @@
 export { BoxShape } from "./BoxShape";
 export { CircleShape } from "./CircleShape";
-export { ConeShape, ConeEmitType } from "./ConeShape";
-export { HemisphereShape } from "./HemisphereShape";
-export { SphereShape } from "./SphereShape";
+export { ConeEmitType, ConeShape } from "./ConeShape";
 export { ParticleShapeArcMode } from "./enums/ParticleShapeArcMode";
 export { ParticleShapeType } from "./enums/ParticleShapeType";
+export { HemisphereShape } from "./HemisphereShape";
+export { MeshShape } from "./MeshShape";
+export { SphereShape } from "./SphereShape";

package/types/postProcess/FinalPass.d.ts

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

package/types/postProcess/PostProcessManager.d.ts

@@ -16,6 +16,7 @@ export declare class PostProcessManager {
     private _blendEffectMap;
     private _defaultEffectMap;
     private _remainActivePassCount;
+    private _outputRenderTarget;
     /**
      * Create a PostProcessManager.
      * @param scene - Scene to which the current PostProcessManager belongs

package/types/postProcess/index.d.ts

@@ -5,3 +5,4 @@ export { PostProcessEffectBoolParameter, PostProcessEffectColorParameter, PostPr
 export { PostProcessManager } from "./PostProcessManager";
 export { PostProcessPass, PostProcessPassEvent } from "./PostProcessPass";
 export { PostProcessUberPass } from "./PostProcessUberPass";
+export { FinalPass } from "./FinalPass";

package/types/shaderlib/ShaderLib.d.ts

@@ -5,6 +5,7 @@ export declare const ShaderLib: {
     size_over_lifetime_module: string;
     color_over_lifetime_module: string;
     texture_sheet_animation_module: string;
+    force_over_lifetime_module: string;
     sphere_billboard: string;
     stretched_billboard: string;
     vertical_billboard: string;

package/types/shaderlib/particle/index.d.ts

@@ -5,6 +5,7 @@ declare const _default: {
     size_over_lifetime_module: string;
     color_over_lifetime_module: string;
     texture_sheet_animation_module: string;
+    force_over_lifetime_module: string;
     sphere_billboard: string;
     stretched_billboard: string;
     vertical_billboard: string;

package/types/texture/Texture.d.ts

@@ -1,4 +1,5 @@
 import { GraphicsResource } from "../asset/GraphicsResource";
+import { Engine } from "../Engine";
 import { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
 import { TextureFilterMode } from "./enums/TextureFilterMode";
 import { TextureFormat } from "./enums/TextureFormat";
@@ -14,12 +15,17 @@ export declare abstract class Texture extends GraphicsResource {
     protected _height: number;
     protected _usage: TextureUsage;
     protected _mipmapCount: number;
+    protected _isSRGBColorSpace: boolean;
     private _wrapModeU;
     private _wrapModeV;
     private _filterMode;
     private _anisoLevel;
     private _depthCompareFunction;
     private _useDepthCompareMode;
+    /**
+     * Whether the texture data is in sRGB color space, otherwise is linear color space.
+     */
+    get isSRGBColorSpace(): boolean;
     /**
      * Texture format.
      */
@@ -66,6 +72,7 @@ export declare abstract class Texture extends GraphicsResource {
      */
     get depthCompareFunction(): TextureDepthCompareFunction;
     set depthCompareFunction(value: TextureDepthCompareFunction);
+    constructor(engine: Engine, width: number, height: number, format: TextureFormat, mipmap: boolean, isSRGBColorSpace: boolean);
     /**
      * Generate multi-level textures based on the 0th level data.
      */

package/types/texture/Texture2D.d.ts

@@ -11,11 +11,12 @@ export declare class Texture2D extends Texture {
      * @param engine - Define the engine to use to render this texture
      * @param width - Texture width
      * @param height - Texture height
-     * @param format - Texture format. default  `TextureFormat.R8G8B8A8`
+     * @param format - Texture format. default `TextureFormat.R8G8B8A8`
      * @param mipmap - Whether to use multi-level texture
+     * @param isSRGBColorSpace - Whether the texture data is in sRGB color space, otherwise is linear color space. @defaultValue `true`
      * @param usage - Texture usage
      */
-    constructor(engine: Engine, width: number, height: number, format?: TextureFormat, mipmap?: boolean, usage?: TextureUsage);
+    constructor(engine: Engine, width: number, height: number, format?: TextureFormat, mipmap?: boolean, isSRGBColorSpace?: boolean, usage?: TextureUsage);
     /**
      * Setting pixels data through color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
      * @remarks If it is the WebGL1.0 platform and the texture format is compressed, the first upload must be filled with textures.

package/types/texture/Texture2DArray.d.ts

@@ -18,8 +18,9 @@ export declare class Texture2DArray extends Texture {
      * @param length - Texture length
      * @param format - Texture format. default `TextureFormat.R8G8B8A8`
      * @param mipmap - Whether to use multi-level texture
+     * @param isSRGBColorSpace - Whether the texture data is in sRGB color space, otherwise is linear color space. @defaultValue `true`
      */
-    constructor(engine: Engine, width: number, height: number, length: number, format?: TextureFormat, mipmap?: boolean);
+    constructor(engine: Engine, width: number, height: number, length: number, format?: TextureFormat, mipmap?: boolean, isSRGBColorSpace?: boolean);
     /**
      * Setting pixels data through color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
      * @remarks If it is the WebGL1.0 platform and the texture format is compressed, the first upload must be filled with textures.

package/types/texture/TextureCube.d.ts

@@ -12,8 +12,9 @@ export declare class TextureCube extends Texture {
      * @param size - Texture size. texture width must be equal to height in cube texture
      * @param format - Texture format,default TextureFormat.R8G8B8A8
      * @param mipmap - Whether to use multi-level texture
+     * @param isSRGBColorSpace - Whether the texture data is in sRGB color space, otherwise is linear color space. @defaultValue `true`
      */
-    constructor(engine: Engine, size: number, format?: TextureFormat, mipmap?: boolean);
+    constructor(engine: Engine, size: number, format?: TextureFormat, mipmap?: boolean, isSRGBColorSpace?: boolean);
     /**
      * Setting pixels data through cube face,color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
      * @remarks When compressed texture is in WebGL1, the texture must be filled first before writing the sub-region

package/types/texture/TextureUtils.d.ts

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

package/types/texture/enums/TextureFormat.d.ts

@@ -12,10 +12,6 @@ export declare enum TextureFormat {
     R5G5B5A1 = 3,
     /** RGB format, 5 bits in R channel, 6 bits in G channel, 5 bits in B channel. */
     R5G6B5 = 4,
-    /** Transparent format, 8 bits. */
-    Alpha8 = 5,
-    /** Luminance/alpha in RGB channel, alpha in A channel. */
-    LuminanceAlpha = 6,
     /** RGBA format, 16 bits per channel. */
     R16G16B16A16 = 7,
     /** RGBA format, 32 bits per channel. */
@@ -24,6 +20,10 @@ export declare enum TextureFormat {
     R32G32B32A32_UInt = 9,
     /** RGB unsigned float format, 11 bits in R channel, 11 bits in G channel, 10 bits in B channel. */
     R11G11B10_UFloat = 35,
+    /** R float format, 8 bits. */
+    R8 = 36,
+    /** RG float format, 8 bits per channel. */
+    R8G8 = 37,
     /** RGB compressed format, 4 bits per pixel. */
     BC1 = 10,
     /** RGBA compressed format, 8 bits per pixel. */
@@ -74,6 +74,10 @@ export declare enum TextureFormat {
     Depth24Stencil8 = 33,
     /** 32-bit depth + 8-bit stencil format. */
     Depth32Stencil8 = 34,
+    /** @deprecated Use 'TextureFormat.R8' instead. */
+    Alpha8 = 5,
+    /** @deprecated Use 'TextureFormat.R8G8' instead. */
+    LuminanceAlpha = 6,
     /** @deprecated Use `TextureFormat.BC1` instead. */
     DXT1 = 10,
     /** @deprecated Use `TextureFormat.BC3` instead. */

package/types/texture/index.d.ts

@@ -10,3 +10,4 @@ export { Texture } from "./Texture";
 export { Texture2D } from "./Texture2D";
 export { Texture2DArray } from "./Texture2DArray";
 export { TextureCube } from "./TextureCube";
+export { TextureUtils } from "./TextureUtils";

package/types/enums/ColorSpace.d.ts

@@ -1,9 +0,0 @@
-/**
- * Color Space.
- */
-export declare enum ColorSpace {
-    /** Linear color space. */
-    Linear = 0,
-    /** Gamma color space. */
-    Gamma = 1
-}