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

package/package.json

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

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

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

package/types/DisorderedArray.d.ts

@@ -18,10 +18,10 @@ export declare class DisorderedArray<T> {
      */
     deleteByIndex(index: number): T;
     forEach(callbackFn: (element: T) => void, swapFn: (element: T, index: number) => void): void;
-    forEachAndClean(callbackFn: (e: T) => void): void;
+    forEachAndClean(callbackFn: (e: T) => void, swapFn: (element: T, index: number) => void): void;
     sort(compareFn: (a: T, b: T) => number): void;
     garbageCollection(): void;
     private _startLoop;
     private _endLoop;
-    private _endLoopAndClear;
+    private _endLoopAndClean;
 }

package/types/RenderPipeline/BatcherManager.d.ts

@@ -0,0 +1,12 @@
+import { Engine } from "../Engine";
+import { RenderContext } from "./RenderContext";
+import { RenderData } from "./RenderData";
+import { RenderElement } from "./RenderElement";
+export declare class BatcherManager {
+    constructor(engine: Engine);
+    destroy(): void;
+    commitRenderData(context: RenderContext, data: RenderData): void;
+    batch(elements: Array<RenderElement>, batchedElements: Array<RenderElement>): void;
+    uploadBuffer(): void;
+    clear(): void;
+}

package/types/RenderPipeline/DynamicGeometryData.d.ts

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

package/types/RenderPipeline/DynamicGeometryDataManager.d.ts

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

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

@@ -0,0 +1,41 @@
+import { Color } from "@galacean/engine-math";
+import { Sprite, SpriteDrawMode, SpriteTileMode } from "../2d";
+import { RenderElement } from "../RenderPipeline/RenderElement";
+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 _canBatch(elementA: RenderElement, elementB: RenderElement): boolean;
+    protected _batchRenderElement(elementA: RenderElement, elementB?: RenderElement): void;
+    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,49 @@
+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 _canvasHierarchyDirty;
+    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 _onReferenceResolutionChanged;
+    private _onCameraTransformChange;
+    private _onCameraPropertyChange;
+    private _onCanvasSizeChange;
+    private _adapterPoseInScreenSpace;
+    private _adapterSizeInScreenSpace;
+    private _walk;
+    private _addCameraListener;
+    private _addCanvasListener;
+    private _removeCameraListener;
+    private _removeCanvasListener;
+    _onParentChange(seniority: number): void;
+}

package/types/ui/UIRenderer.d.ts

@@ -0,0 +1,20 @@
+import { BoundingBox, Vector4 } from "@galacean/engine-math";
+import { Renderer } from "../Renderer";
+import { UICanvas } from "./UICanvas";
+import { UITransform, UITransformModifyFlags } from "./UITransform";
+export declare class UIRenderer extends Renderer {
+    private static _uiCanvas;
+    protected _canvas: UICanvas;
+    protected _uiTransform: UITransform;
+    protected _localBounds: BoundingBox;
+    protected _rayCastTarget: boolean;
+    protected _rayCastPadding: Vector4;
+    get canvas(): UICanvas;
+    set canvas(val: UICanvas);
+    get rayCastTarget(): boolean;
+    set rayCastTarget(value: boolean);
+    get rayCastPadding(): Vector4;
+    set rayCastPadding(value: Vector4);
+    _onParentChange(seniority: number): void;
+    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;
+}

package/types/Deprecated.d.ts

@@ -1,101 +0,0 @@
-/**
- * @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/texture/enums/PixelFormat.d.ts

@@ -1,73 +0,0 @@
-/**
- * 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
-}