@rings-webgpu/core 1.0.6 → 1.0.7

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

@@ -0,0 +1,60 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { Matrix3 } from "../../../math/Matrix3";
+import { ComponentBase } from "../../ComponentBase";
+import { IUIInteractive } from "./IUIInteractive";
+/**
+ * 监听 transform
+ * @group GPU GUI
+ */
+export declare class UITransform extends ComponentBase {
+    useParentPivot: boolean;
+    parent: UITransform;
+    pivotX: number;
+    pivotY: number;
+    private _width;
+    private _height;
+    private _localVisible;
+    private _globalVisible;
+    protected _uiInteractiveList: IUIInteractive[];
+    get uiInteractiveList(): IUIInteractive[];
+    constructor();
+    init(param?: any): void;
+    private onTransformChange;
+    addUIInteractive(item: IUIInteractive): this;
+    removeUIInteractive(item: IUIInteractive): IUIInteractive;
+    get globalVisible(): boolean;
+    set visible(value: boolean);
+    get visible(): boolean;
+    protected onUITransformVisible(global: boolean): void;
+    onParentChange(lastParent?: Object3D, currentParent?: Object3D): void;
+    get width(): number;
+    get height(): number;
+    resize(width: number, height: number): boolean;
+    get x(): number;
+    set x(value: number);
+    get y(): number;
+    set y(value: number);
+    setXY(x: number, y: number): void;
+    get z(): number;
+    set z(value: number);
+    get scaleX(): number;
+    set scaleX(value: number);
+    get scaleY(): number;
+    set scaleY(value: number);
+    get scaleZ(): number;
+    set scaleZ(value: number);
+    private _localMatrix;
+    private _worldMatrix;
+    private _onChange;
+    needUpdateQuads: boolean;
+    get onChange(): boolean;
+    private _tempTransforms;
+    set onChange(value: boolean);
+    onEnable(): void;
+    onDisable(): void;
+    setNeedUpdateUIPanel(): void;
+    cloneTo(obj: Object3D): void;
+    matrix(): Matrix3;
+    getWorldMatrix(): Matrix3;
+    beforeDestroy(force?: boolean): void;
+}

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

@@ -0,0 +1,9 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { GUISpace } from "../GUIConfig";
+import { UIPanel } from "./UIPanel";
+export declare class ViewPanel extends UIPanel {
+    readonly isViewPanel = true;
+    readonly space: GUISpace;
+    constructor();
+    cloneTo(obj: Object3D): void;
+}

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

@@ -0,0 +1,13 @@
+import { Object3D } from "../../../core/entities/Object3D";
+import { GUISpace } from "../GUIConfig";
+import { UIPanel } from "./UIPanel";
+export declare class WorldPanel extends UIPanel {
+    readonly isWorldPanel = true;
+    readonly space: GUISpace;
+    private _depthTest;
+    constructor();
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    get depthTest(): boolean;
+    set depthTest(value: boolean);
+}

package/dist/types/components/lights/DirectLight.d.ts

@@ -0,0 +1,13 @@
+import { Camera3D } from "../../core/Camera3D";
+import { LightBase } from "./LightBase";
+export declare class DirectLight extends LightBase {
+    shadowCamera: Camera3D;
+    constructor();
+    init(): void;
+    start(): void;
+    get radius(): number;
+    set radius(value: number);
+    get indirect(): number;
+    set indirect(value: number);
+    debug(): void;
+}

package/dist/types/components/lights/GILighting.d.ts

@@ -0,0 +1,6 @@
+import { ILight } from "./ILight";
+export declare class GILighting {
+    static list: ILight[];
+    static add(light: ILight): void;
+    static remove(light: ILight): void;
+}

package/dist/types/components/lights/IESProfiles.d.ts

@@ -0,0 +1,14 @@
+import { Texture } from "../../gfx/graphics/webGpu/core/texture/Texture";
+import { BitmapTexture2DArray } from "../../textures/BitmapTexture2DArray";
+export declare class IESProfiles {
+    static use: boolean;
+    static iesTexture: BitmapTexture2DArray;
+    static ies_list: IESProfiles[];
+    private _iesTexture;
+    index: number;
+    constructor();
+    private generateIES;
+    set IESTexture(texture: Texture);
+    get IESTexture(): Texture;
+    static create(width: number, height: number): void;
+}

package/dist/types/components/lights/ILight.d.ts

