@galacean/engine-core 1.2.0-beta.3 → 1.2.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.2.0-beta.3",
+  "version": "1.2.0-beta.5",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.2.0-beta.3"
+    "@galacean/engine-math": "1.2.0-beta.5"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.2.0-beta.3"
+    "@galacean/engine-design": "1.2.0-beta.5"
   },
   "scripts": {
     "b:types": "tsc"

package/types/Deprecated.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @deprecated Please use `PixelFormat` instead.
+ * Defines various pixel formats.
+ */
+export declare enum TextureFormat {
+    /** RGB format, 8 bits per channel. */
+    R8G8B8 = 0,
+    /** RGBA format, 8 bits per channel. */
+    R8G8B8A8 = 1,
+    /** RGBA format, 4 bits per channel. */
+    R4G4B4A4 = 2,
+    /** RGBA format, 5 bits in R channel, 5 bits in G channel, 5 bits in B channel, 1 bit in A channel. */
+    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. */
+    R32G32B32A32 = 8,
+    /** RGB compressed format, 4 bits per pixel. */
+    BC1 = 9,
+    /** RGBA compressed format, 8 bits per pixel. */
+    BC3 = 10,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    BC7 = 11,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC1_RGB = 12,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC2_RGB = 13,
+    /** RGBA compressed format, 5 bits per pixel, 4 bit in RGB, 1 bit in A. */
+    ETC2_RGBA5 = 14,
+    /** RGB compressed format, 8 bits per pixel. */
+    ETC2_RGBA8 = 15,
+    /** RGB compressed format, 2 bits per pixel. */
+    PVRTC_RGB2 = 16,
+    /** RGBA compressed format, 2 bits per pixel. */
+    PVRTC_RGBA2 = 17,
+    /** RGB compressed format, 4 bits per pixel. */
+    PVRTC_RGB4 = 18,
+    /** RGBA compressed format, 4 bits per pixel. */
+    PVRTC_RGBA4 = 19,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    ASTC_4x4 = 20,
+    /** RGB(A) compressed format, 128 bits per 5x5 pixel block. */
+    ASTC_5x5 = 21,
+    /** RGB(A) compressed format, 128 bits per 6x6 pixel block. */
+    ASTC_6x6 = 22,
+    /** RGB(A) compressed format, 128 bits per 8x8 pixel block. */
+    ASTC_8x8 = 23,
+    /** RGB(A) compressed format, 128 bits per 10x10 pixel block. */
+    ASTC_10x10 = 24,
+    /** RGB(A) compressed format, 128 bits per 12x12 pixel block. */
+    ASTC_12x12 = 25,
+    /** Automatic depth format, engine will automatically select the supported precision. */
+    Depth = 26,
+    /** Render to stencil buffer. */
+    Stencil = 27,
+    /** Automatic depth stencil format, engine will automatically select the supported precision. */
+    DepthStencil = 28,
+    /** 16-bit depth format. */
+    Depth16 = 29,
+    /** 24-bit depth format. */
+    Depth24 = 30,
+    /** 32-bit depth format. */
+    Depth32 = 31,
+    /** 16-bit depth + 8-bit stencil format. */
+    Depth24Stencil8 = 32,
+    /** 32-bit depth + 8-bit stencil format. */
+    Depth32Stencil8 = 33,
+    /** @deprecated Use `PixelFormat.BC1` instead. */
+    DXT1 = 9,
+    /** @deprecated Use `PixelFormat.BC3` instead. */
+    DXT5 = 10
+}
+/**
+ * @deprecated Use `PixelFormat` instead.
+ *
+ * Render buffer depth format enumeration.
+ */
+export declare enum RenderBufferDepthFormat {
+    /** Render to depth buffer,engine will automatically select the supported precision. */
+    Depth = 26,
+    /** Render to stencil buffer. */
+    Stencil = 27,
+    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
+    DepthStencil = 28,
+    /** Force 16-bit depth buffer. */
+    Depth16 = 29,
+    /** Force 24-bit depth buffer. */
+    Depth24 = 30,
+    /** Force 32-bit depth buffer. */
+    Depth32 = 31,
+    /** Force 16-bit depth + 8-bit stencil buffer. */
+    Depth24Stencil8 = 32,
+    /** Force 32-bit depth + 8-bit stencil buffer. */
+    Depth32Stencil8 = 33
+}

package/types/Entity.d.ts

@@ -127,7 +127,7 @@ export declare class Entity extends EngineObject {
      */
     clearChildren(): void;
     /**
-     * Clone.
+     * Clone this entity include children and components.
      * @returns Cloned entity
      */
     clone(): Entity;

package/types/RenderPipeline/RenderPass.d.ts

@@ -0,0 +1,55 @@
+import { Color } from "@galacean/engine-math";
+import { Camera } from "../Camera";
+import { CameraClearFlags } from "../enums/CameraClearFlags";
+import { Layer } from "../Layer";
+import { Material } from "../material/Material";
+import { RenderTarget } from "../texture/RenderTarget";
+import { RenderQueue } from "./RenderQueue";
+/**
+ * RenderPass.
+ */
+declare class RenderPass {
+    name: string;
+    enabled: boolean;
+    priority: number;
+    renderTarget: RenderTarget;
+    replaceMaterial: Material;
+    mask: Layer;
+    renderOverride: boolean;
+    clearFlags: CameraClearFlags | undefined;
+    clearColor: Color | undefined;
+    /**
+     * Create a RenderPass.
+     * @param name - Pass name
+     * @param priority - Priority, less than 0 before the default pass, greater than 0 after the default pass
+     * @param renderTarget - The specified Render Target
+     * @param replaceMaterial - Replaced material
+     * @param mask - Perform bit and operations with Entity.Layer to filter the objects that this Pass needs to render
+     */
+    constructor(name?: string, priority?: number, renderTarget?: any, replaceMaterial?: any, mask?: any);
+    /**
+     * Rendering callback, will be executed if renderOverride is set to true.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    render(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+    /**
+     * Post rendering callback.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    preRender(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+    /**
+     * Post rendering callback.
+     * @param camera - Camera
+     * @param opaqueQueue - Opaque queue
+     * @param alphaTestQueue - Alpha test queue
+     * @param transparentQueue - Transparent queue
+     */
+    postRender(camera: Camera, opaqueQueue: RenderQueue, alphaTestQueue: RenderQueue, transparentQueue: RenderQueue): void;
+}
+export { RenderPass };

package/types/RenderPipeline/batcher/MeshBuffer.d.ts

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

package/types/clone/ComponentCloner.d.ts

@@ -13,5 +13,5 @@ export declare class ComponentCloner {
      * @param source - Clone source
      * @param target - Clone target
      */
-    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity): void;
+    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity, deepInstanceMap: Map<Object, Object>): void;
 }

