@rings-webgpu/core 1.0.6 → 1.0.7

package/dist/types/components/gui/GUIPickHelper.d.ts

@@ -0,0 +1,25 @@
+import { Matrix4 } from "../../math/Matrix4";
+import { Ray } from "../../math/Ray";
+import { Vector2 } from "../../math/Vector2";
+import { UITransform } from "./uiComponents/UITransform";
+import { GUISpace } from "./GUIConfig";
+import { GUIHitInfo } from "./uiComponents/IUIInteractive";
+/**
+ * @internal
+ * @group GPU GUI
+ */
+export declare class GUIPickHelper {
+    private static _pt0;
+    private static _pt1;
+    private static _pt2;
+    private static _pt3;
+    private static _hitPoint;
+    private static _worldMatrix;
+    private static _ray;
+    private static _triangle;
+    private static _isInit;
+    private static init;
+    static rayPick(ray: Ray, screenPos: Vector2, screenSize: Vector2, space: GUISpace, panelRatio: number, uiTransform: UITransform, worldMatrix: Matrix4): GUIHitInfo;
+    private static calculateHotArea_View;
+    private static calculateHotArea_World;
+}

package/dist/types/components/gui/core/GUIAtlasTexture.d.ts

@@ -0,0 +1,16 @@
+import { GUISprite } from "./GUISprite";
+import { GUITexture } from "./GUITexture";
+import { Vector2 } from "../../../math/Vector2";
+export declare class GUIAtlasTexture {
+    private _spriteMap;
+    private _spriteList;
+    readonly textureSize: Vector2;
+    name: string;
+    constructor(size: {
+        x: number;
+        y: number;
+    });
+    setTexture(srcTexture: GUITexture, id: string, detail: any): GUISprite;
+    getSprite(id: string): GUISprite;
+    get spriteList(): GUISprite[];
+}

package/dist/types/components/gui/core/GUICanvas.d.ts

@@ -0,0 +1,21 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { ComponentBase } from "../../ComponentBase";
+export declare class GUICanvas extends ComponentBase {
+    readonly isGUICanvas: boolean;
+    index: number;
+    /**
+     *
+     * Add an Object3D
+     * @param child Object3D
+     * @returns
+     */
+    addChild(child: Object3D): this;
+    /**
+     *
+     * Remove the child
+     * @param child Removed Object3D
+     */
+    removeChild(child: Object3D): this;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+}

package/dist/types/components/gui/core/GUIDefine.d.ts

@@ -0,0 +1,7 @@
+export declare enum GUIQuadAttrEnum {
+    NONE = 0,
+    POSITION = 1,//1 位运算
+    SPRITE = 2,//2
+    COLOR = 4,//4
+    MAX = 7
+}

package/dist/types/components/gui/core/GUIGeometry.d.ts

@@ -0,0 +1,36 @@
+import { GeometryBase } from "../../../core/geometry/GeometryBase";
+import { StorageGPUBuffer } from "../../../gfx/graphics/webGpu/core/buffer/StorageGPUBuffer";
+import { Vector3 } from "../../../math/Vector3";
+import { UITransform } from "../uiComponents/UITransform";
+import { GUIQuad } from "./GUIQuad";
+/**
+ * composite geometry of gui, holding and updating attribute data
+ * @group GPU GUI
+ */
+export declare class GUIGeometry extends GeometryBase {
+    private _attributeUV;
+    private _attributeVIndex;
+    private _faceIndexes;
+    private _uvSize;
+    private _vIndexSize;
+    private _posAttribute;
+    private _spriteAttribute;
+    private _colorAttribute;
+    private _onPositionChange;
+    private _onSpriteChange;
+    private _onColorChange;
+    readonly maxQuadCount: number;
+    constructor(max: number);
+    updateSubGeometry(index: number, start: number, count: number): import("../../..").SubGeometry;
+    resetSubGeometries(): void;
+    updateBounds(min?: Vector3, max?: Vector3): this;
+    getPositionBuffer(): StorageGPUBuffer;
+    getSpriteBuffer(): StorageGPUBuffer;
+    getColorBuffer(): StorageGPUBuffer;
+    create(): this;
+    private createBuffer;
+    fillQuad(quad: GUIQuad, transform: UITransform): void;
+    private fillQuadPosition;
+    private fillQuadColor;
+    private fillQuadSprite;
+}