@@ -0,0 +1,12 @@
+import { Camera3D } from "../../core/Camera3D";
+import { Transform } from "../Transform";
+import { LightData } from "./LightData";
+export interface ILight {
+    name: string;
+    transform: Transform;
+    lightData: LightData;
+    needUpdateShadow: boolean;
+    realTimeShadow: boolean;
+    shadowIndex: number;
+    shadowCamera?: Camera3D;
+}

package/dist/types/components/lights/Light.d.ts

@@ -0,0 +1,32 @@
+import { View3D } from "../../core/View3D";
+import { LightBase } from "./LightBase";
+/**
+ * 点光源
+ * @group Lights
+ */
+export declare class Light extends LightBase {
+    constructor();
+    init(): void;
+    /**
+     * 光源影响范围
+     */
+    get range(): number;
+    set range(value: number);
+    /**
+     * 光照衰减的线性系数
+     */
+    get at(): number;
+    set at(value: number);
+    get radius(): number;
+    set radius(value: number);
+    /**
+     * 光照衰减的二次方系数
+     */
+    get quadratic(): number;
+    set quadratic(value: number);
+    start(): void;
+    onUpdate(): void;
+    onGraphic(view?: View3D): void;
+    debug(): void;
+    debugDraw(show: boolean): void;
+}

package/dist/types/components/lights/LightBase.d.ts

@@ -0,0 +1,127 @@
+import { Color } from "../../math/Color";
+import { Vector3 } from "../../math/Vector3";
+import { ComponentBase } from "../ComponentBase";
+import { LightData } from "./LightData";
+import { IESProfiles } from "./IESProfiles";
+import { ILight } from "./ILight";
+export declare class LightBase extends ComponentBase implements ILight {
+    /**
+     * light name
+     */
+    name: string;
+    /**
+     * light size
+     */
+    size: number;
+    /**
+     * light source data
+     */
+    lightData: LightData;
+    /**
+     * fix light direction
+     */
+    dirFix: number;
+    /**
+     * Callback function when binding changes
+     */
+    bindOnChange: () => void;
+    needUpdateShadow: boolean;
+    /**
+     * Whether to enable real-time rendering of shadows
+     */
+    realTimeShadow: boolean;
+    protected _castGI: boolean;
+    protected _castShadow: boolean;
+    private _iesProfiles;
+    constructor();
+    init(): void;
+    protected onChange(): void;
+    start(): void;
+    protected onPositionChange(): void;
+    protected onRotChange(): void;
+    protected onScaleChange(): void;
+    onEnable(): void;
+    onDisable(): void;
+    set iesProfiles(iesProfiles: IESProfiles);
+    get iesProfile(): IESProfiles;
+    /**
+     * Get the red component of the lighting color
+     */
+    get r(): number;
+    /**
+     * Set the red component of the lighting color
+     */
+    set r(value: number);
+    /**
+     * Get the green component of the lighting color
+     */
+    get g(): number;
+    /**
+     * Set the green component of the lighting color
+     */
+    set g(value: number);
+    /**
+     * Get the blue component of the lighting color
+     */
+    get b(): number;
+    /**
+     * Set the blue component of the lighting color
+     */
+    set b(value: number);
+    /**
+     * Get light source color
+     * @return Color
+     */
+    get lightColor(): Color;
+    /**
+     * Set light source color
+     * @param Color
+     */
+    set lightColor(value: Color);
+    /**
+     * Get light source color
+     * @return Color
+     */
+    get color(): Color;
+    /**
+     * Set light source color
+     * @param Color
+     */
+    set color(value: Color);
+    /**
+     * Get Illumination intensity of light source
+     * @return number
+     */
+    get intensity(): number;
+    /**
+     * Set Illumination intensity of light source
+     * @param value
+     */
+    set intensity(value: number);
+    /**
+     * Cast Light Shadow
+     * @param value
+     *  */
+    set castShadow(value: boolean);
+    get castShadow(): boolean;
+    /**
+     * get shadow index at shadow map list
+     */
+    get shadowIndex(): number;
+    /**
+     * get gi is enable
+     * @return boolean
+     *  */
+    get castGI(): boolean;
+    /**
+     * set gi is enable
+     * @param value
+     *  */
+    set castGI(value: boolean);
+    /**
+     * light source direction
+     * @return Vector3
+     *  */
+    get direction(): Vector3;
+    destroy(force?: boolean): void;
+}

package/dist/types/components/lights/LightData.d.ts