package/types/mesh/Skin.d.ts

@@ -1,19 +1,35 @@
 import { Matrix } from "@galacean/engine-math";
-import { EngineObject } from "../base/EngineObject";
 import { Entity } from "../Entity";
+import { EngineObject } from "../base/EngineObject";
+import { IComponentCustomClone } from "../clone/ComponentCloner";
 /**
- * Mesh skin data, equal glTF skins define
+ * Skin used for skinned mesh renderer.
  */
-export declare class Skin extends EngineObject {
+export declare class Skin extends EngineObject implements IComponentCustomClone {
     name: string;
+    /** Inverse bind matrices. */
     inverseBindMatrices: Matrix[];
-    joints: string[];
-    skeleton: string;
-    _rootBone: Entity;
-    _bones: Entity[];
+    private _rootBone;
+    private _bones;
+    private _updateMark;
     /**
-     * Constructor of skin
-     * @param name - name
+     * Root bone.
      */
+    get rootBone(): Entity;
+    set rootBone(value: Entity);
+    /**
+     * Bones of the skin.
+     */
+    get bones(): ReadonlyArray<Entity>;
+    set bones(value: ReadonlyArray<Entity>);
     constructor(name: string);
+    /** @deprecated Please use `bones` instead. */
+    joints: string[];
+    /** @deprecated Please use `rootBone` instead. */
+    get skeleton(): string;
+    set skeleton(value: string);
+}
+export declare enum SkinUpdateFlag {
+    BoneCountChanged = 0,
+    RootBoneChanged = 1
 }

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -14,10 +14,13 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private _jointDataCreateCache;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
-    private _rootBone;
-    private _jointMatrices;
     private _jointTexture;
-    private _bones;
+    private _skin;
+    /**
+     * Skin of the SkinnedMeshRenderer.
+     */
+    get skin(): Skin;
+    set skin(value: Skin);
     /**
      * The weights of the BlendShapes.
      * @remarks Array index is BlendShape index.
@@ -29,31 +32,19 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get localBounds(): BoundingBox;
     set localBounds(value: BoundingBox);
+    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
+    private _checkBlendShapeWeightLength;
+    private _onLocalBoundsChanged;
+    private _onSkinUpdated;
+    private _applySkin;
     /**
-     * Root bone.
+     * @deprecated use {@link SkinnedMeshRenderer.skin.rootBone} instead.
      */
     get rootBone(): Entity;
     set rootBone(value: Entity);
     /**
-     * Bones of the SkinnedMeshRenderer.
+     * @deprecated use {@link SkinnedMeshRenderer.skin.bones} instead.
      */
-    get bones(): ReadonlyArray<Entity>;
-    set bones(value: ReadonlyArray<Entity>);
-    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
-    private _checkBlendShapeWeightLength;
-    private _onLocalBoundsChanged;
-    private _getEntityHierarchyPath;
-    private _skin;
-    /**
-     * @deprecated
-     * Skin Object.
-     *
-     * If you want get `skeleton`, use {@link SkinnedMeshRenderer.rootBone} instead.
-     * If you want get `bones`, use {@link SkinnedMeshRenderer.bones} instead.
-     * `inverseBindMatrices` will migrate to mesh in the future.
-     *
-     * @remarks `rootBone` and `bones` will not update when `skin` changed.
-     */
-    get skin(): Skin;
-    set skin(value: Skin);
+    get bones(): Readonly<Entity[]>;
+    set bones(value: Readonly<Entity[]>);
 }