package/dist/types/components/gui/core/GUIGeometryRebuild.d.ts

@@ -0,0 +1,21 @@
+import { UITransform } from "../uiComponents/UITransform";
+import { UIPanel } from "../uiComponents/UIPanel";
+/**
+ * 检查和重建GUI网格(包括几何体和材质)，处理UI元素的批量渲染优化
+ * @group GPU GUI
+ */
+export declare class GUIGeometryRebuild {
+    private _textureMap;
+    private _textureList;
+    /**
+     * 重建指定的GUI网格
+     * 检查并重建GUI网格，包括几何体和材质
+     * @param transforms 指定GUI Mesh的UITransform列表
+     * @param panel 指定要重建几何体的GUI Mesh对象
+     * @param forceUpdate 是否需要强制重构
+     * @returns 返回构建结果(单个UIPanel的GUIMaterials支持的纹理数量有限制，不能超过限制)
+     */
+    build(transforms: UITransform[], panel: UIPanel, forceUpdate: boolean): boolean;
+    private collectQuads;
+    private push;
+}

package/dist/types/components/gui/core/GUIMaterial.d.ts

@@ -0,0 +1,29 @@
+import { Texture } from "../../../gfx/graphics/webGpu/core/texture/Texture";
+import { Material } from "../../../materials/Material";
+import { GUISpace } from "../GUIConfig";
+/**
+ * 材质相关
+ * @group GPU GUI
+ */
+export declare class GUIMaterial extends Material {
+    private _scissorRect;
+    private _screenSize;
+    private _scissorEnable;
+    constructor(space: GUISpace);
+    private addColorPass;
+    setPanelRatio(pixelRatio: number): void;
+    setScissorRect(left: number, bottom: number, right: number, top: number): void;
+    setScissorEnable(value: boolean): void;
+    setScissorCorner(radius: number, fadeOut: number): void;
+    setScreenSize(width: number, height: number): this;
+    setTextures(list: Texture[]): void;
+    private _videoTextureFlags;
+    private setVideoTextureDefine;
+    set envMap(texture: Texture);
+    set shadowMap(texture: Texture);
+    set baseMap(texture: Texture);
+    set normalMap(value: Texture);
+    set emissiveMap(value: Texture);
+    set irradianceMap(value: Texture);
+    set irradianceDepthMap(value: Texture);
+}

package/dist/types/components/gui/core/GUIQuad.d.ts

@@ -0,0 +1,52 @@
+import { UITransform } from "../uiComponents/UITransform";
+import { GUIGeometry } from "./GUIGeometry";
+import { GUISprite } from "./GUISprite";
+import { ImageType } from "../GUIConfig";
+import { Color } from "../../../math/Color";
+import { PoolNode } from "../../../core/pool/ObjectPool";
+import { GUIQuadAttrEnum } from "./GUIDefine";
+/**
+ * 图形界面最小单位
+ * @group GPU GUI
+ */
+export declare class GUIQuad {
+    x: number;
+    y: number;
+    z: number;
+    width: number;
+    height: number;
+    private _globalX;
+    private _globalY;
+    private _globalWidth;
+    private _globalHeight;
+    private _visible;
+    private _offsetX;
+    private _offsetY;
+    protected _sprite: GUISprite;
+    private _color;
+    private _imageType;
+    dirtyAttributes: GUIQuadAttrEnum;
+    cacheTextureId: number;
+    private static textPool;
+    static get quadPool(): PoolNode<GUIQuad>;
+    static recycleQuad(quad: GUIQuad): void;
+    static spawnQuad(): GUIQuad;
+    get imageType(): ImageType;
+    set imageType(value: ImageType);
+    get color(): Color;
+    set color(value: Color);
+    get visible(): boolean;
+    set visible(value: boolean);
+    get sprite(): GUISprite;
+    set sprite(value: GUISprite);
+    get left(): number;
+    get right(): number;
+    get top(): number;
+    get bottom(): number;
+    setSize(width: number, height: number): void;
+    setXY(x: number, y: number): void;
+    setAttrChange(attr: GUIQuadAttrEnum): void;
+    applyTransform(transform: UITransform): this;
+    private getQuadMatrix;
+    writeToGeometry(guiGeometry: GUIGeometry, transform: UITransform): this;
+}