@@ -0,0 +1,29 @@
+import { Color } from "../../math/Color";
+import { Vector3 } from "../../math/Vector3";
+import { Struct } from "../../util/struct/Struct";
+export declare enum LightType {
+    None = 0,
+    PointLight = 1,
+    DirectionLight = 2,
+    SpotLight = 3,
+    SkyLight = 4
+}
+export declare class LightData extends Struct {
+    static lightSize: number;
+    index: number;
+    lightType: number;
+    radius: number;
+    linear: number;
+    lightPosition: Vector3;
+    lightMatrixIndex: number;
+    direction: Vector3;
+    quadratic: number;
+    lightColor: Color;
+    intensity: number;
+    innerAngle: number;
+    outerAngle: number;
+    range: number;
+    castShadowIndex: number;
+    lightTangent: Vector3;
+    iesIndex: number;
+}

package/dist/types/components/lights/PointLight.d.ts

@@ -0,0 +1,19 @@
+import { View3D } from "../../core/View3D";
+import { LightBase } from "./LightBase";
+export declare class PointLight extends LightBase {
+    constructor();
+    init(): void;
+    get range(): number;
+    set range(value: number);
+    get at(): number;
+    set at(value: number);
+    get radius(): number;
+    set radius(value: number);
+    get quadratic(): number;
+    set quadratic(value: number);
+    start(): void;
+    onUpdate(): void;
+    onGraphic(view?: View3D): void;
+    debug(): void;
+    debugDraw(show: boolean): void;
+}

package/dist/types/components/lights/SpotLight.d.ts

@@ -0,0 +1,21 @@
+import { View3D } from "../../core/View3D";
+import { LightBase } from "./LightBase";
+export declare class SpotLight extends LightBase {
+    constructor();
+    init(): void;
+    get innerAngle(): number;
+    set innerAngle(value: number);
+    get outerAngle(): number;
+    set outerAngle(value: number);
+    get radius(): number;
+    set radius(value: number);
+    get range(): number;
+    set range(value: number);
+    get at(): number;
+    set at(value: number);
+    start(): void;
+    onUpdate(): void;
+    onGraphic(view: View3D): void;
+    debug(): void;
+    debugDraw(show: boolean): void;
+}

package/dist/types/components/post/PostProcessingComponent.d.ts

@@ -0,0 +1,16 @@
+import { PostBase } from "../../gfx/renderJob/post/PostBase";
+import { Ctor } from "../../util/Global";
+import { ComponentBase } from "../ComponentBase";
+export declare class PostProcessingComponent extends ComponentBase {
+    private _postList;
+    init(param?: any): void;
+    start(): void;
+    stop(): void;
+    onEnable(): void;
+    onDisable(): void;
+    private activePost;
+    private unActivePost;
+    addPost<T extends PostBase>(c: Ctor<T>): T;
+    removePost<T extends PostBase>(c: Ctor<T>): void;
+    getPost<T extends PostBase>(c: Ctor<T>): T;
+}

package/dist/types/components/renderer/GSplatRenderer.d.ts

