@galacean/engine-core 1.0.0 → 1.1.0-alpha.1

package/types/clone/ComponentCloner.d.ts

@@ -1,4 +1,5 @@
 import { Component } from "../Component";
+import { Entity } from "../Entity";
 /**
  * Custom clone interface.
  */
@@ -10,5 +11,5 @@ export declare class ComponentCloner {
      * @param source - Clone source
      * @param target - Clone target
      */
-    static cloneComponent(source: Component, target: Component): void;
+    static cloneComponent(source: Component, target: Component, srcRoot: Entity, targetRoot: Entity): void;
 }

package/types/enums/ActiveChangeFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum ActiveChangeFlag {
+    None = 0,
+    Scene = 1,
+    Hierarchy = 2,
+    All = 3
+}

package/types/enums/DepthTextureMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Depth texture mode.
+ */
+export declare enum DepthTextureMode {
+    None = 0,
+    PrePass = 1
+}

package/types/env-probe/CubeProbe.d.ts

@@ -9,15 +9,8 @@ export declare class CubeProbe extends Probe {
      * The position of the probe can be set, the default is the origin [0,0,0].
      */
     position: Vector3;
-    /**
-     * @override
-     */
-    protected readonly _isCube: boolean;
     private oriViewMatrix;
     private _oriFieldOfView;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
     /**
      * Store original camera parameters.

package/types/env-probe/Probe.d.ts

@@ -46,13 +46,7 @@ export declare abstract class Probe extends Script {
      * @remarks Prevent issue: Feedback Loops Between Textures and the Framebuffer.
      */
     onTextureChange(renderColorTexture: Texture): void;
-    /**
-     * @override
-     */
     onBeginRender(camera: Camera): void;
-    /**
-     * @override
-     */
     onEndRender(camera: Camera): void;
     protected _reset(): void;
 }

package/types/graphic/Buffer.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { BufferBindFlag } from "./enums/BufferBindFlag";
 import { BufferUsage } from "./enums/BufferUsage";
@@ -6,14 +6,13 @@ import { SetDataOptions } from "./enums/SetDataOptions";
 /**
  * Buffer.
  */
