@galacean/engine-core 2.0.0-alpha.44 → 2.0.0-alpha.45

package/package.json

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

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

@@ -1 +1,23 @@
-export {};
+import { Engine } from "../../Engine";
+import { ReferResource } from "../../asset/ReferResource";
+import { Texture2D } from "../../texture/Texture2D";
+import { CharInfo } from "../text/CharInfo";
+/**
+ * @internal
+ */
+export declare class FontAtlas extends ReferResource {
+    texture: Texture2D;
+    _charInfoMap: Record<number, CharInfo>;
+    private _space;
+    private _curX;
+    private _curY;
+    private _nextY;
+    constructor(engine: Engine);
+    uploadCharTexture(charInfo: CharInfo): boolean;
+    addCharInfo(char: string, charInfo: CharInfo): void;
+    getCharInfo(char: string): CharInfo;
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
+}

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

@@ -29,4 +29,12 @@ export declare class SpriteAtlas extends ReferResource {
      * @param engine - Engine to which the SpriteAtlas belongs
      */
     constructor(engine: Engine);
+    /**
+     * @internal
+     */
+    _addSprite(sprite: Sprite): void;
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
 }

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

@@ -1,7 +1,9 @@
-import { Rect, Vector2, Vector4 } from "@galacean/engine-math";
+import { BoundingBox, Rect, Vector2, Vector4 } from "@galacean/engine-math";
 import { Engine } from "../../Engine";
+import { UpdateFlagManager } from "../../UpdateFlagManager";
 import { ReferResource } from "../../asset/ReferResource";
 import { Texture2D } from "../../texture/Texture2D";
+import { SpriteAtlas } from "../atlas/SpriteAtlas";
 /**
  * 2D sprite.
  */