@@ -0,0 +1,151 @@
+import { RenderNode } from "./RenderNode";
+import { GSplatMaterial } from "../../materials/GSplatMaterial";
+import { View3D } from "../../core/View3D";
+import { RendererPassState } from "../../gfx/renderJob/passRenderer/state/RendererPassState";
+import { ClusterLightingBuffer } from "../../gfx/renderJob/passRenderer/cluster/ClusterLightingBuffer";
+import { PassType } from "../../gfx/renderJob/passRenderer/state/PassType";
+import { GaussianSplatAsset } from "../../loader/parser/3dgs/GaussianSplatAsset";
+import { Uint8ArrayTexture } from "../../textures/Uint8ArrayTexture";
+import { Uint32ArrayTexture } from "../../textures/Uint32ArrayTexture";
+import { Float16ArrayTexture } from "../../textures/Float16ArrayTexture";
+import { Vector2 } from "../../math/Vector2";
+/**
+ * Gaussian Splat Renderer Component
+ *
+ * Renders 3D Gaussian Splats with automatic depth sorting for correct alpha blending.
+ * Manages splat data, textures, and CPU-based sorting via Web Worker.
+ */
+export declare class GSplatRenderer extends RenderNode {
+    count: number;
+    size: Vector2;
+    splatColor: Uint8ArrayTexture;
+    transformA: Uint32ArrayTexture;
+    transformB: Float16ArrayTexture;
+    texParams: Float32Array;
+    splatOrder: Uint32ArrayTexture;
+    gsplatMaterial: GSplatMaterial;
+    private _positions;
+    get positions(): Float32Array;
+    private _worldPositions;
+    private _orderData;
+    private _sortWorker;
+    private _lastSentTime;
+    private _minIntervalMs;
+    private _centersSent;
+    private _lastViewMatrixHash;
+    private _lastCameraSpeed;
+    private _adaptiveSorting;
+    private _lodEnabled;
+    private _lodDistances;
+    private _lodRatios;
+    private _currentLodLevel;
+    private _minPixelCoverage;
+    private _maxPixelCoverage;
+    private _maxPixelCullDistance;
+    private _mapping;
+    private _fullCount;
+    get fullCount(): number;
+    constructor();
+    /**
+     * Initialize from Gaussian Splat asset
+     */
+    initAsset(asset: GaussianSplatAsset): void;
+    /**
+     * Update splat sorting before rendering
+     * This runs every frame to ensure correct depth ordering for alpha blending
+     */
+    onBeforeUpdate(view?: View3D): void;
+    /**
+     * Update LOD level based on camera distance to splat center
+     */
+    private updateLOD;
+    /**
+     * Set rendering subset mapping
+     * Pass null/undefined to cancel mapping
+     */
+    setMapping(mapping?: Uint32Array | null): void;
+    /**
+     * Set visibility boost factor (material uniform tex_params.w)
+     */
+    setVisBoost(v: number): void;
+    /**
+     * Set sort throttle interval (milliseconds)
+     */
+    setSortThrottle(ms: number): void;
+    /**
+     * Enable/disable adaptive sorting (auto-adjust sort frequency based on camera movement)
+     */
+    setAdaptiveSorting(enabled: boolean): void;
+    /**
+     * Enable/disable LOD system
+     */
+    setLOD(enabled: boolean, distances?: number[], ratios?: number[]): void;
+    /**
+     * Get current LOD statistics
+     */
+    getLODStats(): {
+        enabled: boolean;
+        currentLevel: number;
+        distances: number[];
+        ratios: number[];
+        currentRatio: number;
+        visibleCount: number;
+    };
+    /**
+     * Set pixel coverage culling thresholds
+     * @param minPixels Minimum pixel coverage (cull tiny splats), default: 4.0
+     * @param maxPixels Maximum pixel coverage (cull oversized splats), 0 = disabled
+     * @param maxPixelCullDistance Only cull oversized splats within this distance, 0 = always cull, recommended: 3-10
+     */
+    setPixelCulling(minPixels: number, maxPixels?: number, maxPixelCullDistance?: number): void;
+    /**
+     * Get current pixel culling settings
+     */
+    getPixelCullingStats(): {
+        minPixels: number;
+        maxPixels: number;
+        maxPixelCullDistance: number;
+        maxEnabled: boolean;
+        distanceEnabled: boolean;
+    };
+    /**
+     * Calculate texture size for given splat count
+     */
+    private evalTextureSize;
+    /**
+     * Build color texture from asset
+     */
+    private buildColor;
+    /**
+     * Build transform textures from asset
+     */
+    private buildTransform;
+    /**
+     * Update world space positions when transform changes
+     */
+    private updateWorldPositions;
+    /**
+     * Schedule Web Worker-based sorting task
+     */
+    private scheduleOrder;
+    /**
+     * Create Web Worker for sorting
+     */
+    private createSortWorker;
+    /**
+     * Update node before rendering
+     */
+    nodeUpdate(view: View3D, passType: PassType, renderPassState: RendererPassState, clusterLightingBuffer?: ClusterLightingBuffer): void;
+    /**
+     * Render pass
+     */
+    renderPass2(view: View3D, passType: PassType, rendererPassState: RendererPassState, clusterLightingBuffer: ClusterLightingBuffer, encoder: GPURenderPassEncoder, useBundle?: boolean): void;
+    /**
+     * Render pass (fallback)
+     */
+    renderPass(view: View3D, passType: PassType, renderContext: any): void;
+    /**
+     * Clean up resources
+     */
+    destroy(force?: boolean): void;
+}

package/dist/types/components/renderer/GlobalIlluminationComponent.d.ts