-export declare class Buffer extends RefObject {
-    _glBindTarget: number;
-    _glBufferUsage: number;
-    _nativeBuffer: WebGLBuffer;
-    private _hardwareRenderer;
+export declare class Buffer extends GraphicsResource {
     private _type;
     private _byteLength;
     private _bufferUsage;
+    private _platformBuffer;
+    private _readable;
+    private _data;
     /**
      * Buffer binding flag.
      */
@@ -26,22 +25,36 @@ export declare class Buffer extends RefObject {
      * Buffer usage.
      */
     get bufferUsage(): BufferUsage;
+    /**
+     * If buffer is readable.
+     */
+    get readable(): boolean;
+    /**
+     * Buffer data cache.
+     *
+     * @remarks
+     * Buffer must be readable.
+     * If the data you get is modified, must call `setData()` to update buffer to GPU.
+     */
+    get data(): Uint8Array;
     /**
      * Create Buffer.
      * @param engine - Engine
      * @param type - Buffer binding flag
      * @param byteLength - Byte length
      * @param bufferUsage - Buffer usage
+     * @param readable - If buffer is readable
      */
-    constructor(engine: Engine, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage);
+    constructor(engine: Engine, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage, readable?: boolean);
     /**
      * Create Buffer.
      * @param engine - Engine
      * @param type - Buffer binding flag
-     * @param data - Byte
+     * @param data - Buffer data, if `readable` is true, the`data` property will store a copy of this
      * @param bufferUsage - Buffer usage
+     * @param readable - If buffer is readable
      */
-    constructor(engine: Engine, type: BufferBindFlag, data: ArrayBuffer | ArrayBufferView, bufferUsage?: BufferUsage);
+    constructor(engine: Engine, type: BufferBindFlag, data: ArrayBuffer | ArrayBufferView, bufferUsage?: BufferUsage, readable?: boolean);
     /**
      * Bind buffer.
      */
@@ -94,12 +107,8 @@ export declare class Buffer extends RefObject {
      */
     getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void;
     /**
-     * @override
-     * Destroy.
-     */
-    _onDestroy(): void;
-    /**
-     * @deprecated
+     * Mark buffer as readable, the `data` property will be not accessible anymore.
      */
-    resize(dataLength: number): void;
+    markAsUnreadable(): void;
+    _rebuild(): void;
 }

package/types/graphic/BufferUtil.d.ts

@@ -4,6 +4,7 @@ export interface ElementInfo {
     size: number;
     type: DataType;
     normalized: boolean;
+    normalizedScaleFactor: number;
 }
 export declare class BufferUtil {
     static _getGLIndexType(indexFormat: IndexFormat): DataType;

package/types/graphic/Mesh.d.ts

@@ -1,14 +1,12 @@
 import { BoundingBox } from "@galacean/engine-math";
-import { RefObject } from "../asset/RefObject";
 import { Engine } from "../Engine";
-import { MeshTopology } from "../graphic/enums/MeshTopology";
-import { IndexBufferBinding } from "../graphic/IndexBufferBinding";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { SubMesh } from "../graphic/SubMesh";
-import { VertexElement } from "../graphic/VertexElement";
+import { MeshTopology } from "../graphic/enums/MeshTopology";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends RefObject {
+export declare abstract class Mesh extends GraphicsResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -55,16 +53,7 @@ export declare abstract class Mesh extends RefObject {
      * Clear all sub-mesh.
      */
     clearSubMesh(): void;
-    /**
-     * @override
-     */
-    _addRefCount(value: number): void;
-    /**
-     * @override
-     * Destroy.
-     */
-    _onDestroy(): void;
-    protected _setVertexElements(elements: VertexElement[]): void;
-    protected _setIndexBufferBinding(binding: IndexBufferBinding | null): void;
+    _addReferCount(value: number): void;
+    _rebuild(): void;
     private _onBoundsChanged;
 }

package/types/graphic/SubMesh.d.ts

@@ -1,8 +1,9 @@
+import { IPoolElement } from "../RenderPipeline/IPoolElement";
 import { MeshTopology } from "./enums/MeshTopology";
 /**
  * Sub-mesh, mainly contains drawing information.
  */
-export declare class SubMesh {
+export declare class SubMesh implements IPoolElement {
     /** Start drawing offset. */
     start: number;
     /** Drawing count. */
@@ -16,4 +17,5 @@ export declare class SubMesh {
      * @param topology - Drawing topology
      */
     constructor(start?: number, count?: number, topology?: MeshTopology);
+    dispose?(): void;
 }

package/types/graphic/VertexElement.d.ts

@@ -4,16 +4,16 @@ import { VertexElementFormat } from "./enums/VertexElementFormat";
  * Vertex element.
  */
 export declare class VertexElement {
-    _glElementInfo: ElementInfo;
-    private _semantic;
+    _formatMetaInfo: ElementInfo;
+    private _attributeName;
     private _offset;
     private _format;
     private _bindingIndex;
     private _instanceStepRate;
     /**
-     * Vertex semantic.
+     * Vertex attribute.
      */
-    get semantic(): string;
+    get attribute(): string;
     /**
      * Vertex data byte offset.
      */
@@ -34,11 +34,15 @@ export declare class VertexElement {
     get instanceStepRate(): number;
     /**
      * Create vertex element.
-     * @param semantic - Input vertex semantic
+     * @param attribute - Input attribute
      * @param offset - Vertex data byte offset
      * @param format - Vertex data format
      * @param bindingIndex - Vertex buffer binding index
      * @param instanceStepRate - Instance cadence, the number of instances drawn for each vertex in the buffer, non-instance elements must be 0.
      */
-    constructor(semantic: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    constructor(attribute: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    /**
+     * @deprecated use `attributeName` instead
+     */
+    get semantic(): string;
 }

package/types/index.d.ts

@@ -8,26 +8,25 @@ export { Entity } from "./Entity";
 export { Component } from "./Component";
 export { Script } from "./Script";
 export { Renderer } from "./Renderer";
-export { dependentComponents } from "./ComponentsDependencies";
+export { dependentComponents, DependentMode } from "./ComponentsDependencies";
 export { Camera } from "./Camera";
 export { Transform } from "./Transform";
 export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
+export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
 export { Loader } from "./asset/Loader";
+export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
 export { AssetPromise } from "./asset/AssetPromise";
 export type { LoadItem } from "./asset/LoadItem";
 export { AssetType } from "./asset/AssetType";
-export { RefObject } from "./asset/RefObject";
-export { BasicRenderPipeline } from "./RenderPipeline/BasicRenderPipeline";
-export { RenderQueue } from "./RenderPipeline/RenderQueue";
-export { RenderPass } from "./RenderPipeline/RenderPass";
-export { MeshRenderElement } from "./RenderPipeline/MeshRenderElement";
-export { SpriteElement } from "./RenderPipeline/SpriteElement";
+export { ReferResource } from "./asset/ReferResource";
+export * from "./RenderPipeline/Index";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";
+export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
 export { ColorSpace } from "./enums/ColorSpace";
@@ -51,3 +50,6 @@ export * from "./Layer";
 export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
+export * from "./Utils";
+export { Basic2DBatcher } from "./RenderPipeline/Basic2DBatcher";
+export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";

package/types/input/InputManager.d.ts

@@ -1,14 +1,14 @@
+import { Vector3 } from "@galacean/engine-math";
 import { Keys } from "./enums/Keys";
-import { Pointer } from "./pointer/Pointer";
 import { PointerButton } from "./enums/PointerButton";
-import { Vector3 } from "@galacean/engine-math";
+import { Pointer } from "./pointer/Pointer";
 /**
  * InputManager manages device input such as mouse, touch, keyboard, etc.
  */
 export declare class InputManager {
+    private _engine;
     /** Sometimes the input module will not be initialized, such as off-screen rendering. */
     private _initialized;
-    private _curFrameCount;
     private _wheelManager;
     private _pointerManager;
     private _keyboardManager;

package/types/input/interface/IInput.d.ts

@@ -2,7 +2,7 @@ export interface IInput {
     /**
      * Handler function updated every frame.
      */
-    _update(frameCount?: number): void;
+    _update(): void;
     /**
      * Function called when the engine is destroyed.
      */

package/types/lighting/AmbientLight.d.ts

@@ -1,10 +1,12 @@
 import { Color, SphericalHarmonics3 } from "@galacean/engine-math";
 import { TextureCube } from "../texture";
 import { DiffuseMode } from "./enums/DiffuseMode";
+import { ReferResource } from "../asset/ReferResource";
+import { Engine } from "../Engine";
 /**
  * Ambient light.
  */
-export declare class AmbientLight {
+export declare class AmbientLight extends ReferResource {
     private static _shMacro;
     private static _specularMacro;
     private static _decodeRGBMMacro;
@@ -60,6 +62,7 @@ export declare class AmbientLight {
      */
     get specularIntensity(): number;
     set specularIntensity(value: number);
+    constructor(engine: Engine);
     private _setDiffuseMode;
     private _setSpecularTexture;
     private _setSpecularTextureDecodeRGBM;

package/types/lighting/DirectLight.d.ts

@@ -8,7 +8,6 @@ export declare class DirectLight extends Light {
     private static _colorProperty;
     private static _directionProperty;
     private static _combinedData;
-    private _forward;
     private _reverseDirection;
     /**
      * Get direction.

package/types/lighting/Light.d.ts

@@ -44,5 +44,4 @@ export declare abstract class Light extends Component {
      * Inverse view matrix.
      */
     get inverseViewMatrix(): Matrix;
-    protected _getLightColor(): Color;
 }

package/types/lighting/LightManager.d.ts

@@ -2,4 +2,5 @@
  * Light manager.
  */
 export declare class LightManager {
+    private _getSunLightIndex;
 }

package/types/lighting/SpotLight.d.ts

@@ -18,7 +18,6 @@ export declare class SpotLight extends Light {
     angle: number;
     /** Angle, in radians, from falloff begins to ends. */
     penumbra: number;
-    private _forward;
     private _inverseDirection;
     private _projectMatrix;
     /**

package/types/material/BaseMaterial.d.ts

@@ -1,21 +1,21 @@
 import { Engine } from "../Engine";
-import { Shader } from "../shader";
+import { Shader, ShaderProperty } from "../shader";
 import { ShaderMacro } from "../shader/ShaderMacro";
 import { BlendMode } from "./enums/BlendMode";
 import { RenderFace } from "./enums/RenderFace";
 import { Material } from "./Material";
 export declare class BaseMaterial extends Material {
-    protected static _baseColorProp: import("../shader").ShaderProperty;
-    protected static _baseTextureProp: import("../shader").ShaderProperty;
     protected static _baseTextureMacro: ShaderMacro;
-    protected static _tilingOffsetProp: import("../shader").ShaderProperty;
-    protected static _normalTextureProp: import("../shader").ShaderProperty;
-    protected static _normalIntensityProp: import("../shader").ShaderProperty;
     protected static _normalTextureMacro: ShaderMacro;
-    protected static _emissiveColorProp: import("../shader").ShaderProperty;
-    protected static _emissiveTextureProp: import("../shader").ShaderProperty;
     protected static _emissiveTextureMacro: ShaderMacro;
     protected static _transparentMacro: ShaderMacro;
+    protected static _baseColorProp: ShaderProperty;
+    protected static _baseTextureProp: ShaderProperty;
+    protected static _tilingOffsetProp: ShaderProperty;
+    protected static _normalTextureProp: ShaderProperty;
+    protected static _normalIntensityProp: ShaderProperty;
+    protected static _emissiveColorProp: ShaderProperty;
+    protected static _emissiveTextureProp: ShaderProperty;
     private static _alphaCutoffProp;
     private static _alphaCutoffMacro;
     private _renderFace;
@@ -75,12 +75,10 @@ export declare class BaseMaterial extends Material {
      */
     setRenderFace(passIndex: number, renderFace: RenderFace): void;
     /**
-     * @override
      * Clone and return the instance.
      */
     clone(): BaseMaterial;
     /**
-     * @override
      * Clone to the target material.
      * @param target - target material
      */

package/types/material/BlinnPhongMaterial.d.ts

@@ -64,8 +64,5 @@ export declare class BlinnPhongMaterial extends BaseMaterial {
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
-    /**
-     * @override
-     */
     clone(): BlinnPhongMaterial;
 }

package/types/material/Material.d.ts

@@ -1,17 +1,20 @@
 import { IClone } from "@galacean/engine-design";
-import { RefObject } from "../asset/RefObject";
 import { Engine } from "../Engine";
+import { ReferResource } from "../asset/ReferResource";
 import { Shader } from "../shader/Shader";
 import { ShaderData } from "../shader/ShaderData";
 import { RenderState } from "../shader/state/RenderState";
 /**
  * Material.
  */
-export declare class Material extends RefObject implements IClone {
+export declare class Material extends ReferResource implements IClone {
     /** Name. */
     name: string;
-    /** Shader data. */
-    readonly shaderData: ShaderData;
+    private _shaderData;
+    /**
+     *  Shader data.
+     */
+    get shaderData(): ShaderData;
     /**
      * Shader used by the material.
      */
@@ -40,10 +43,7 @@ export declare class Material extends RefObject implements IClone {
      * @param target - target material
      */
     cloneTo(target: Material): void;
-    /**
-     * @override
-     */
-    _addRefCount(value: number): void;
+    _addReferCount(value: number): void;
     /**
      * @override
      */

package/types/material/PBRMaterial.d.ts

@@ -8,13 +8,22 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _metallicProp;
     private static _roughnessProp;
     private static _roughnessMetallicTextureProp;
+    private static _iorProp;
     /**
-     * Metallic, default 1.0.
+     * Index Of Refraction.
+     * @defaultValue `1.5`
+     */
+    get ior(): number;
+    set ior(v: number);
+    /**
+     * Metallic.
+     * @defaultValue `1.0`
      */
     get metallic(): number;
     set metallic(value: number);
     /**
-     * Roughness, default 1.0.
+     * Roughness. default 1.0.
+     * @defaultValue `1.0`
      */
     get roughness(): number;
     set roughness(value: number);
@@ -30,7 +39,7 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRMaterial;
 }

package/types/material/PBRSpecularMaterial.d.ts

@@ -32,7 +32,7 @@ export declare class PBRSpecularMaterial extends PBRBaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): PBRSpecularMaterial;
 }

package/types/material/UnlitMaterial.d.ts

@@ -27,7 +27,7 @@ export declare class UnlitMaterial extends BaseMaterial {
      */
     constructor(engine: Engine);
     /**
-     * @override
+     * @inheritdoc
      */
     clone(): UnlitMaterial;
 }

package/types/mesh/BlendShape.d.ts

@@ -6,7 +6,6 @@ import { BlendShapeFrame } from "./BlendShapeFrame";
 export declare class BlendShape {
     /** Name of BlendShape. */
     name: string;
-    private _dataChangeManager;
     private _frames;
     /**
      * Frames of BlendShape.
@@ -36,4 +35,5 @@ export declare class BlendShape {
     clearFrames(): void;
     private _addFrame;
     private _updateUseNormalAndTangent;
+    private _frameDataChangeListener;
 }

package/types/mesh/BlendShapeFrame.d.ts

@@ -5,12 +5,28 @@ import { Vector3 } from "@galacean/engine-math";
 export declare class BlendShapeFrame {
     /** Weight of BlendShapeFrame. */
     readonly weight: number;
-    /** Delta positions for the frame being added. */
-    readonly deltaPositions: Readonly<Readonly<Vector3>[]>;
-    /** Delta normals for the frame being added. */
-    readonly deltaNormals: Readonly<Readonly<Vector3[]> | null>;
-    /** Delta tangents for the frame being added. */
-    readonly deltaTangents: Readonly<Readonly<Vector3[]> | null>;
+    private _dirty;
+    private _deltaPositions;
+    private _deltaNormals;
+    private _deltaTangents;
+    /**
+     * Delta positions for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaPositions(): Vector3[];
+    set deltaPositions(value: Vector3[]);
+    /**
+     * Delta normals for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaNormals(): Vector3[];
+    set deltaNormals(value: Vector3[]);
+    /**
+     * Delta tangents for the frame being added.
+     * @remarks Need to re-assign after modification to ensure that the modification takes effect.
+     */
+    get deltaTangents(): Vector3[];
+    set deltaTangents(value: Vector3[]);
     /**
      * Create a BlendShapeFrame.
      * @param weight - Weight of BlendShapeFrame
@@ -20,3 +36,9 @@ export declare class BlendShapeFrame {
      */
     constructor(weight: number, deltaPositions: Vector3[], deltaNormals?: Vector3[], deltaTangents?: Vector3[]);
 }
+export declare enum BlendShapeFrameDirty {
+    Position = 1,
+    Normal = 2,
+    Tangent = 4,
+    All = 7
+}

package/types/mesh/BufferMesh.d.ts

@@ -27,10 +27,10 @@ export declare class BufferMesh extends Mesh {
     setVertexElements(elements: VertexElement[]): void;
     /**
      * Set vertex buffer binding.
-     * @param vertexBufferBindings - Vertex buffer binding
+     * @param vertexBufferBinding - Vertex buffer binding
      * @param index - Vertex buffer index, the default value is 0
      */
-    setVertexBufferBinding(vertexBufferBindings: VertexBufferBinding, index?: number): void;
+    setVertexBufferBinding(vertexBufferBinding: VertexBufferBinding, index?: number): void;
     /**
      * Set vertex buffer binding.
      * @param vertexBuffer - Vertex buffer

package/types/mesh/MeshRenderer.d.ts

@@ -1,30 +1,25 @@
-import { BoundingBox } from "@galacean/engine-math";
-import { ICustomClone } from "../clone/ComponentCloner";
-import { Mesh } from "../graphic/Mesh";
 import { Renderer } from "../Renderer";
-import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Mesh } from "../graphic/Mesh";
 /**
  * MeshRenderer Component.
  */
-export declare class MeshRenderer extends Renderer implements ICustomClone {
+export declare class MeshRenderer extends Renderer {
     private static _uvMacro;
     private static _uv1Macro;
     private static _normalMacro;
     private static _tangentMacro;
-    private static _vertexColorMacro;
+    private static _enableVertexColorMacro;
+    private _enableVertexColor;
     /**
      * Mesh assigned to the renderer.
      */
     get mesh(): Mesh;
     set mesh(value: Mesh);
     /**
-     * @override
-     */
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    /**
-     * @override
+     * Whether enable vertex color.
      */
-    protected _render(context: RenderContext): void;
+    get enableVertexColor(): boolean;
+    set enableVertexColor(value: boolean);
     private _setMesh;
     private _onMeshChanged;
 }