@@ -23,6 +25,10 @@ export declare class Sprite extends ReferResource {
     private _pivot;
     private _border;
     private _dirtyUpdateFlag;
+    /** @internal */
+    _atlas: SpriteAtlas;
+    /** @internal */
+    _updateFlagManager: UpdateFlagManager;
     /**
      * The reference to the used texture.
      */
@@ -96,6 +102,26 @@ export declare class Sprite extends ReferResource {
      * @returns Cloned sprite
      */
     clone(): Sprite;
+    /**
+     * @internal
+     */
+    _getPositions(): Vector2[];
+    /**
+     * @internal
+     */
+    _getUVs(): Vector2[];
+    /**
+     * @internal
+     */
+    _getBounds(): BoundingBox;
+    /**
+     * @internal
+     */
+    _addReferCount(value: number): void;
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
     private _calDefaultSize;
     private _updatePositions;
     private _updateUVs;

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

@@ -1,15 +1,30 @@
 import { BoundingBox } from "@galacean/engine-math";
+import { Entity } from "../../Entity";
+import { PrimitiveChunkManager } from "../../RenderPipeline/PrimitiveChunkManager";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { SubPrimitiveChunk } from "../../RenderPipeline/SubPrimitiveChunk";
+import { RenderElement } from "../../RenderPipeline/RenderElement";
 import { Renderer } from "../../Renderer";
 import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
+import { ShaderProperty } from "../../shader/ShaderProperty";
 import { ISpriteRenderer } from "../assembler/ISpriteRenderer";
 import { Sprite } from "./Sprite";
 /**
  * A component for masking Sprites.
  */
 export declare class SpriteMask extends Renderer implements ISpriteRenderer {
+    /** @internal */
+    static _textureProperty: ShaderProperty;
+    /** @internal */
+    static _alphaCutoffProperty: ShaderProperty;
     /** The mask layers the sprite mask influence to. */
     influenceLayers: SpriteMaskLayer;
+    /** @internal */
+    _renderElement: RenderElement;
+    /** @internal */
+    _subChunk: SubPrimitiveChunk;
+    /** @internal */
+    _maskIndex: number;
     private _sprite;
     private _automaticWidth;
     private _automaticHeight;
@@ -56,10 +71,38 @@ export declare class SpriteMask extends Renderer implements ISpriteRenderer {
      */
     get alphaCutoff(): number;
     set alphaCutoff(value: number);
+    /**
+     * @internal
+     */
+    constructor(entity: Entity);
+    /**
+     * @internal
+     */
+    _updateTransformShaderData(context: RenderContext, onlyMVP: boolean): void;
     /**
      * @inheritdoc
      */
     _onClone(target: SpriteMask): void;
+    /**
+     * @internal
+     */
+    _canBatch(preElement: RenderElement, curElement: RenderElement): boolean;
+    /**
+     * @internal
+     */
+    _batch(preElement: RenderElement | null, curElement: RenderElement): void;
+    /**
+     * @internal
+     */
+    _onEnableInScene(): void;
+    /**
+     * @internal
+     */
+    _onDisableInScene(): void;
+    /**
+     * @internal
+     */
+    _getChunkManager(): PrimitiveChunkManager;
     protected _updateBounds(worldBounds: BoundingBox): void;
     /**
      * @inheritdoc

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

@@ -1,6 +1,11 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
+import { Entity } from "../../Entity";
+import { PrimitiveChunkManager } from "../../RenderPipeline/PrimitiveChunkManager";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { SubPrimitiveChunk } from "../../RenderPipeline/SubPrimitiveChunk";
+import { RenderElement } from "../../RenderPipeline/RenderElement";
 import { Renderer } from "../../Renderer";
+import { ShaderProperty } from "../../shader/ShaderProperty";
 import { ISpriteRenderer } from "../assembler/ISpriteRenderer";
 import { SpriteDrawMode } from "../enums/SpriteDrawMode";
 import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
@@ -11,6 +16,10 @@ import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
  * Renders a Sprite for 2D graphics.
  */
 export declare class SpriteRenderer extends Renderer implements ISpriteRenderer {
+    /** @internal */
+    static _textureProperty: ShaderProperty;
+    /** @internal */
+    _subChunk: SubPrimitiveChunk;
     private _drawMode;
     private _assembler;
     private _tileMode;
@@ -86,10 +95,30 @@ export declare class SpriteRenderer extends Renderer implements ISpriteRenderer
      */
     get maskInteraction(): SpriteMaskInteraction;
     set maskInteraction(value: SpriteMaskInteraction);
+    /**
+     * @internal
+     */
+    constructor(entity: Entity);
+    /**
+     * @internal
+     */
+    _updateTransformShaderData(context: RenderContext, onlyMVP: boolean): void;
     /**
      * @inheritdoc
      */
     _onClone(target: SpriteRenderer): void;
+    /**
+     * @internal
+     */
+    _canBatch(preElement: RenderElement, curElement: RenderElement): boolean;
+    /**
+     * @internal
+     */
+    _batch(preElement: RenderElement | null, curElement: RenderElement): void;
+    /**
+     * @internal
+     */
+    _getChunkManager(): PrimitiveChunkManager;
     protected _updateBounds(worldBounds: BoundingBox): void;
     protected _render(context: RenderContext): void;
     protected _onDestroy(): void;

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

@@ -1 +1,20 @@
-export {};
+import { Vector2 } from "@galacean/engine-math";
+/**
+ * @internal
+ */
+export interface CharInfo {
+    char: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    offsetX: number;
+    offsetY: number;
+    xAdvance: number;
+    ascent: number;
+    descent: number;
+    index: number;
+    data?: Uint8Array;
+    uvs: Vector2[];
+    bufferOffset?: Vector2;
+}

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

@@ -1 +1,15 @@
-export {};
+import { Vector2, Vector4 } from "@galacean/engine-math";
+import { Texture2D } from "../../texture";
+import { IPoolElement } from "../../utils/ObjectPool";
+/**
+ * @internal
+ */
+export declare class CharRenderInfo implements IPoolElement {
+    static triangles: number[];
+    texture: Texture2D;
+    /** x:Top y:Left z:Bottom w:Right */
+    localPositions: Vector4;
+    uvs: Vector2[];
+    indexInChunk: number;
+    dispose(): void;
+}

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

@@ -1,5 +1,7 @@
 import { ReferResource } from "../../asset/ReferResource";
 import { Engine } from "../../Engine";
+import { FontStyle } from "../enums/FontStyle";
+import { SubFont } from "./SubFont";
 /**
  * Font.
  */
@@ -18,4 +20,12 @@ export declare class Font extends ReferResource {
      */
     get name(): string;
     constructor(engine: Engine, name?: string);
+    /**
+     * @internal
+     */
+    _getSubFont(fontSize: number, fontStyle: FontStyle): SubFont;
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
 }

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

@@ -1 +1,35 @@
-export {};
+import { Engine } from "../../Engine";
+import { Texture2D } from "../../texture";
+import { CharInfo } from "./CharInfo";
+/**
+ * @internal
+ */
+export declare class SubFont {
+    nativeFontString: string;
+    private _engine;
+    private _fontAtlases;
+    private _lastIndex;
+    constructor(engine: Engine);
+    destroy(): void;
+    /**
+     * @internal
+     */
+    _uploadCharTexture(charInfo: CharInfo): void;
+    /**
+     * @internal
+     */
+    _addCharInfo(char: string, charInfo: CharInfo): void;
+    /**
+     * @internal
+     */
+    _getCharInfo(char: string): CharInfo;
+    /**
+     * @internal
+     */
+    _getTextureByIndex(index: number): Texture2D;
+    /**
+     * @internal
+     */
+    _getLastIndex(): number;
+    private _createFontAtlas;
+}

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

@@ -1,6 +1,8 @@
 import { BoundingBox, Color } from "@galacean/engine-math";
 import { Entity } from "../../Entity";
+import { PrimitiveChunkManager } from "../../RenderPipeline/PrimitiveChunkManager";
 import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { RenderElement } from "../../RenderPipeline/RenderElement";
 import { Renderer } from "../../Renderer";
 import { TransformModifyFlags } from "../../Transform";
 import { FontStyle } from "../enums/FontStyle";
@@ -9,6 +11,7 @@ import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAli
 import { OverflowMode } from "../enums/TextOverflow";
 import { Font } from "./Font";
 import { ITextRenderer } from "./ITextRenderer";
+import { SubFont } from "./SubFont";
 import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
 /**
  * Renders a text for 2D graphics.
@@ -20,6 +23,10 @@ export declare class TextRenderer extends Renderer implements ITextRenderer {
     private static _worldPositions;
     private static _charRenderInfos;
     private _textChunks;
+    /** @internal */
+    _subFont: SubFont;
+    /** @internal */
+    _dirtyFlag: DirtyFlag;
     private _color;
     private _text;
     private _width;
@@ -114,6 +121,42 @@ export declare class TextRenderer extends Renderer implements ITextRenderer {
      */
     get bounds(): BoundingBox;
     constructor(entity: Entity);
+    /**
+     * @internal
+     */
+    protected _onDestroy(): void;
+    /**
+     * @internal
+     */
+    _isContainDirtyFlag(type: number): boolean;
+    /**
+     * @internal
+     */
+    _setDirtyFlagTrue(type: number): void;
+    /**
+     * @internal
+     */
+    _setDirtyFlagFalse(type: number): void;
+    /**
+     * @internal
+     */
+    _getSubFont(): SubFont;
+    /**
+     * @internal
+     */
+    _updateTransformShaderData(context: RenderContext, onlyMVP: boolean): void;
+    /**
+     * @internal
+     */
+    _canBatch(preElement: RenderElement, curElement: RenderElement): boolean;
+    /**
+     * @internal
+     */
+    _batch(preElement: RenderElement | null, curElement: RenderElement): void;
+    /**
+     * @internal
+     */
+    _getChunkManager(): PrimitiveChunkManager;
     protected _updateBounds(worldBounds: BoundingBox): void;
     protected _render(context: RenderContext): void;
     private _resetSubFont;
@@ -126,3 +169,13 @@ export declare class TextRenderer extends Renderer implements ITextRenderer {
     private _freeTextChunks;
     private _onColorChanged;
 }
+declare enum DirtyFlag {
+    SubFont = 1,
+    LocalPositionBounds = 2,
+    WorldPosition = 4,
+    WorldBounds = 8,
+    Color = 16,
+    Position = 14,
+    Font = 15
+}
+export {};

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

@@ -1 +1,89 @@
-export {};
+import { FontStyle } from "../enums/FontStyle";
+import { CharInfo } from "./CharInfo";
+import { ITextRenderer } from "./ITextRenderer";
+import { SubFont } from "./SubFont";
+/**
+ * @internal
+ * TextUtils includes some helper function for text.
+ */
+export declare class TextUtils {
+    /** @internal */
+    static _genericFontFamilies: string[];
+    /** @internal */
+    static _extendHeight: number;
+    /** These characters are all tall to help calculate the height required for text. */
+    private static _measureString;
+    private static _measureBaseline;
+    private static _heightMultiplier;
+    private static _baselineMultiplier;
+    private static _fontSizeInfoCache;
+    private static _textContext;
+    /**
+     * The instance function to get an object includes 2d context and canvas.
+     * @returns the TextContext object
+     */
+    static textContext(): TextContext;
+    /**
+     * Measure the font.
+     * @param fontString - the string of the font
+     * @returns the font size info
+     */
+    static measureFont(fontString: string): FontSizeInfo;
+    /**
+     * Get native font string.
+     * @param fontName - The font name
+     * @param fontSize - The font size
+     * @param style - The font style
+     * @returns The native font string
+     */
+    static getNativeFontString(fontName: string, fontSize: number, style: FontStyle): string;
+    static measureChar(char: string, fontString: string): CharInfo;
+    static measureTextWithWrap(renderer: ITextRenderer, rendererWidth: number, rendererHeight: number, lineSpacing: number, characterSpacing: number): TextMetrics;
+    static measureTextWithoutWrap(renderer: ITextRenderer, rendererHeight: number, lineSpacing: number, characterSpacing: number): TextMetrics;
+    /**
+     * Get native font hash.
+     * @param fontName - The font name
+     * @param fontSize - The font size
+     * @param style - The font style
+     * @returns The native font hash
+     */
+    static getNativeFontHash(fontName: string, fontSize: number, style: FontStyle): string;
+    /**
+     * @internal
+     */
+    static _measureFontOrChar(fontString: string, measureString: string, isChar: boolean): FontSizeInfo | CharInfo;
+    /**
+     * @internal
+     */
+    static _getCharInfo(char: string, fontString: string, font: SubFont): CharInfo;
+    private static _pushLine;
+}
+/**
+ * @internal
+ * TextContext.
+ */
+export interface TextContext {
+    canvas: HTMLCanvasElement | OffscreenCanvas;
+    context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D;
+}
+/**
+ * @internal
+ * FontSizeInfo.
+ */
+export interface FontSizeInfo {
+    ascent: number;
+    descent: number;
+    size: number;
+}
+/**
+ * @internal
+ * TextMetrics.
+ */
+export interface TextMetrics {
+    width: number;
+    height: number;
+    lines: Array<string>;
+    lineWidths: Array<number>;
+    lineHeight: number;
+    lineMaxSizes?: Array<FontSizeInfo>;
+}

package/types/Background.d.ts

@@ -1,4 +1,5 @@
 import { Color } from "@galacean/engine-math";
+import { Material, ModelMesh } from ".";
 import { Engine } from "./Engine";
 import { BackgroundMode } from "./enums/BackgroundMode";
 import { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
@@ -9,6 +10,8 @@ import { Texture2D } from "./texture";
  */
 export declare class Background {
     private _engine;
+    /** @internal */
+    static _premultiplySolidColor: Color;
     /**
      * Background mode.
      * @defaultValue `BackgroundMode.SolidColor`
@@ -20,6 +23,12 @@ export declare class Background {
      * @remarks When `mode` is `BackgroundMode.Sky`, the property will take effects.
      */
     readonly sky: Sky;
+    /** @internal */
+    _textureFillMode: BackgroundTextureFillMode;
+    /** @internal */
+    _mesh: ModelMesh;
+    /** @internal */
+    _material: Material;
     private _solidColor;
     private _texture;
     /**
@@ -42,11 +51,19 @@ export declare class Background {
      */
     get textureFillMode(): BackgroundTextureFillMode;
     set textureFillMode(value: BackgroundTextureFillMode);
+    /**
+     * @internal
+     */
+    destroy(): void;
     /**
      * Constructor of Background.
      * @param _engine Engine Which the background belongs to.
      */
     constructor(_engine: Engine);
+    /**
+     * @internal
+     */
+    _resizeBackgroundTexture(): void;
     private _initMesh;
     private _initMaterial;
     private _createPlane;

package/types/BasicResources.d.ts

@@ -1,2 +1,54 @@
+import { SpriteMaskInteraction } from "./2d";
+import { Engine } from "./Engine";
+import { RenderQueueMaskType } from "./RenderPipeline/enums/RenderQueueMaskType";
+import { BlinnPhongMaterial, Material } from "./material";
+import { ModelMesh } from "./mesh";
 import { RenderStateElementKey } from "./shader/enums/RenderStateElementKey";
+import { Texture2D, TextureCube } from "./texture";
+import { Texture2DArray } from "./texture/Texture2DArray";
+/**
+ * @internal
+ */
+export declare class BasicResources {
+    engine: Engine;
+    private static _maskReadInsideRenderStates;
+    private static _maskReadOutsideRenderStates;
+    private static _maskWriteIncrementRenderStates;
+    private static _maskWriteDecrementRenderStates;
+    static getMaskInteractionRenderStates(maskInteraction: SpriteMaskInteraction): RenderStateElementMap;
+    static getMaskTypeRenderStates(maskType: RenderQueueMaskType): RenderStateElementMap;
+    /**
+     * Use triangle to blit texture, ref: https://michaldrobot.com/2014/04/01/gcn-execution-patterns-in-full-screen-passes/ .
+     */
+    readonly blitMesh: ModelMesh;
+    readonly flipYBlitMesh: ModelMesh;
+    readonly blitMaterial: Material;
+    readonly blitScreenMaterial: Material;
+    readonly whiteTexture2D: Texture2D;
+    readonly whiteTextureCube: TextureCube;
+    readonly whiteTexture2DArray: Texture2DArray;
+    readonly uintWhiteTexture2D: Texture2D;
+    readonly spriteDefaultMaterial: Material;
+    readonly textDefaultMaterial: Material;
+    readonly spriteMaskDefaultMaterial: Material;
+    readonly meshMagentaMaterial: Material;
+    readonly particleMagentaMaterial: Material;
+    private _blinnPhongMaterial;
+    private _prefilteredDFGTexture;
+    get prefilteredDFGTexture(): Texture2D;
+    constructor(engine: Engine);
+    /**
+     * @internal
+     */
+    _getBlinnPhongMaterial(): BlinnPhongMaterial;
+    /**
+     * @internal
+     */
+    _initialize(): Promise<BasicResources>;
+    private _createBlitMesh;
+    private _create1x1Texture;
+    private _create2DMaterial;
+    private _createMagentaMaterial;
+    private _createSpriteMaskMaterial;
+}
 export type RenderStateElementMap = Record<RenderStateElementKey, number | boolean>;