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

package/types/Engine.d.ts

@@ -1,44 +1,20 @@
-import { Font } from "./2d/text/Font";
-import { ResourceManager } from "./asset/ResourceManager";
-import { EventDispatcher, Time } from "./base";
+import { IPhysics, IShaderLab } from "@galacean/engine-design";
 import { Canvas } from "./Canvas";
-import { ComponentsManager } from "./ComponentsManager";
 import { EngineSettings } from "./EngineSettings";
 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 { LightManager } from "./lighting/LightManager";
-import { Material } from "./material/Material";
-import { PhysicsManager } from "./physics";
+import { PhysicsScene } from "./physics/PhysicsScene";
 import { IHardwareRenderer } from "./renderingHardwareInterface";
-import { ClassPool } from "./RenderPipeline/ClassPool";
-import { MeshRenderElement } from "./RenderPipeline/MeshRenderElement";
-import { RenderContext } from "./RenderPipeline/RenderContext";
-import { SpriteElement } from "./RenderPipeline/SpriteElement";
-import { SpriteMaskElement } from "./RenderPipeline/SpriteMaskElement";
-import { TextRenderElement } from "./RenderPipeline/TextRenderElement";
-import { Scene } from "./Scene";
-import { SceneManager } from "./SceneManager";
-import { RenderState } from "./shader/state/RenderState";
 /**
  * Engine.
  */
 export declare class Engine extends EventDispatcher {
-    /** Physics manager of Engine. */
-    readonly physicsManager: PhysicsManager;
+    /** Input manager of Engine. */
     readonly inputManager: InputManager;
-    _lightManager: LightManager;
-    _componentsManager: ComponentsManager;
-    _hardwareRenderer: IHardwareRenderer;
-    _lastRenderState: RenderState;
-    _renderElementPool: ClassPool<MeshRenderElement>;
-    _spriteElementPool: ClassPool<SpriteElement>;
-    _spriteMaskElementPool: ClassPool<SpriteMaskElement>;
-    _textElementPool: ClassPool<TextRenderElement>;
-    _spriteDefaultMaterial: Material;
-    _spriteMaskDefaultMaterial: Material;
-    _textDefaultFont: Font;
-    _renderContext: RenderContext;
-    protected _canvas: Canvas;
     private _settings;
     private _resourceManager;
     private _sceneManager;
@@ -52,7 +28,9 @@ export declare class Engine extends EventDispatcher {
     private _targetFrameInterval;
     private _destroyed;
     private _frameInProcess;
-    private _waittingDestroy;
+    private _waitingDestroy;
+    private _isDeviceLost;
+    private _waitingGC;
     private _animate;
     /**
      * Settings of Engine.
@@ -63,15 +41,15 @@ export declare class Engine extends EventDispatcher {
      */
     get canvas(): Canvas;
     /**
-     * Get the resource manager.
+     * The resource manager.
      */
     get resourceManager(): ResourceManager;
     /**
-     * Get the scene manager.
+     * The scene manager.
      */
     get sceneManager(): SceneManager;
     /**
-     * Get the Time class.
+     * The time information of the engine.
      */
     get time(): Time;
     /**
@@ -96,13 +74,7 @@ export declare class Engine extends EventDispatcher {
      * Indicates whether the engine is destroyed.
      */
     get destroyed(): boolean;
-    /**
-     * Create engine.
-     * @param canvas - The canvas to use for rendering
-     * @param hardwareRenderer - Graphics API renderer
-     * @param settings - Engine Settings
-     */
-    constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, settings?: EngineSettings);
+    protected constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, configuration: EngineConfiguration);
     /**
      * Create an entity.
      * @param name - The name of the entity
@@ -125,16 +97,41 @@ export declare class Engine extends EventDispatcher {
      * Execution engine loop.
      */
     run(): void;
+    /**
+     * Force lose graphic device.
+     * @remarks Used to simulate the phenomenon after the real loss of device.
+     */
+    forceLoseDevice(): void;
+    /**
+     * Force restore graphic device.
+     * @remarks Used to simulate the phenomenon after the real restore of device.
+     */
+    forceRestoreDevice(): void;
     private _destroy;
     /**
      * Destroy engine.
      * @remarks If call during frame execution will delay until the end of the frame
      */
     destroy(): void;