@@ -0,0 +1,22 @@
+import { Scene3D } from "../../core/Scene3D";
+import { ComponentBase } from "../ComponentBase";
+/**
+ *
+ * 动态全局光照.
+ * 使用全局光照实现更真实的光照效果。
+ * 全局光照系统可以模拟光线在表面反射或折射到其他表面(间接光照)的方式，
+ * 而不仅限于光线直接从光源照射到某个表面。
+ * @group Components
+ */
+export declare class GlobalIlluminationComponent extends ComponentBase {
+    private _probes;
+    private _volume;
+    private _debugMr;
+    init(scene: Scene3D): void;
+    private initProbe;
+    debug(): void;
+    private debugProbeRay;
+    private changeProbesVolumeData;
+    private changeProbesPosition;
+    onUpdate(): void;
+}

package/dist/types/components/renderer/InstanceDrawComponent.d.ts

@@ -0,0 +1,19 @@
+import { RenderContext } from "../../gfx/renderJob/passRenderer/RenderContext";
+import { RenderNode } from "./RenderNode";
+import { View3D } from "../../core/View3D";
+import { RendererPassState } from "../../gfx/renderJob/passRenderer/state/RendererPassState";
+import { PassType } from "../../gfx/renderJob/passRenderer/state/PassType";
+import { ClusterLightingBuffer } from "../../gfx/renderJob/passRenderer/cluster/ClusterLightingBuffer";
+export declare class InstanceDrawComponent extends RenderNode {
+    private _keyRenderGroup;
+    private _keyBufferGroup;
+    private _keyIdsGroup;
+    constructor();
+    init(param?: any): void;
+    start(): void;
+    reset(): void;
+    nodeUpdate(view: View3D, passType: PassType, renderPassState: RendererPassState, clusterLightingBuffer?: ClusterLightingBuffer): void;
+    renderPass(view: View3D, passType: PassType, renderContext: RenderContext): void;
+    renderItem(view: View3D, passType: PassType, renderNode: RenderNode, renderContext: RenderContext): void;
+    beforeDestroy(force?: boolean): void;
+}

package/dist/types/components/renderer/MeshFilter.d.ts

@@ -0,0 +1,9 @@
+import { GeometryBase, Object3D } from "../..";
+import { MeshRenderer } from "./MeshRenderer";
+export declare class MeshFilter extends MeshRenderer {
+    constructor();
+    get geometry(): GeometryBase;
+    set geometry(value: GeometryBase);
+    cloneTo(obj: Object3D): void;
+    set meshURL(value: string);
+}

package/dist/types/components/renderer/MeshRenderer.d.ts

@@ -0,0 +1,27 @@
+import { Object3D } from "../../core/entities/Object3D";
+import { View3D } from "../../core/View3D";
+import { ClusterLightingBuffer } from "../../gfx/renderJob/passRenderer/cluster/ClusterLightingBuffer";
+import { GeometryBase } from "../../core/geometry/GeometryBase";
+import { RendererPassState } from "../../gfx/renderJob/passRenderer/state/RendererPassState";
+import { PassType } from "../../gfx/renderJob/passRenderer/state/PassType";
+import { MorphTargetData } from "../anim/morphAnim/MorphTargetData";
+import { RenderNode } from "./RenderNode";
+import { Material } from "../../materials/Material";
+export declare class MeshRenderer extends RenderNode {
+    receiveShadow: boolean;
+    morphData: MorphTargetData;
+    constructor();
+    onEnable(): void;
+    onDisable(): void;
+    cloneTo(obj: Object3D): void;
+    copyComponent(from: this): this;
+    get geometry(): GeometryBase;
+    set geometry(value: GeometryBase);
+    get material(): Material;
+    set material(value: Material);
+    setMorphInfluence(key: string, value: number): void;
+    setMorphInfluenceIndex(index: number, value: number): void;
+    onCompute(view: View3D, command: GPUCommandEncoder): void;
+    nodeUpdate(view: View3D, passType: PassType, renderPassState: RendererPassState, clusterLightingBuffer: ClusterLightingBuffer): void;
+    destroy(force?: boolean): void;
+}

package/dist/types/components/renderer/Reflection.d.ts

@@ -0,0 +1,15 @@
+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 { RenderNode } from "./RenderNode";
+export declare class Reflection extends RenderNode {
+    gid: number;
+    needUpdate: boolean;
+    autoUpdate: boolean;
+    radius: number;
+    init(): void;
+    onEnable(): void;
+    onDisable(): void;
+    renderPass2(view: View3D, passType: PassType, rendererPassState: RendererPassState, clusterLightingBuffer: ClusterLightingBuffer, encoder: GPURenderPassEncoder, useBundle?: boolean): void;
+}