package/dist/types/components/gui/core/GUIRenderer.d.ts

@@ -0,0 +1,15 @@
+import { GeometryBase } from "../../..";
+import { View3D } from "../../../core/View3D";
+import { ClusterLightingBuffer } from "../../../gfx/renderJob/passRenderer/cluster/ClusterLightingBuffer";
+import { RendererPassState } from "../../../gfx/renderJob/passRenderer/state/RendererPassState";
+import { PassType } from "../../../gfx/renderJob/passRenderer/state/PassType";
+import { MeshRenderer } from "../../renderer/MeshRenderer";
+import { GUIGeometry } from "./GUIGeometry";
+export declare class GUIRenderer extends MeshRenderer {
+    protected _guiGeometry: GUIGeometry;
+    init(param?: any): void;
+    get geometry(): GeometryBase;
+    set geometry(value: GeometryBase);
+    nodeUpdate(view: View3D, rendererType: PassType, renderPassState: RendererPassState, clusterLightingBuffer: ClusterLightingBuffer): void;
+    onUpdate(view?: View3D): void;
+}

package/dist/types/components/gui/core/GUIShader.d.ts

@@ -0,0 +1,8 @@
+export declare class GUIShader {
+    private static bindTextureArray;
+    private static sampleTexture;
+    private static readonly fs;
+    private static readonly GUI_common_vs;
+    static readonly GUI_shader_view: string;
+    static readonly GUI_shader_world: string;
+}

package/dist/types/components/gui/core/GUISprite.d.ts

@@ -0,0 +1,19 @@
+import { Vector2 } from "../../../math/Vector2";
+import { Vector4 } from "../../../math/Vector4";
+import { GUITexture } from "./GUITexture";
+export declare class GUISprite {
+    id: string;
+    guiTexture: GUITexture;
+    uvRec: Vector4;
+    uvBorder: Vector4;
+    offsetSize: Vector4;
+    borderSize: Vector4;
+    trimSize: Vector2;
+    isSliced: boolean;
+    height: number;
+    width: number;
+    xadvance: number;
+    xoffset: number;
+    yoffset: number;
+    constructor(texture?: GUITexture);
+}

package/dist/types/components/gui/core/GUITexture.d.ts

@@ -0,0 +1,12 @@
+import { Texture } from "../../../gfx/graphics/webGpu/core/texture/Texture";
+export declare class GUITexture {
+    private static _maxUid;
+    private readonly _staticId;
+    dynamicId: number;
+    texture: Texture;
+    width: number;
+    height: number;
+    get staticId(): number;
+    constructor(texture: Texture);
+    private init;
+}

package/dist/types/components/gui/uiComponents/IUIInteractive.d.ts

@@ -0,0 +1,25 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Ray } from "../../../math/Ray";
+import { Vector2 } from "../../../math/Vector2";
+import { Vector3 } from "../../../math/Vector3";
+export declare enum UIInteractiveStyle {
+    NORMAL = 0,
+    DOWN = 1,
+    OVER = 2,
+    DISABLE = 3
+}
+export type GUIHitInfo = {
+    intersectPoint?: Vector3;
+    distance: number;
+    collider?: IUIInteractive;
+};
+export interface IUIInteractive {
+    interactive: boolean;
+    enable: boolean;
+    visible: boolean;
+    object3D?: Object3D;
+    get interactiveVisible(): boolean;
+    rayPick(ray: Ray, panel: any, screenPos: Vector2, screenSize: Vector2): GUIHitInfo;
+    destroy(): void;
+    set mouseStyle(value: UIInteractiveStyle);
+}

