@galacean/engine-core 1.3.0-alpha.2 → 1.3.0-alpha.3

package/package.json

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

package/types/2d/assembler/IAssembler.d.ts

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

package/types/2d/data/VertexData2D.d.ts

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

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

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

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

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

package/types/RenderPipeline/Basic2DBatcher.d.ts

@@ -0,0 +1,19 @@
+import { Camera } from "../Camera";
+import { Engine } from "../Engine";
+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: RenderElement, camera: Camera): void;
+    flush(camera: Camera): void;
+    clear(): void;
+    destroy(): void;
+    private _drawSubElement;
+    private _createMesh;
+    private _updateData;
+    private _getSubMeshFromPool;
+}

package/types/RenderPipeline/ClassPool.d.ts

@@ -0,0 +1,19 @@
+import { IPoolElement } from "./IPoolElement";
+/**
+ * Class pool utils.
+ */
+export declare class ClassPool<T extends IPoolElement> {
+    private _elementPoolIndex;
+    private _elementPool;
+    private _type;
+    constructor(type: new () => T);
+    /**
+     * Get element from pool.
+     */
+    getFromPool(): T;
+    /**
+     * Reset pool.
+     */
+    resetPool(): void;
+    garbageCollection(): void;
+}

package/types/RenderPipeline/DynamicGeometryData.d.ts

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

package/types/RenderPipeline/DynamicGeometryDataManager.d.ts

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

package/types/RenderPipeline/IPoolElement.d.ts

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

package/types/RenderPipeline/RenderData.d.ts

@@ -0,0 +1,14 @@
+import { SubMesh } from "../graphic";
+import { Primitive } from "../graphic/Primitive";
+import { Material } from "../material";
+import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
+export declare class RenderData implements IPoolElement {
+    component: Renderer;
+    material: Material;
+    primitive: Primitive;
+    subPrimitive: SubMesh;
+    multiRenderData: boolean;
+    setX(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh): void;
+    dispose(): void;
+}

package/types/RenderPipeline/RenderData2D.d.ts

@@ -0,0 +1,14 @@
+import { Primitive, SubMesh } from "../graphic";
+import { Material } from "../material/Material";
+import { Renderer } from "../Renderer";
+import { Texture2D } from "../texture";
+import { IPoolElement } from "../utils/Pool";
+import { Chunk } from "./DynamicGeometryData";
+import { RenderData } from "./RenderData";
+export declare class RenderData2D extends RenderData implements IPoolElement {
+    texture: Texture2D;
+    chunk: Chunk;
+    constructor();
+    set(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh, texture?: Texture2D, chunk?: Chunk): void;
+    dispose(): void;
+}

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/SpriteBatcher.d.ts

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

package/types/RenderPipeline/SpriteMaskBatcher.d.ts

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

package/types/RenderPipeline/SpriteMaskManager.d.ts

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

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/enums/ForceUploadShaderDataFlag.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Force upload shader data flag.
+ */
+export declare enum ForceUploadShaderDataFlag {
+    /** Upload nothing. */
+    None = 0,
+    /** Upload scene shader data. */
+    Scene = 1,
+    /** Upload camera shader data. */
+    Camera = 2,
+    /** Upload renderer shader data. */
+    Renderer = 4,
+    /** Upload material shader data. */
+    Material = 8
+}

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

@@ -0,0 +1,13 @@
+/**
+ * RenderData usage.
+ */
+export declare enum RenderDataUsage {
+    /** Usage for mesh. */
+    Mesh = 0,
+    /** Usage for sprite. */
+    Sprite = 1,
+    /** Usage for sprite mask. */
+    SpriteMask = 2,
+    /** Usage for text. */
+    Text = 3
+}

package/types/animation/AnimatorTransition.d.ts

