@galacean/engine-core 1.0.0-alpha.6 → 1.0.0

package/package.json

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

package/types/2d/atlas/SpriteAtlas.d.ts

@@ -1,10 +1,10 @@
-import { ReferResource } from "../../asset/ReferResource";
+import { RefObject } from "../../asset/RefObject";
 import { Engine } from "../../Engine";
 import { Sprite } from "../sprite/Sprite";
 /**
  * Sprite Atlas.
  */
-export declare class SpriteAtlas extends ReferResource {
+export declare class SpriteAtlas extends RefObject {
     private _sprites;
     private _spriteNamesToIndex;
     /**
@@ -29,4 +29,8 @@ export declare class SpriteAtlas extends ReferResource {
      * @param engine - Engine to which the SpriteAtlas belongs
      */
     constructor(engine: Engine);
+    /**
+     * @override
+     */
+    _onDestroy(): void;
 }

package/types/2d/atlas/types.d.ts

@@ -1,8 +1,13 @@
-import { TextureFormat } from "../../texture";
+import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../../texture";
 /**
  * The original data type of the atlas.
  */
 export interface AtlasConfig {
+    mipmap?: boolean;
+    wrapModeV?: TextureWrapMode;
+    wrapModeU?: TextureWrapMode;
+    filterMode?: TextureFilterMode;
+    anisoLevel?: number;
     /** Version of Atlas. */
     version: number;
     /** Texture format. */
@@ -49,5 +54,11 @@ export interface AtlasSprite {
         x: number;
         y: number;
     };
+    border: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
     pixelsPerUnit: number;
 }

package/types/2d/enums/SpriteDrawMode.d.ts

@@ -4,8 +4,6 @@
 export declare enum SpriteDrawMode {
     /** Overall scaling when modifying size. */
     Simple = 0,
-    /** When modifying the size of the renderer, it scales to fill the range according to the sprite border settings. */
-    Sliced = 1,
-    /** When modifying the size of the renderer, it will tile to fill the range according to the sprite border settings. */
-    Tiled = 2
+    /** When modifying the size, it is transformed according to the 9-slice settings (border). */
+    Sliced = 1
 }

package/types/2d/index.d.ts

@@ -5,6 +5,5 @@ export { OverflowMode } from "./enums/TextOverflow";
 export { FontStyle } from "./enums/FontStyle";
 export { SpriteAtlas } from "./atlas/SpriteAtlas";
 export { SpriteDrawMode } from "./enums/SpriteDrawMode";
-export { SpriteTileMode } from "./enums/SpriteTileMode";
 export * from "./sprite/index";
 export * from "./text/index";

package/types/2d/sprite/Sprite.d.ts

@@ -1,11 +1,11 @@
 import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
-import { ReferResource } from "../../asset/ReferResource";
+import { RefObject } from "../../asset/RefObject";
 import { Engine } from "../../Engine";
 import { Texture2D } from "../../texture/Texture2D";
 /**
  * 2D sprite.
  */
-export declare class Sprite extends ReferResource {
+export declare class Sprite extends RefObject {
     /** The name of sprite. */
     name: string;
     private _width;
@@ -86,6 +86,10 @@ export declare class Sprite extends ReferResource {
      * @returns Cloned sprite
      */
     clone(): Sprite;
+    /**
+     * @override
+     */
+    _onDestroy(): void;
     private _calDefaultSize;
     private _updatePositions;
     private _updateUVs;

package/types/2d/sprite/SpriteMask.d.ts

@@ -47,17 +47,17 @@ export declare class SpriteMask extends Renderer implements ICustomClone {
     set alphaCutoff(value: number);
     /**
      * @override
+     * @inheritdoc
      */
-    protected _updateBounds(worldBounds: BoundingBox): void;
+    _onDestroy(): void;
     /**
      * @override
-     * @inheritdoc
      */
-    protected _render(context: RenderContext): void;
+    protected _updateBounds(worldBounds: BoundingBox): void;
     /**
      * @override
      * @inheritdoc
      */
-    protected _onDestroy(): void;
+    protected _render(context: RenderContext): void;
     private _onSpriteChange;
 }

package/types/2d/sprite/SpriteRenderer.d.ts

@@ -4,7 +4,6 @@ import { Renderer } from "../../Renderer";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
 import { SpriteDrawMode } from "../enums/SpriteDrawMode";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
-import { SpriteTileMode } from "../enums/SpriteTileMode";
 import { Sprite } from "./Sprite";
 /**
  * Renders a Sprite for 2D graphics.
@@ -12,8 +11,6 @@ import { Sprite } from "./Sprite";
 export declare class SpriteRenderer extends Renderer implements ICustomClone {
     private _drawMode;
     private _assembler;
-    private _tileMode;
-    private _tiledAdaptiveThreshold;
     private _color;
     private _sprite;
     private _width;
@@ -26,17 +23,7 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      * The draw mode of the sprite renderer.
      */
     get drawMode(): SpriteDrawMode;
-    set drawMode(value: SpriteDrawMode);
-    /**
-     * The tiling mode of the sprite renderer. (Only works in tiled mode.)
-     */
-    get tileMode(): SpriteTileMode;
-    set tileMode(value: SpriteTileMode);
-    /**
-     * Stretch Threshold in Tile Adaptive Mode, specified in normalized. (Only works in tiled adaptive mode.)
-     */
-    get tiledAdaptiveThreshold(): number;
-    set tiledAdaptiveThreshold(value: number);
+    set drawMode(drawMode: SpriteDrawMode);
     /**
      * The Sprite to render.
      */
@@ -77,10 +64,6 @@ export declare class SpriteRenderer extends Renderer implements ICustomClone {
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
-    /**
-     * @override
-     */
-    protected _updateShaderData(context: RenderContext): void;
     /**
      * @override
      */

package/types/2d/text/Font.d.ts

@@ -1,9 +1,10 @@
-import { ReferResource } from "../../asset/ReferResource";
+import { RefObject } from "../../asset/RefObject";
 import { Engine } from "../../Engine";
 /**
  * Font.
  */
-export declare class Font extends ReferResource {
+export declare class Font extends RefObject {
+    private static _fontMap;
     /**
      * Create a system font.
      * @param engine - Engine to which the font belongs
@@ -18,4 +19,8 @@ export declare class Font extends ReferResource {
      */
     get name(): string;
     constructor(engine: Engine, name?: string);
+    /**
+     * @override
+     */
+    _onDestroy(): void;
 }

package/types/2d/text/TextRenderer.d.ts

@@ -107,10 +107,6 @@ export declare class TextRenderer extends Renderer implements ICustomClone {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
-    /**
-     * @override
-     */
-    protected _updateShaderData(context: RenderContext): void;
     /**
      * @override
      */

package/types/2d/text/index.d.ts

@@ -1,3 +1,2 @@
 export { Font } from "./Font";
 export { TextRenderer } from "./TextRenderer";
-export { TextUtils } from "./TextUtils";

package/types/Camera.d.ts

@@ -2,14 +2,12 @@ import { Matrix, Ray, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
 import { Layer } from "./Layer";
-import { Shader } from "./shader/Shader";
 import { ShaderData } from "./shader/ShaderData";
-import { ShaderTagKey } from "./shader/ShaderTagKey";
 import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
 import { RenderTarget } from "./texture/RenderTarget";
 /**
  * Camera component, as the entrance to the three-dimensional world.
- * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
+ * @decorator `@dependentComponents(Transform)`
  */
 export declare class Camera extends Component {
     /** Shader data. */
@@ -179,30 +177,6 @@ export declare class Camera extends Component {
      * @param mipLevel - Set mip level the data want to write, only take effect in webgl2.0
      */
     render(cubeFace?: TextureCubeFace, mipLevel?: number): void;
-    /**
-     * Set the replacement shader.
-     * @param shader - Replacement shader
-     * @param replacementTagName - Sub shader tag name
-     *
-     * @remarks
-     * If replacementTagName is not specified, the first sub shader will be replaced.
-     * If replacementTagName is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey.
-     */
-    setReplacementShader(shader: Shader, replacementTagName?: string): any;
-    /**
-     * Set the replacement shader.
-     * @param shader - Replacement shader
-     * @param replacementTag - Sub shader tag
-     *
-     * @remarks
-     * If replacementTag is not specified, the first sub shader will be replaced.
-     * If replacementTag is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey.
-     */
-    setReplacementShader(shader: Shader, replacementTag?: ShaderTagKey): any;
-    /**
-     * Reset and clear the replacement shader.
-     */
-    resetReplacementShader(): void;
     /**
      * @override
      * @inheritdoc
@@ -217,7 +191,7 @@ export declare class Camera extends Component {
      * @override
      * @inheritdoc
      */
-    protected _onDestroy(): void;
+    _onDestroy(): void;
     private _projMatChange;
     private _innerViewportToWorldPoint;
     private _updateShaderData;

package/types/Component.d.ts

@@ -12,6 +12,10 @@ export declare class Component extends EngineObject {
      */
     get enabled(): boolean;
     set enabled(value: boolean);
+    /**
+     * Indicates whether the component is destroyed.
+     */
+    get destroyed(): boolean;
     /**
      * The entity which the component belongs to.
      */
@@ -21,4 +25,8 @@ export declare class Component extends EngineObject {
      */
     get scene(): Scene;
     constructor(entity: Entity);
+    /**
+     * Destroy this instance.
+     */
+    destroy(): void;
 }

package/types/ComponentsDependencies.d.ts

@@ -2,24 +2,16 @@ import { Component } from "./Component";
 import { Entity } from "./Entity";
 type ComponentConstructor = new (entity: Entity) => Component;
 /**
- * Declare dependent component.
- * @param component - Dependent component
- * @param dependentMode - Dependent mode
+ * Used for component dependency registration.
  */
-export declare function dependentComponents(component: ComponentConstructor, dependentMode?: DependentMode): any;
-/**
- * Declare dependent components.
- * @param components - Dependent components
- * @param dependentMode - Dependent mode
- */
-export declare function dependentComponents(components: ComponentConstructor[], dependentMode?: DependentMode): any;
+export declare class ComponentsDependencies {
+    private static _invDependenciesMap;
+    private static _addDependency;
+    private constructor();
+}
 /**
- * Dependent mode.
+ * Dependent components, automatically added if they do not exist.
+ * @param components -  Dependent components
  */
-export declare enum DependentMode {
-    /** Check only, throw error if dependent components do not exist. */
-    CheckOnly = 0,
-    /** Auto add if dependent components do not exist. */
-    AutoAdd = 1
-}
+export declare function dependentComponents(...components: ComponentConstructor[]): <T extends ComponentConstructor>(target: T) => void;
 export {};

package/types/Engine.d.ts

@@ -1,22 +1,43 @@
-import { IPhysics } from "@galacean/engine-design";
+import { Font } from "./2d/text/Font";
 import { ResourceManager } from "./asset/ResourceManager";
 import { EventDispatcher, Time } from "./base";
 import { Canvas } from "./Canvas";
+import { ComponentsManager } from "./ComponentsManager";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
-import { ColorSpace } from "./enums/ColorSpace";
 import { InputManager } from "./input";
+import { LightManager } from "./lighting/LightManager";
+import { Material } from "./material/Material";
 import { PhysicsManager } from "./physics";
 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;
@@ -31,8 +52,7 @@ export declare class Engine extends EventDispatcher {
     private _targetFrameInterval;
     private _destroyed;
     private _frameInProcess;
-    private _waitingDestroy;
-    private _isDeviceLost;
+    private _waittingDestroy;
     private _animate;
     /**
      * Settings of Engine.
@@ -43,15 +63,15 @@ export declare class Engine extends EventDispatcher {
      */
     get canvas(): Canvas;
     /**
-     * The resource manager.
+     * Get the resource manager.
      */
     get resourceManager(): ResourceManager;
     /**
-     * The scene manager.
+     * Get the scene manager.
      */
     get sceneManager(): SceneManager;
     /**
-     * The time information of the engine.
+     * Get the Time class.
      */
     get time(): Time;
     /**
@@ -76,7 +96,13 @@ export declare class Engine extends EventDispatcher {
      * Indicates whether the engine is destroyed.
      */
     get destroyed(): boolean;
-    protected constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, configuration: EngineConfiguration);
+    /**
+     * 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);
     /**
      * Create an entity.
      * @param name - The name of the entity
@@ -99,34 +125,16 @@ 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;
-    protected _initialize(configuration: EngineConfiguration): Promise<Engine>;
+    /**
+     * @intenral
+     */
+    _render(scene: Scene): void;
     private _createSpriteMaterial;
     private _createSpriteMaskMaterial;
-    private _onDeviceLost;
-    private _onDeviceRestored;
-}
-/**
- * Engine configuration.
- */
-export interface EngineConfiguration {
-    /** Physics. */
-    physics?: IPhysics;
-    /** Color space. */
-    colorSpace?: ColorSpace;
 }

package/types/RenderPipeline/Basic2DBatcher.d.ts

@@ -1,18 +1,19 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
-import { ShaderTagKey } from "../shader/ShaderTagKey";
-import { RenderElement } from "./RenderElement";
+import { Material } from "../material";
+import { SpriteElement } from "./SpriteElement";
+import { SpriteMaskElement } from "./SpriteMaskElement";
+import { TextRenderElement } from "./TextRenderElement";
 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: RenderElement, camera: Camera): void;
-    flush(camera: Camera): void;
+    drawElement(element: SpriteMaskElement | SpriteElement | TextRenderElement, camera: Camera, replaceMaterial: Material): void;
+    private _drawSubElement;
+    flush(camera: Camera, replaceMaterial: Material): void;
     clear(): void;
     destroy(): void;
-    private _drawSubElement;
     private _createMesh;
     private _updateData;
     private _getSubMeshFromPool;

package/types/RenderPipeline/BasicRenderPipeline.d.ts

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

package/types/RenderPipeline/RenderElement.d.ts

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

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,19 +1,21 @@
 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 elements: RenderElement[];
+    readonly items: RenderElement[];
     private _spriteBatcher;
     constructor(engine: Engine);
     /**
      * Push a render element.
      */
-    pushRenderElement(element: RenderElement): void;
-    render(camera: Camera, mask: Layer): void;
+    pushPrimitive(element: RenderElement): void;
+    render(camera: Camera, replaceMaterial: Material, mask: Layer, customShader: Shader): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/SpriteMaskBatcher.d.ts

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

package/types/Renderer.d.ts

@@ -2,11 +2,11 @@ import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { RenderContext } from "./RenderPipeline/RenderContext";
 import { TransformModifyFlags } from "./Transform";
+import { Material } from "./material/Material";
 import { ShaderData } from "./shader/ShaderData";
-import { Material } from "./material";
 /**
  * Basis for all renderers.
- * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
+ * @decorator `@dependentComponents(Transform)`
  */
 export declare class Renderer extends Component {
     private static _tempVector0;