package/dist/types/components/gui/uiComponents/TextFieldLayout.d.ts

@@ -0,0 +1,34 @@
+import { GUIQuad } from "../core/GUIQuad";
+import { UITextField } from "./UITextField";
+export declare enum TextAnchor {
+    UpperLeft = 0,
+    UpperCenter = 1,
+    UpperRight = 2,
+    MiddleLeft = 3,
+    MiddleCenter = 4,
+    MiddleRight = 5,
+    LowerLeft = 6,
+    LowerCenter = 7,
+    LowerRight = 8
+}
+export declare enum Vertical {
+    Upper = 0,
+    Middle = 1,
+    Lower = 2
+}
+export declare enum Horizontal {
+    Left = 0,
+    Center = 1,
+    Right = 2
+}
+export declare class TextFieldLine {
+    charList: string[];
+    quadList: GUIQuad[];
+    width: number;
+    index: number;
+}
+export declare class TextFieldLayout {
+    layout(target: UITextField): TextFieldLine[];
+    private makeTextLine;
+    private getAlignment;
+}

package/dist/types/components/gui/uiComponents/UIButton.d.ts

@@ -0,0 +1,45 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Color } from "../../../math/Color";
+import { ImageType } from "../GUIConfig";
+import { GUISprite } from "../core/GUISprite";
+import { UIInteractiveStyle } from "./IUIInteractive";
+import { UIImage } from "./UIImage";
+import { UIInteractive } from "./UIInteractive";
+export declare enum UIButtonTransition {
+    NONE = 0,
+    COLOR = 1,
+    SPRITE = 2
+}
+/**
+ * The basic components used in the GUI to respond to user interaction behavior and have an image component
+ * @group GPU GUI
+ */
+export declare class UIButton extends UIInteractive {
+    protected _spriteMap: Map<UIInteractiveStyle, GUISprite>;
+    protected _colorMap: Map<UIInteractiveStyle, Color>;
+    protected _image: UIImage;
+    private _isCreateImage;
+    private _transition;
+    init(param?: any): void;
+    onEnable(): void;
+    onDisable(): void;
+    set transition(value: UIButtonTransition);
+    get transition(): UIButtonTransition;
+    get imageType(): ImageType;
+    set imageType(value: ImageType);
+    setStyleColor(style: UIInteractiveStyle, color: Color): this;
+    getStyleColor(style: UIInteractiveStyle): Color;
+    set mouseStyle(value: UIInteractiveStyle);
+    get normalSprite(): GUISprite;
+    set normalSprite(value: GUISprite);
+    get overSprite(): GUISprite;
+    set overSprite(value: GUISprite);
+    set downSprite(value: GUISprite);
+    get downSprite(): GUISprite;
+    set disableSprite(value: GUISprite);
+    get disableSprite(): GUISprite;
+    protected validateStyle(style: UIInteractiveStyle, force?: boolean): void;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    destroy(): void;
+}

package/dist/types/components/gui/uiComponents/UIComponentBase.d.ts

@@ -0,0 +1,15 @@
+import { ComponentBase } from "../../ComponentBase";
+import { UITransform } from "./UITransform";
+export declare class UIComponentBase extends ComponentBase {
+    protected _uiTransform: UITransform;
+    protected _visible: boolean;
+    destroy(): void;
+    get uiTransform(): UITransform;
+    get visible(): boolean;
+    set visible(value: boolean);
+    init(param?: any): void;
+    protected onUITransformVisible?(visible: boolean): void;
+    protected onUIComponentVisible?(visible: boolean): void;
+    protected onTransformResize?(): void;
+    copyComponent(from: this): this;
+}

package/dist/types/components/gui/uiComponents/UIImage.d.ts