-    /**
-     * @intenral
-     */
-    _render(scene: Scene): void;
     private _createSpriteMaterial;
     private _createSpriteMaskMaterial;
+    private _onDeviceLost;
+    private _onDeviceRestored;
+    private _gc;
+    /**
+     * @deprecated
+     * The first scene physics manager.
+     */
+    get physicsManager(): PhysicsScene;
+}
+/**
+ * Engine configuration.
+ */
+export interface EngineConfiguration {
+    /** Physics. */
+    physics?: IPhysics;
+    /** Color space. */
+    colorSpace?: ColorSpace;
+    /** Shader lab */
+    shaderLab?: IShaderLab;
 }

package/types/Entity.d.ts

@@ -1,10 +1,10 @@
 import { Matrix } from "@galacean/engine-math";
-import { EngineObject } from "./base";
 import { Component } from "./Component";
 import { Engine } from "./Engine";
 import { Layer } from "./Layer";
 import { Scene } from "./Scene";
 import { Transform } from "./Transform";
+import { EngineObject } from "./base";
 /**
  * Entity, be used as components container.
  */
@@ -65,7 +65,7 @@ export declare class Entity extends EngineObject {
      * @param type - The type of the component
      * @returns	The first component which match type
      */
-    getComponent<T extends Component>(type: new (entity: Entity) => T): T;
+    getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;
     /**
      * Get components which match the type.
      * @param type - The type of the component
@@ -130,6 +130,8 @@ export declare class Entity extends EngineObject {
      * @returns Cloned entity
      */
     clone(): Entity;
+    private _createCloneEntity;
+    private _parseCloneEntity;
     /**
      * Destroy self.
      */

package/types/RenderPipeline/Basic2DBatcher.d.ts

@@ -1,19 +1,18 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
-import { Material } from "../material";
-import { SpriteElement } from "./SpriteElement";
-import { SpriteMaskElement } from "./SpriteMaskElement";
-import { TextRenderElement } from "./TextRenderElement";
+import { ShaderTagKey } from "../shader/ShaderTagKey";
+import { RenderElement } from "./RenderElement";
 export declare abstract class Basic2DBatcher {
+    protected static _disableBatchTag: ShaderTagKey;
     /** The maximum number of vertex. */
     static MAX_VERTEX_COUNT: number;
     static _canUploadSameBuffer: boolean;
     constructor(engine: Engine);
-    drawElement(element: SpriteMaskElement | SpriteElement | TextRenderElement, camera: Camera, replaceMaterial: Material): void;
-    private _drawSubElement;
-    flush(camera: Camera, replaceMaterial: Material): void;
+    drawElement(element: RenderElement, camera: Camera): void;
+    flush(camera: Camera): void;
     clear(): void;
     destroy(): void;
+    private _drawSubElement;
     private _createMesh;
     private _updateData;
     private _getSubMeshFromPool;

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -3,19 +3,18 @@ import { Layer } from "../Layer";
 import { Material } from "../material";
 import { RenderTarget, TextureCubeFace } from "../texture";
 import { RenderContext } from "./RenderContext";
-import { RenderElement } from "./RenderElement";
+import { RenderData } from "./RenderData";
 import { RenderPass } from "./RenderPass";
 /**
  * Basic render pipeline.
  */
 export declare class BasicRenderPipeline {
-    private static _tempVector0;
-    private static _tempVector1;
     private _camera;
     private _defaultPass;
     private _renderPassArray;
     private _lastCanvasSize;
     private _cascadedShadowCaster;
+    private _depthOnlyPass;
     /**
      * Create a basic render pipeline.
      * @param camera - Camera
@@ -57,10 +56,12 @@ export declare class BasicRenderPipeline {
     render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number): void;
     private _drawRenderPass;
     /**
-     * Push a render element to the render queue.
-     * @param element - Render element
+     * Push render data to render queue.
+     * @param context - Render context
+     * @param data - Render data
      */
-    pushPrimitive(element: RenderElement): void;
+    pushRenderData(context: RenderContext, data: RenderData): void;
+    private pushRenderDataWihShader;
     private _drawBackgroundTexture;
     private _callRender;
 }

package/types/RenderPipeline/ClassPool.d.ts

@@ -1,7 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 /**
  * Class pool utils.
  */
-export declare class ClassPool<T> {
+export declare class ClassPool<T extends IPoolElement> {
     private _elementPoolIndex;
     private _elementPool;
     private _type;
@@ -14,4 +15,5 @@ export declare class ClassPool<T> {
      * Reset pool.
      */
     resetPool(): void;
+    garbageCollection(): void;
 }

package/types/RenderPipeline/CullingResults.d.ts

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

package/types/RenderPipeline/DepthOnlyPass.d.ts

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

package/types/RenderPipeline/IPoolElement.d.ts

@@ -0,0 +1,3 @@
+export interface IPoolElement {
+    dispose?(): void;
+}

package/types/RenderPipeline/MeshRenderData.d.ts

@@ -0,0 +1,17 @@
+import { Mesh } from "../graphic/Mesh";
+import { SubMesh } from "../graphic/SubMesh";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+/**
+ * Render element.
+ */
+export declare class MeshRenderData extends RenderData implements IPoolElement {
+    /** Mesh. */
+    mesh: Mesh;
+    /** Sub mesh. */
+    subMesh: SubMesh;
+    set(component: Renderer, material: Material, mesh: Mesh, subMesh: SubMesh): void;
+    dispose(): void;
+}

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -4,14 +4,16 @@ import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader/ShaderPass";
 import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
 /**
  * Render element.
  */
-export declare class MeshRenderElement extends RenderElement {
+export declare class MeshRenderElement extends RenderElement implements IPoolElement {
     /** Mesh. */
     mesh: Mesh;
     /** Sub mesh. */
     subMesh: SubMesh;
     setValue(component: Renderer, mesh: Mesh, subMesh: SubMesh, material: Material, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
 }

package/types/RenderPipeline/PipelinePass.d.ts

@@ -0,0 +1,16 @@
+import { Engine } from "../Engine";
+import { CullingResults } from "../RenderPipeline/CullingResults";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+/**
+ * PipelinePass is a base class for all pipeline passes.
+ */
+export declare abstract class PipelinePass {
+    protected _engine: Engine;
+    constructor(engine: Engine);
+    /**
+     * Called before rendering a camera, override this method to configure the camera If you need to configure the camera clear flag or render target.
+     * @param context - Rendering context
+     * @param cullingResults - Culling results
+     */
+    abstract onRender(context: RenderContext, cullingResults: CullingResults): void;
+}

package/types/RenderPipeline/PipelineUtils.d.ts

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

package/types/RenderPipeline/RenderData.d.ts

@@ -0,0 +1,7 @@
+import { Material } from "../material";
+import { Renderer } from "../Renderer";
+export declare class RenderData {
+    component: Renderer;
+    material: Material;
+    multiRenderData: boolean;
+}

package/types/RenderPipeline/RenderElement.d.ts

@@ -1,11 +1,9 @@
-import { Material } from "../material/Material";
-import { Renderer } from "../Renderer";
-import { ShaderPass } from "../shader";
-import { RenderState } from "../shader/state/RenderState";
-export declare class RenderElement {
-    component: Renderer;
-    material: Material;
-    multiRenderData: boolean;
-    renderState: RenderState;
-    shaderPass: ShaderPass;
+import { ShaderPass } from "../shader/ShaderPass";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class RenderElement implements IPoolElement {
+    data: RenderData;
+    shaderPasses: ReadonlyArray<ShaderPass>;
+    set(data: RenderData, shaderPasses: ReadonlyArray<ShaderPass>): void;
+    dispose(): void;
 }

package/types/RenderPipeline/RenderPass.d.ts

@@ -23,7 +23,7 @@ declare class 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 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);

package/types/RenderPipeline/RenderQueue.d.ts

@@ -1,21 +1,19 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
 import { Layer } from "../Layer";
-import { Material } from "../material/Material";
-import { Shader } from "../shader";
 import { RenderElement } from "./RenderElement";
 /**
  * Render queue.
  */
 export declare class RenderQueue {
-    readonly items: RenderElement[];
+    readonly elements: RenderElement[];
     private _spriteBatcher;
     constructor(engine: Engine);
     /**
      * Push a render element.
      */
-    pushPrimitive(element: RenderElement): void;
-    render(camera: Camera, replaceMaterial: Material, mask: Layer, customShader: Shader): void;
+    pushRenderElement(element: RenderElement): void;
+    render(camera: Camera, mask: Layer, pipelineStageTagValue: string): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/SpriteElement.d.ts

@@ -4,10 +4,12 @@ import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader";
 import { RenderState } from "../shader/state/RenderState";
 import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
-export declare class SpriteElement extends RenderElement {
+export declare class SpriteElement extends RenderElement implements IPoolElement {
     renderData: RenderData2D;
     texture: Texture2D;
     constructor();
     setValue(component: Renderer, renderDate: RenderData2D, material: Material, texture: Texture2D, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteMaskBatcher.d.ts

@@ -1,10 +1,11 @@
 import { Camera } from "../Camera";
 import { VertexElement } from "../graphic/VertexElement";
 import { Basic2DBatcher } from "./Basic2DBatcher";
-import { SpriteMaskElement } from "./SpriteMaskElement";
+import { RenderElement } from "./RenderElement";
+import { SpriteMaskRenderData } from "./SpriteMaskRenderData";
 export declare class SpriteMaskBatcher extends Basic2DBatcher {
     createVertexElements(vertexElements: VertexElement[]): number;
-    canBatch(preElement: SpriteMaskElement, curElement: SpriteMaskElement): boolean;
-    updateVertices(element: SpriteMaskElement, vertices: Float32Array, vertexIndex: number): number;
+    canBatch(preElement: RenderElement, curElement: RenderElement): boolean;
+    updateVertices(element: SpriteMaskRenderData, vertices: Float32Array, vertexIndex: number): number;
     drawBatches(camera: Camera): void;
 }

package/types/RenderPipeline/SpriteMaskElement.d.ts

@@ -1,10 +1,12 @@
 import { RenderData2D } from "../2d/data/RenderData2D";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
-export declare class SpriteMaskElement extends RenderElement {
+export declare class SpriteMaskElement extends RenderElement implements IPoolElement {
     renderData: RenderData2D;
     isAdd: boolean;
     constructor();
     setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteMaskRenderData.d.ts

@@ -0,0 +1,12 @@
+import { VertexData2D } from "../2d/data/VertexData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class SpriteMaskRenderData extends RenderData implements IPoolElement {
+    isAdd: boolean;
+    verticesData: VertexData2D;
+    constructor();
+    set(component: Renderer, material: Material, verticesData: VertexData2D): void;
+    dispose(): void;
+}

package/types/RenderPipeline/SpriteRenderData.d.ts

@@ -0,0 +1,14 @@
+import { VertexData2D } from "../2d/data/VertexData2D";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+export declare class SpriteRenderData extends RenderData implements IPoolElement {
+    verticesData: VertexData2D;
+    texture: Texture2D;
+    dataIndex: number;
+    constructor();
+    set(component: Renderer, material: Material, verticesData: VertexData2D, texture: Texture2D, dataIndex?: number): void;
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderData.d.ts

@@ -0,0 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
+import { RenderData } from "./RenderData";
+import { SpriteRenderData } from "./SpriteRenderData";
+export declare class TextRenderData extends RenderData implements IPoolElement {
+    charsData: SpriteRenderData[];
+    constructor();
+    dispose(): void;
+}

package/types/RenderPipeline/TextRenderElement.d.ts

@@ -1,6 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
 import { SpriteElement } from "./SpriteElement";
-export declare class TextRenderElement extends RenderElement {
+export declare class TextRenderElement extends RenderElement implements IPoolElement {
     charElements: SpriteElement[];
     constructor();
+    dispose(): void;
 }

package/types/RenderPipeline/enums/PipelineStage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Pipeline stage.
+ */
+export declare enum PipelineStage {
+    /** DepthOnly stage. */
+    DepthOnly = "DepthOnly",
+    /** Shadow caster stage. */
+    ShadowCaster = "ShadowCaster",
+    /** Forward shading stage. */
+    Forward = "Forward"
+}

package/types/RenderPipeline/index.d.ts

@@ -0,0 +1,4 @@
+export { BasicRenderPipeline } from "./BasicRenderPipeline";
+export { PipelineStage } from "./enums/PipelineStage";
+export { RenderPass } from "./RenderPass";
+export { RenderQueue } from "./RenderQueue";

package/types/Renderer.d.ts

@@ -1,14 +1,13 @@
-import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
+import { BoundingBox, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
-import { RenderContext } from "./RenderPipeline/RenderContext";
-import { TransformModifyFlags } from "./Transform";
-import { Material } from "./material/Material";
+import { ICustomClone } from "./clone/ComponentCloner";
+import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
 /**
  * Basis for all renderers.
- * @decorator `@dependentComponents(Transform)`
+ * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
-export declare class Renderer extends Component {
+export declare class Renderer extends Component implements ICustomClone {
     private static _tempVector0;
     private static _receiveShadowMacro;
     private static _localMatrixProperty;
@@ -18,12 +17,11 @@ export declare class Renderer extends Component {
     private static _mvInvMatrixProperty;
     private static _normalMatrixProperty;
     private static _rendererLayerProperty;
-    /** ShaderData related to renderer. */
-    readonly shaderData: ShaderData;
     _renderFrameCount: number;
     protected _overrideUpdate: boolean;
     protected _materials: Material[];
     protected _dirtyUpdateFlag: number;
+    private _shaderData;
     private _mvMatrix;
     private _mvpMatrix;
     private _mvInvMatrix;
@@ -32,6 +30,10 @@ export declare class Renderer extends Component {
     private _priority;
     private _receiveShadows;
     protected _rendererLayer: Vector4;
+    /**
+     * ShaderData related to renderer.
+     */
+    get shaderData(): ShaderData;
     /**
      * Whether it is culled in the current frame and does not participate in rendering.
      */
@@ -108,12 +110,5 @@ export declare class Renderer extends Component {
      */
     setMaterials(materials: Material[]): void;
     update(deltaTime: number): void;
-    protected _updateShaderData(context: RenderContext): void;
-    protected _updateTransformShaderData(context: RenderContext, worldMatrix: Matrix): void;
-    protected _registerEntityTransformListener(): void;
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _render(context: RenderContext): void;
-    private _createInstanceMaterial;
     private _setMaterial;
-    protected _onTransformChanged(type: TransformModifyFlags): void;
 }

package/types/Scene.d.ts

@@ -1,10 +1,11 @@
 import { Color, Vector3 } from "@galacean/engine-math";
 import { Background } from "./Background";
-import { EngineObject } from "./base";
 import { Engine } from "./Engine";
 import { Entity } from "./Entity";
+import { EngineObject } from "./base";
 import { FogMode } from "./enums/FogMode";
 import { AmbientLight } from "./lighting/AmbientLight";
+import { PhysicsScene } from "./physics/PhysicsScene";
 import { ShaderData } from "./shader/ShaderData";
 import { ShadowCascadesMode } from "./shadow/enum/ShadowCascadesMode";
 import { ShadowResolution } from "./shadow/enum/ShadowResolution";
@@ -14,12 +15,12 @@ import { ShadowResolution } from "./shadow/enum/ShadowResolution";
 export declare class Scene extends EngineObject {
     private static _fogColorProperty;
     private static _fogParamsProperty;
+    private static _sunlightColorProperty;
+    private static _sunlightDirectionProperty;
     /** Scene name. */
     name: string;
-    /** The background of the scene. */
-    readonly background: Background;
-    /** Scene-related shader data. */
-    readonly shaderData: ShaderData;
+    /** Physics. */
+    readonly physics: PhysicsScene;
     /** If cast shadows. */
     castShadows: boolean;
     /** The resolution of the shadow maps. */
@@ -30,6 +31,8 @@ export declare class Scene extends EngineObject {
     shadowFourCascadeSplits: Vector3;
     /** Max Shadow distance. */
     shadowDistance: number;
+    private _background;
+    private _shaderData;
     private _shadowCascades;
     private _ambientLight;
     private _fogMode;
@@ -38,6 +41,14 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    /**
+     * Scene-related shader data.
+     */
+    get shaderData(): ShaderData;
+    /**
+     * The background of the scene.
+     */
+    get background(): Background;
     /**
      *  Number of cascades to use for directional light shadows.
      */
@@ -132,10 +143,6 @@ export declare class Scene extends EngineObject {
      * @returns Entity
      */
     findEntityByPath(path: string): Entity | null;
-    /**
-     * Destroy this scene.
-     */
-    destroy(): void;
     private _addToRootEntityList;
     private _computeLinearFogParams;
     private _computeExponentialFogParams;