@@ -0,0 +1,14 @@
+import { AnimatorState } from "./AnimatorState";
+/**
+ * Transitions define when and how the state machine switch from on state to another. AnimatorTransition always originate from a StateMachine or a StateMachine entry.
+ */
+export declare class AnimatorStateTransition {
+    /** The duration of the transition. This is represented in normalized time. */
+    duration: number;
+    /** The time at which the destination state will start. This is represented in normalized time. */
+    offset: number;
+    /** ExitTime represents the exact time at which the transition can take effect. This is represented in normalized time. */
+    exitTime: number;
+    /** The destination state of the transition. */
+    destinationState: AnimatorState;
+}

package/types/input/pointer/PointerEvent.d.ts

@@ -0,0 +1,4 @@
+import { Pointer } from "./Pointer";
+export declare class PointerEvent {
+    pointer: Pointer;
+}

package/types/input/pointer/PointerEventType.d.ts

@@ -0,0 +1,7 @@
+export declare enum PointerEventType {
+    Down = 0,
+    Up = 1,
+    Click = 2,
+    Enter = 3,
+    Exit = 4
+}

package/types/lighting/Light.d.ts

@@ -21,11 +21,13 @@ export declare abstract class Light extends Component {
     shadowNormalBias: number;
     /** Near plane value to use for shadow frustums. */
     shadowNearPlane: number;
-    /** Shadow intensity, the larger the value, the clearer and darker the shadow. */
-    shadowStrength: number;
+    private _shadowStrength;
     private _color;
     private _viewMat;
     private _inverseViewMat;
+    /** Shadow intensity, the larger the value, the clearer and darker the shadow, range [0,1]. */
+    get shadowStrength(): number;
+    set shadowStrength(value: number);
     /**
      * Light Color.
      */

package/types/renderingHardwareInterface/IHardwareRenderer.d.ts

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

package/types/ui/Image.d.ts

@@ -0,0 +1,38 @@
+import { Color } from "@galacean/engine-math";
+import { Sprite, SpriteDrawMode, SpriteTileMode } from "../2d";
+import { UIRenderer } from "./UIRenderer";
+export declare class Image extends UIRenderer {
+    private _color;
+    private _sprite;
+    private _drawMode;
+    private _assembler;
+    private _tileMode;
+    private _tiledAdaptiveThreshold;
+    /**
+     * 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);
+    /**
+     * The Sprite to render.
+     */
+    get sprite(): Sprite;
+    set sprite(value: Sprite | null);
+    /**
+     * Rendering color for the Sprite graphic.
+     */
+    get color(): Color;
+    set color(value: Color);
+    protected _onDestroy(): void;
+    private _onSpriteChange;
+}

package/types/ui/RedBlackTree.d.ts

@@ -0,0 +1,2 @@
+export declare class RedBlackTree {
+}

package/types/ui/UICanvas.d.ts

@@ -0,0 +1,55 @@
+import { Vector2 } from "@galacean/engine-math";
+import { Camera } from "../Camera";
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { CanvasRenderMode } from "./enums/CanvasRenderMode";
+import { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
+export declare class UICanvas extends Component {
+    private _renderMode;
+    private _renderCamera;
+    private _resolutionAdaptationStrategy;
+    private _sortOrder;
+    private _distance;
+    private _renderers;
+    private _transform;
+    private _uiTransform;
+    private _referenceResolution;
+    private _isRootCanvas;
+    private _enableBlocked;
+    private _parents;
+    private _hierarchyDirty;
+    get enableBlocked(): boolean;
+    set enableBlocked(value: boolean);
+    get referenceResolution(): Vector2;
+    set referenceResolution(val: Vector2);
+    get renderMode(): CanvasRenderMode;
+    set renderMode(mode: CanvasRenderMode);
+    get renderCamera(): Camera;
+    set renderCamera(val: Camera);
+    get resolutionAdaptationStrategy(): ResolutionAdaptationStrategy;
+    set resolutionAdaptationStrategy(val: ResolutionAdaptationStrategy);
+    get sortOrder(): number;
+    set sortOrder(val: number);
+    get distance(): number;
+    set distance(val: number);
+    constructor(entity: Entity);
+    _prepareRender(context: RenderContext): void;
+    private _adapterPoseInScreenSpace;
+    private _adapterSizeInScreenSpace;
+    private _walk;
+    private _addCameraListener;
+    private _removeCameraListener;
+    private _onCameraPropertyListener;
+    private _onCameraTransformListener;
+    private _addCanvasListener;
+    private _removeCanvasListener;
+    private _onCanvasSizeListener;
+    private _addParentListener;
+    private _removeParentListener;
+    private _onEntityListener;
+    private _onParentListener;
+    private _onReferenceResolutionChanged;
+    private _checkIsRootCanvas;
+    private _setIsRootCanvas;
+}

package/types/ui/UIRenderer.d.ts

@@ -0,0 +1,14 @@
+import { BoundingBox, Vector4 } from "@galacean/engine-math";
+import { Renderer } from "../Renderer";
+import { UITransform, UITransformModifyFlags } from "./UITransform";
+export declare class UIRenderer extends Renderer {
+    protected _uiTransform: UITransform;
+    protected _localBounds: BoundingBox;
+    protected _rayCastTarget: boolean;
+    protected _rayCastPadding: Vector4;
+    get rayCastTarget(): boolean;
+    set rayCastTarget(value: boolean);
+    get rayCastPadding(): Vector4;
+    set rayCastPadding(value: Vector4);
+    protected _onUITransformChanged(flag: UITransformModifyFlags): void;
+}

package/types/ui/UITransform.d.ts

@@ -0,0 +1,20 @@
+import { Vector2 } from "@galacean/engine-math";
+import { Component } from "../Component";
+import { Entity } from "../Entity";
+export declare class UITransform extends Component {
+    private _rect;
+    private _pivot;
+    get rect(): Vector2;
+    set rect(val: Vector2);
+    get pivot(): Vector2;
+    set pivot(val: Vector2);
+    constructor(entity: Entity);
+    private _onRectChange;
+    private _onPivotChange;
+}
+export declare enum UITransformModifyFlags {
+    /** Rect. */
+    Rect = 1,
+    /** Pivot. */
+    Pivot = 2
+}

package/types/ui/enums/BlockingObjects.d.ts

@@ -0,0 +1,6 @@
+export declare enum BlockingObjects {
+    None = 0,
+    TwoDimensional = 1,
+    ThreeDimensional = 2,
+    All = 3
+}

package/types/ui/enums/CanvasRenderMode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Render mode for ui canvas.
+ */
+export declare enum CanvasRenderMode {
+    ScreenSpaceOverlay = 0,
+    ScreenSpaceCamera = 1,
+    WorldSpace = 2
+}

package/types/ui/enums/ResolutionAdaptationStrategy.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Resolution adaptation strategy.
+ */
+export declare enum ResolutionAdaptationStrategy {
+    WidthAdaptation = 0,
+    HeightAdaptation = 1,
+    BothAdaptation = 2,
+    ExpandAdaptation = 3,
+    ShrinkAdaptation = 4
+}

package/types/ui/index.d.ts

@@ -0,0 +1,6 @@
+export { CanvasRenderMode } from "./enums/CanvasRenderMode";
+export { ResolutionAdaptationStrategy } from "./enums/ResolutionAdaptationStrategy";
+export { UICanvas } from "./UICanvas";
+export { UIRenderer } from "./UIRenderer";
+export { Image } from "./Image";
+export { UITransform } from "./UITransform";

package/types/utils/Pool.d.ts

@@ -0,0 +1,12 @@
+export interface IPoolElement {
+    dispose?(): void;
+}
+export declare class Pool<T extends IPoolElement> {
+    private _type;
+    private _elementPool;
+    private _elementPoolIndex;
+    constructor(type: new () => T, count?: number);
+    alloc(): T;
+    free(element: T): void;
+    dispose(): void;
+}