@@ -0,0 +1,21 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Color } from "../../../math/Color";
+import { GUISprite } from "../core/GUISprite";
+import { ImageType } from "../GUIConfig";
+import { UIRenderAble } from "./UIRenderAble";
+export declare class UIImage extends UIRenderAble {
+    init(param?: any): void;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    set sprite(value: GUISprite);
+    protected onTransformResize(): void;
+    private applyTransformSize;
+    get sprite(): GUISprite;
+    protected onUIComponentVisible(visible: boolean): void;
+    protected onUITransformVisible(visible: boolean): void;
+    private applyComponentVisible;
+    get color(): Color;
+    set color(value: Color);
+    get imageType(): ImageType;
+    set imageType(value: ImageType);
+}

package/dist/types/components/gui/uiComponents/UIImageGroup.d.ts

@@ -0,0 +1,31 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Color } from "../../../math/Color";
+import { GUIQuad } from "../core/GUIQuad";
+import { GUISprite } from "../core/GUISprite";
+import { ImageType } from "../GUIConfig";
+import { UIRenderAble } from "./UIRenderAble";
+import { Vector2 } from "../../../math/Vector2";
+/**
+ * images/sprites/videos
+ * @group GPU GUI
+ */
+export declare class UIImageGroup extends UIRenderAble {
+    private _count;
+    constructor();
+    init(param?: any): void;
+    getQuad(index: number): GUIQuad;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    setSprite(index: number, value: GUISprite): void;
+    getSprite(index: number): GUISprite;
+    protected onUIComponentVisible(visible: boolean): void;
+    protected onUITransformVisible(visible: boolean): void;
+    private applyComponentVisible;
+    getColor(index: number): Color;
+    setColor(index: number, value: Color): void;
+    getImageType(index: number): ImageType;
+    setImageType(index: number, value: ImageType): void;
+    setSize(index: number, width: number, height: number): void;
+    setXY(index: number, x: number, y: number): void;
+    getXY(index: number, ret?: Vector2): Vector2;
+}

package/dist/types/components/gui/uiComponents/UIInteractive.d.ts

@@ -0,0 +1,25 @@
+import { UIComponentBase } from "./UIComponentBase";
+import { IUIInteractive, UIInteractiveStyle, GUIHitInfo } from "./IUIInteractive";
+import { Vector2 } from "../../../math/Vector2";
+import { Ray } from "../../../math/Ray";
+import { Object3D } from "../../../core/entities/Object3D";
+import { UIPanel } from "./UIPanel";
+/**
+ * 基本交互能力
+ * @group GPU GUI
+ */
+export declare class UIInteractive extends UIComponentBase implements IUIInteractive {
+    protected _style: UIInteractiveStyle;
+    protected _interactive: boolean;
+    set interactive(value: boolean);
+    get interactive(): boolean;
+    /**设置鼠标悬停时的样式 */
+    set mouseStyle(value: UIInteractiveStyle);
+    /**判断组件是否可见且可交互 */
+    get interactiveVisible(): boolean;
+    init(param?: any): void;
+    destroy(): void;
+    rayPick(ray: Ray, panel: UIPanel, screenPos: Vector2, screenSize: Vector2): GUIHitInfo;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+}

package/dist/types/components/gui/uiComponents/UIPanel.d.ts

@@ -0,0 +1,38 @@
+import { View3D } from "../../../core/View3D";
+import { Object3D } from "../../../core/entities/Object3D";
+import { BillboardComponent } from "../../BillboardComponent";
+import { BillboardType } from "../GUIConfig";
+import { GUIGeometry } from "../core/GUIGeometry";
+import { GUIRenderer } from "../core/GUIRenderer";
+import { UIImage } from "./UIImage";
+export declare class UIPanel extends UIImage {
+    readonly space: number;
+    needUpdateGeometry: boolean;
+    panelOrder: number;
+    needSortOnCameraZ?: boolean;
+    protected _billboard: BillboardComponent;
+    private _rebuild;
+    scissorEnable: boolean;
+    scissorCornerRadius: number;
+    scissorFadeOutSize: number;
+    protected _uiRenderer: GUIRenderer;
+    protected _geometry: GUIGeometry;
+    protected _maxCount: number;
+    panelRatio: number;
+    readonly isUIPanel = true;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    init(param?: any): void;
+    updateDrawCallSegment(index: number, indexStart: number, indexCount: number): void;
+    private create;
+    get quadMaxCount(): number;
+    get renderer(): GUIRenderer;
+    set billboard(type: BillboardType);
+    get billboard(): BillboardType;
+    set cullMode(value: GPUCullMode);
+    get cullMode(): GPUCullMode;
+    onUpdate(view?: View3D): void;
+    private _collectTransform;
+    private rebuildGUIMesh;
+    private updateGUIPixelRatio;
+}