package/types/renderingHardwareInterface/IHardwareRenderer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Hardware graphics API renderer.
+ */
+export interface IHardwareRenderer {
+    [key: string]: any;
+}

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

@@ -0,0 +1,73 @@
+/**
+ * Defines various pixel formats.
+ */
+export declare enum PixelFormat {
+    /** RGB format, 8 bits per channel. */
+    R8G8B8 = 0,
+    /** RGBA format, 8 bits per channel. */
+    R8G8B8A8 = 1,
+    /** RGBA format, 4 bits per channel. */
+    R4G4B4A4 = 2,
+    /** RGBA format, 5 bits in R channel, 5 bits in G channel, 5 bits in B channel, 1 bit in A channel. */
+    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. */
+    R32G32B32A32 = 8,
+    /** RGB compressed format, 4 bits per pixel. */
+    BC1 = 9,
+    /** RGBA compressed format, 8 bits per pixel. */
+    BC3 = 10,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    BC7 = 11,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC1_RGB = 12,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC2_RGB = 13,
+    /** RGBA compressed format, 5 bits per pixel, 4 bit in RGB, 1 bit in A. */
+    ETC2_RGBA5 = 14,
+    /** RGB compressed format, 8 bits per pixel. */
+    ETC2_RGBA8 = 15,
+    /** RGB compressed format, 2 bits per pixel. */
+    PVRTC_RGB2 = 16,
+    /** RGBA compressed format, 2 bits per pixel. */
+    PVRTC_RGBA2 = 17,
+    /** RGB compressed format, 4 bits per pixel. */
+    PVRTC_RGB4 = 18,
+    /** RGBA compressed format, 4 bits per pixel. */
+    PVRTC_RGBA4 = 19,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    ASTC_4x4 = 20,
+    /** RGB(A) compressed format, 128 bits per 5x5 pixel block. */
+    ASTC_5x5 = 21,
+    /** RGB(A) compressed format, 128 bits per 6x6 pixel block. */
+    ASTC_6x6 = 22,
+    /** RGB(A) compressed format, 128 bits per 8x8 pixel block. */
+    ASTC_8x8 = 23,
+    /** RGB(A) compressed format, 128 bits per 10x10 pixel block. */
+    ASTC_10x10 = 24,
+    /** RGB(A) compressed format, 128 bits per 12x12 pixel block. */
+    ASTC_12x12 = 25,
+    /** Automatic depth format, engine will automatically select the supported precision. */
+    Depth = 26,
+    /** Render to stencil buffer. */
+    Stencil = 27,
+    /** Automatic depth stencil format, engine will automatically select the supported precision. */
+    DepthStencil = 28,
+    /** 16-bit depth format. */
+    Depth16 = 29,
+    /** 24-bit depth format. */
+    Depth24 = 30,
+    /** 32-bit depth format. */
+    Depth32 = 31,
+    /** 16-bit depth + 8-bit stencil format. */
+    Depth24Stencil8 = 32,
+    /** 32-bit depth + 8-bit stencil format. */
+    Depth32Stencil8 = 33
+}