package/dist/types/components/gui/uiComponents/UIRenderAble.d.ts

@@ -0,0 +1,27 @@
+import { UIComponentBase } from "./UIComponentBase";
+import { GUIQuad } from "../core/GUIQuad";
+/**
+ * The basic class of render able GUI component
+ * @group GPU GUI
+ */
+export declare class UIRenderAble extends UIComponentBase {
+    protected _mainQuads: GUIQuad[];
+    protected _shadowRender: UIRenderAble;
+    protected _shadowSource: UIRenderAble;
+    isUIShadow?: boolean;
+    isShadowless?: boolean;
+    needUpdateShadow: boolean;
+    init(param?: any): void;
+    destroy(): void;
+    start(): void;
+    protected setShadowDirty(): void;
+    get mainQuads(): GUIQuad[];
+    setShadowRenderer(value: UIRenderAble): void;
+    setShadowSource(value: UIRenderAble): void;
+    getShadowRender(): UIRenderAble;
+    protected autoBindShadow(source: UIRenderAble, shadow: UIRenderAble): boolean;
+    protected recycleQuad(quad?: GUIQuad): GUIQuad;
+    protected attachQuad(quad: GUIQuad): this;
+    protected detachQuads(): this;
+    copyComponent(from: this): this;
+}

package/dist/types/components/gui/uiComponents/UIShadow.d.ts

@@ -0,0 +1,31 @@
+import { View3D } from "../../../core/View3D";
+import { Object3D } from "../../../core/entities/Object3D";
+import { Color } from "../../../math/Color";
+import { Vector2 } from "../../../math/Vector2";
+import { UIRenderAble } from "./UIRenderAble";
+/**
+ * 阴影
+ * @group GPU GUI
+ */
+export declare class UIShadow extends UIRenderAble {
+    private _shadowQuality;
+    private _shadowOffset;
+    private _shadowRadius;
+    private _shadowColor;
+    private _subShadowColor;
+    needUpdateShadow: boolean;
+    init(param?: any): void;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    get shadowColor(): Color;
+    set shadowColor(value: Color);
+    set shadowQuality(value: number);
+    get shadowQuality(): number;
+    set shadowOffset(value: Vector2);
+    get shadowOffset(): Vector2;
+    set shadowRadius(value: number);
+    get shadowRadius(): number;
+    onUpdate(view?: View3D): void;
+    private applyShadow;
+    private createQuadShadow;
+}

package/dist/types/components/gui/uiComponents/UITextField.d.ts

@@ -0,0 +1,36 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Color } from "../../../math/Color";
+import { UIRenderAble } from "./UIRenderAble";
+import { TextAnchor } from "./TextFieldLayout";
+export declare class UITextField extends UIRenderAble {
+    private _font;
+    private _fontSize;
+    private _originSize;
+    private _alignment;
+    private _lineSpacing;
+    private _text;
+    private readonly _color;
+    constructor();
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    get originSize(): number;
+    get font(): string;
+    set font(value: string);
+    get fontSize(): number;
+    set fontSize(value: number);
+    get text(): string;
+    set text(value: string);
+    private textLine;
+    private layoutProxy;
+    private layoutText;
+    protected onUIComponentVisible(visible: boolean): void;
+    protected onUITransformVisible(visible: boolean): void;
+    private applyComponentVisible;
+    protected onTransformResize(): void;
+    get color(): Color;
+    set color(value: Color);
+    get alignment(): TextAnchor;
+    set alignment(value: TextAnchor);
+    get lineSpacing(): number;
+    set lineSpacing(value: number);
+}