@rings-webgpu/core 1.0.6 → 1.0.7

package/dist/types/setting/RenderSetting.d.ts

@@ -0,0 +1,51 @@
+import { DepthOfViewSetting } from "./post/DepthOfViewSetting";
+import { GlobalFogSetting } from "./post/GlobalFogSetting";
+import { GTAOSetting } from "./post/GTAOSetting";
+import { OutlineSetting } from "./post/OutlineSetting";
+import { SSRSetting } from "./post/SSRSetting";
+import { TAASetting } from "./post/TAASetting";
+import { BloomSetting } from "./post/BloomSetting";
+import { GodRaySetting } from "./post/GodRaySetting";
+export type RenderSetting = {
+    debug: boolean;
+    renderPassState: number;
+    renderState_left: number;
+    renderState_right: number;
+    renderState_split: number;
+    quadScale: number;
+    hdrExposure: number;
+    debugQuad: number;
+    maxPointLight: number;
+    maxDirectLight: number;
+    maxSportLight: number;
+    drawOpMin: number;
+    drawOpMax: number;
+    drawTrMin: number;
+    drawTrMax: number;
+    zPrePass: boolean;
+    useLogDepth: boolean;
+    useCompressGBuffer: boolean;
+    gi: boolean;
+    postProcessing: {
+        enable?: boolean;
+        bloom?: BloomSetting;
+        ssao?: {
+            debug: any;
+            enable: boolean;
+            radius: number;
+            bias: number;
+            aoPower: number;
+        };
+        ssr?: SSRSetting;
+        taa?: TAASetting;
+        gtao?: GTAOSetting;
+        ssgi?: GTAOSetting;
+        outline?: OutlineSetting;
+        globalFog?: GlobalFogSetting;
+        godRay?: GodRaySetting;
+        fxaa?: {
+            enable: boolean;
+        };
+        depthOfView?: DepthOfViewSetting;
+    };
+};

package/dist/types/setting/ShadowSetting.d.ts

@@ -0,0 +1,17 @@
+export type ShadowSetting = {
+    debug: any;
+    enable: boolean;
+    needUpdate: boolean;
+    autoUpdate: boolean;
+    updateFrameRate: number;
+    type: `PCF` | `HARD` | `SOFT`;
+    pointShadowBias: number;
+    shadowBound?: number;
+    shadowSize: number;
+    shadowBias: number;
+    shadowSoft: number;
+    pointShadowSize: number;
+    csmMargin: number;
+    csmScatteringExp: number;
+    csmAreaScale: number;
+};

package/dist/types/setting/SkySetting.d.ts

@@ -0,0 +1,8 @@
+import { HDRTextureCube } from "../textures/HDRTextureCube";
+export type SkySetting = {
+    type: `HDRSKY` | `ShaderSky`;
+    sky: HDRTextureCube;
+    skyExposure: number;
+    defaultFar: number;
+    defaultNear: number;
+};

package/dist/types/setting/post/BloomSetting.d.ts

@@ -0,0 +1,11 @@
+export type BloomSetting = {
+    enable?: boolean;
+    downSampleStep: number;
+    downSampleBlurSize: number;
+    downSampleBlurSigma: number;
+    upSampleBlurSize: number;
+    upSampleBlurSigma: number;
+    luminanceThreshole: number;
+    bloomIntensity: number;
+    hdr: number;
+};

package/dist/types/setting/post/DepthOfViewSetting.d.ts

@@ -0,0 +1,7 @@
+export type DepthOfViewSetting = {
+    enable: boolean;
+    iterationCount: number;
+    pixelOffset: number;
+    near: number;
+    far: number;
+};

package/dist/types/setting/post/GTAOSetting.d.ts

@@ -0,0 +1,11 @@
+export type GTAOSetting = {
+    enable: boolean;
+    maxDistance: number;
+    maxPixel: number;
+    darkFactor: number;
+    rayMarchSegment: number;
+    multiBounce: boolean;
+    usePosFloat32: boolean;
+    blendColor: boolean;
+    debug: boolean;
+};

package/dist/types/setting/post/GlobalFogSetting.d.ts

@@ -0,0 +1,19 @@
+import { Color } from "../../math/Color";
+export type GlobalFogSetting = {
+    debug: any;
+    enable: boolean;
+    fogType: number;
+    fogHeightScale: number;
+    start: number;
+    end: number;
+    density: number;
+    ins: number;
+    skyFactor: number;
+    skyRoughness: number;
+    overrideSkyFactor: number;
+    fogColor: Color;
+    falloff: number;
+    rayLength: number;
+    scatteringExponent: number;
+    dirHeightLine: number;
+};

package/dist/types/setting/post/GodRaySetting.d.ts

@@ -0,0 +1,7 @@
+export type GodRaySetting = {
+    enable?: boolean;
+    blendColor: boolean;
+    rayMarchCount: number;
+    scatteringExponent: number;
+    intensity: number;
+};

package/dist/types/setting/post/OutlineSetting.d.ts

@@ -0,0 +1,10 @@
+export type OutlineSetting = {
+    enable: boolean;
+    groupCount: number;
+    outlinePixel: number;
+    fadeOutlinePixel: number;
+    strength: number;
+    useAddMode: boolean;
+    textureScale: number;
+    debug: boolean;
+};

package/dist/types/setting/post/SSRSetting.d.ts

@@ -0,0 +1,12 @@
+export type SSRSetting = {
+    debug: any;
+    enable: boolean;
+    pixelRatio: number;
+    fadeEdgeRatio: number;
+    rayMarchRatio: number;
+    fadeDistanceMin: number;
+    fadeDistanceMax: number;
+    roughnessThreshold: number;
+    powDotRN: number;
+    mixThreshold: number;
+};

package/dist/types/setting/post/TAASetting.d.ts

@@ -0,0 +1,9 @@
+export type TAASetting = {
+    enable: boolean;
+    jitterSeedCount: number;
+    blendFactor: number;
+    temporalJitterScale: number;
+    sharpFactor: number;
+    sharpPreBlurFactor: number;
+    debug: boolean;
+};

package/dist/types/shape/BoxGeometry.d.ts

@@ -0,0 +1,28 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+/**
+ * Box geometry
+ * @group Geometry
+ */
+export declare class BoxGeometry extends GeometryBase {
+    /**
+     * box width
+     */
+    width: number;
+    /**
+     * box height
+     */
+    height: number;
+    /**
+     * box depth
+     */
+    depth: number;
+    /**
+     *
+     * @constructor
+     * @param width {number} box width, default value is 1
+     * @param height {number} box height, default value is 1
+     * @param depth {number} box depth, default value is 1
+     */
+    constructor(width?: number, height?: number, depth?: number);
+    private initVertex;
+}

package/dist/types/shape/CylinderGeometry.d.ts

@@ -0,0 +1,60 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+/**
+ * Cylinder geometry
+ * @group Geometry
+ */
+export declare class CylinderGeometry extends GeometryBase {
+    /**
+     * The radius of the top of the cylinder
+     */
+    radiusTop: number;
+    /**
+     * The radius of the bottom of the cylinder
+     */
+    radiusBottom: number;
+    /**
+     * The height of the cylinder
+     */
+    height: number;
+    /**
+     * Number of segments around the side of the cylinder
+     */
+    radialSegments: number;
+    /**
+     * The number of segments along the height of the cylindrical side
+     */
+    heightSegments: number;
+    /**
+     * Indicate whether the bottom surface of the cone is open or capped. The default value is false, which means that the bottom surface is capped by default.
+     */
+    openEnded: boolean;
+    /**
+     * Starting angle of the first segment
+     */
+    thetaStart: number;
+    /**
+     * The center angle of the circular sector on the bottom of the cylinder, with a default value of 2 * PI, makes it a complete cylinder.
+     */
+    thetaLength: number;
+    /**
+     *
+     * @constructor
+     * @param radiusTop
+     * @param radiusBottom
+     * @param height
+     * @param radialSegments
+     * @param heightSegments
+     * @param openEnded
+     * @param thetaStart
+     * @param thetaLength
+     */
+    constructor(radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number, heightSegments?: number, openEnded?: boolean, thetaStart?: number, thetaLength?: number);
+    /**
+     * @internal
+     * @param start
+     * @param count
+     * @param index
+     */
+    private addGroup;
+    protected buildGeometry(): void;
+}

package/dist/types/shape/PlaneGeometry.d.ts

@@ -0,0 +1,11 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+import { Vector3 } from "../math/Vector3";
+export declare class PlaneGeometry extends GeometryBase {
+    width: number;
+    height: number;
+    segmentW: number;
+    segmentH: number;
+    up: Vector3;
+    constructor(width: number, height: number, segmentW?: number, segmentH?: number, up?: Vector3);
+    private buildGeometry;
+}

package/dist/types/shape/SphereGeometry.d.ts

@@ -0,0 +1,25 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+export declare class SphereGeometry extends GeometryBase {
+    shape_vertices: any[];
+    shape_indices: any[];
+    radius: number;
+    widthSegments: number;
+    heightSegments: number;
+    phiStart: number;
+    phiLength: number;
+    thetaStart: number;
+    thetaLength: number;
+    /**
+     * 球体几何体
+     * @constructor
+     * @param radius 球体半径
+     * @param widthSegments 定义水平分段数
+     * @param heightSegments 定义垂直分段数
+     * @param phiStart 球体赤道线起始点的弧度
+     * @param phiLength 球体赤道线的弧长
+     * @param thetaStart 球体经线起始点的弧度
+     * @param thetaLength 球体经线的弧长
+     */
+    constructor(radius: any, widthSegments: any, heightSegments: any, phiStart?: any, phiLength?: any, thetaStart?: any, thetaLength?: any);
+    protected buildGeometry(): void;
+}

package/dist/types/shape/TorusGeometry.d.ts

@@ -0,0 +1,33 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+/**
+ * Torus Geometry
+ * @group Geometry
+ */
+export declare class TorusGeometry extends GeometryBase {
+    /**
+     * Radius of torus
+     */
+    radius: number;
+    /**
+     * Pipe radius
+     */
+    tube: number;
+    /**
+     * Number of torus segments.
+     */
+    radialSegments: number;
+    /**
+     * Number of pipeline segments.
+     */
+    tubularSegments: number;
+    /**
+     *
+     * @constructor
+     * @param radius {number} Radius of torus, default value is 0.4
+     * @param tube {number} Pipe radius, default value is 0.1.
+     * @param radialSegments {number}Number of torus segments, default value is 32.
+     * @param tubularSegments {number} Number of pipeline segments, defualt value is 32.
+     */
+    constructor(radius?: number, tube?: number, radialSegments?: number, tubularSegments?: number);
+    private initVertex;
+}

package/dist/types/shape/TrailGeometry.d.ts

@@ -0,0 +1,18 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+/**
+ * Plane geometry
+ * @group Geometry
+ */
+export declare class TrailGeometry extends GeometryBase {
+    /**
+     * Number of trail segments of a plane
+     */
+    segment: number;
+    private row;
+    /**
+     *
+     * @constructor
+     */
+    constructor(segment: number);
+    private buildGeometry;
+}

package/dist/types/shape/TriGeometry.d.ts

@@ -0,0 +1,13 @@
+import { GeometryBase } from "../core/geometry/GeometryBase";
+/**
+ * @group Geometry
+ */
+export declare class TriGeometry extends GeometryBase {
+    private faceCount;
+    /**
+     *
+     * @constructor
+     */
+    constructor(count: number);
+    private buildGeometry;
+}

package/dist/types/textures/AtmosphericScatteringSky.d.ts

@@ -0,0 +1,42 @@
+import { Texture } from '../gfx/graphics/webGpu/core/texture/Texture';
+import { Color } from '../math/Color';
+import { LDRTextureCube } from './LDRTextureCube';
+/**
+ * AtmosphericScattering Sky Setting
+ * @group Texture
+ */
+export declare class AtmosphericScatteringSkySetting {
+    sunRadius: number;
+    sunRadiance: number;
+    mieG: number;
+    mieHeight: number;
+    eyePos: number;
+    sunX: number;
+    sunY: number;
+    sunBrightness: number;
+    displaySun: boolean;
+    defaultTextureCubeSize: number;
+    defaultTexture2DSize: number;
+    skyColor: Color;
+}
+/**
+ * Atmospheric Scattering Sky Texture
+ * @group Texture
+ */
+export declare class AtmosphericScatteringSky extends LDRTextureCube {
+    private _internalTexture;
+    private _cubeSize;
+    readonly setting: AtmosphericScatteringSkySetting;
+    /**
+     * @constructor
+     * @param setting AtmosphericScatteringSkySetting
+     * @returns
+     */
+    constructor(setting: AtmosphericScatteringSkySetting);
+    get texture2D(): Texture;
+    /**
+     * @internal
+     * @returns
+     */
+    apply(): this;
+}

package/dist/types/textures/BitmapTexture2D.d.ts

@@ -0,0 +1,12 @@
+import { LoaderFunctions } from "../loader/LoaderFunctions";
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class BitmapTexture2D extends Texture {
+    private _source;
+    premultiplyAlpha: PremultiplyAlpha;
+    constructor(useMipmap?: boolean);
+    get source(): HTMLCanvasElement | ImageBitmap | OffscreenCanvas | HTMLImageElement;
+    set source(value: HTMLCanvasElement | ImageBitmap | OffscreenCanvas | HTMLImageElement);
+    load(url: string, loaderFunctions?: LoaderFunctions): Promise<unknown>;
+    private imageData;
+    loadFromBlob(imgData: Blob): Promise<boolean>;
+}

package/dist/types/textures/BitmapTexture2DArray.d.ts

@@ -0,0 +1,15 @@
+import { BitmapTexture2D } from "./BitmapTexture2D";
+import { ITexture } from "../gfx/graphics/webGpu/core/texture/ITexture";
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class BitmapTexture2DArray extends Texture implements ITexture {
+    private _bitmapTextures;
+    constructor(width: number, height: number, numberLayer: number);
+    setTextures(texs: BitmapTexture2D[]): void;
+    addTexture(bitmapTexture: BitmapTexture2D): void;
+    removeTexture(bitmapTexture: BitmapTexture2D): void;
+    private updateTexture;
+    internalCreateBindingLayoutDesc(): void;
+    internalCreateTexture(): void;
+    internalCreateView(): void;
+    internalCreateSampler(): void;
+}

package/dist/types/textures/BitmapTextureCube.d.ts

@@ -0,0 +1,14 @@
+import { TextureCube } from "../gfx/graphics/webGpu/core/texture/TextureCube";
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class BitmapTextureCube extends TextureCube {
+    private _images;
+    private _url;
+    constructor();
+    protected generateImages(images: HTMLCanvasElement[] | ImageBitmap[] | OffscreenCanvas[] | Texture[]): void;
+    private uploadBaseImages;
+    private uploadMipmapGPUTexture;
+    get images(): HTMLCanvasElement[] | ImageBitmap[] | OffscreenCanvas[];
+    set images(value: HTMLCanvasElement[] | ImageBitmap[] | OffscreenCanvas[]);
+    load(urls: string[]): Promise<boolean>;
+    loadStd(url: string): Promise<boolean>;
+}

package/dist/types/textures/Depth2DTextureArray.d.ts

@@ -0,0 +1,9 @@
+import { ITexture } from "../gfx/graphics/webGpu/core/texture/ITexture";
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class Depth2DTextureArray extends Texture implements ITexture {
+    constructor(width: number, height: number, format?: GPUTextureFormat, numberLayer?: number);
+    internalCreateBindingLayoutDesc(): void;
+    internalCreateTexture(): void;
+    internalCreateView(): void;
+    internalCreateSampler(): void;
+}

package/dist/types/textures/DepthCubeArrayTexture.d.ts

@@ -0,0 +1,9 @@
+import { ITexture } from "../gfx/graphics/webGpu/core/texture/ITexture";
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class DepthCubeArrayTexture extends Texture implements ITexture {
+    constructor(width: number, height: number, numberLayer: number);
+    internalCreateBindingLayoutDesc(): void;
+    internalCreateTexture(): void;
+    internalCreateView(): void;
+    internalCreateSampler(): void;
+}

package/dist/types/textures/Float16ArrayTexture.d.ts

@@ -0,0 +1,28 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+/**
+ * @internal
+ * Float16Array texture
+ * @group Texture
+ */
+export declare class Float16ArrayTexture extends Texture {
+    uint16Array: Uint16Array;
+    floatArray: number[];
+    private _dataBuffer;
+    /**
+     * 使用数字数组填充纹理，格式为[红0, 绿0, 蓝0, 透明度0, 红1, 绿1, 蓝1, 透明度1...]
+     * @param width 纹理宽度
+     * @param height 纹理高度
+     * @param numbers 每个像素的颜色值数组
+     * @param useMipmap 是否生成Mipmap
+     * @returns 返回纹理实例
+     */
+    create(width: number, height: number, numbers?: number[], mipmap?: boolean): this;
+    /**
+     * 更新纹理内容
+     * @param width 纹理宽度
+     * @param height 纹理高度
+     * @param numbers 像素数据数组
+     * @param mipmap 是否生成Mipmap
+     */
+    updateTexture(width: number, height: number, numbers: number[], mipmap?: boolean): void;
+}

package/dist/types/textures/Float32ArrayTexture.d.ts

@@ -0,0 +1,5 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class Float32ArrayTexture extends Texture {
+    create(width: number, height: number, data: Float32Array, filtering?: boolean): void;
+    fromBuffer(width: number, height: number, textureDataBuffer: GPUBuffer): this;
+}

package/dist/types/textures/HDRTexture.d.ts

@@ -0,0 +1,7 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+import { LoaderFunctions } from "../loader/LoaderFunctions";
+export declare class HDRTexture extends Texture {
+    constructor();
+    create(width?: number, height?: number, data?: ArrayBuffer, useMipmap?: boolean): this;
+    load(url: string, loaderFunctions?: LoaderFunctions): Promise<HDRTexture>;
+}

package/dist/types/textures/HDRTextureCube.d.ts

@@ -0,0 +1,16 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+import { TextureCube } from "../gfx/graphics/webGpu/core/texture/TextureCube";
+import { LoaderFunctions } from "../loader/LoaderFunctions";
+import { TextureCubeFaceData } from "./TextureCubeFaceData";
+export declare class HDRTextureCube extends TextureCube {
+    private _url;
+    protected _faceData: TextureCubeFaceData;
+    constructor();
+    createFromHDRData(size: number, data: {
+        width: number;
+        height: number;
+        array: Uint8Array;
+    }): this;
+    createFromTexture(size: number, texture: Texture): this;
+    load(url: string, loaderFunctions?: LoaderFunctions): Promise<HDRTextureCube>;
+}

package/dist/types/textures/LDRTextureCube.d.ts

@@ -0,0 +1,13 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+import { TextureCube } from "../gfx/graphics/webGpu/core/texture/TextureCube";
+import { LoaderFunctions } from "../loader/LoaderFunctions";
+import { TextureCubeFaceData } from "./TextureCubeFaceData";
+export declare class LDRTextureCube extends TextureCube {
+    protected _faceData: TextureCubeFaceData;
+    private _url;
+    get ldrImageUrl(): string;
+    constructor();
+    load(url: string, loaderFunctions?: LoaderFunctions): Promise<LDRTextureCube>;
+    private createFromLDRTexture;
+    createFromTexture(size: number, texture: Texture): this;
+}

package/dist/types/textures/RenderTexture.d.ts

@@ -0,0 +1,12 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class RenderTexture extends Texture {
+    resolveTarget: GPUTextureView;
+    sampleCount: number;
+    autoResize?: boolean;
+    clear?: boolean;
+    constructor(width: number, height: number, format?: GPUTextureFormat, useMipMap?: boolean, usage?: GPUFlagsConstant, numberLayer?: number, sampleCount?: number, clear?: boolean, autoResize?: boolean);
+    resize(width: any, height: any): void;
+    create(width: number, height: number, useMiamp?: boolean): void;
+    clone(): RenderTexture;
+    readTextureToImage(): ArrayBuffer;
+}

package/dist/types/textures/SolidColorSky.d.ts

@@ -0,0 +1,11 @@
+import { Color } from "../math/Color";
+import { LDRTextureCube } from "./LDRTextureCube";
+export declare class SolidColorSky extends LDRTextureCube {
+    private _internalTexture;
+    private readonly _minSize;
+    private _skyColor;
+    constructor(color: Color);
+    private changeColor;
+    get color(): Color;
+    set color(value: Color);
+}

package/dist/types/textures/TextureCubeFaceData.d.ts

@@ -0,0 +1,19 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class TextureCubeFaceData {
+    faceTextureRef: {
+        [key: string]: {
+            t: GPUTexture;
+            v: GPUTextureView;
+        };
+    };
+    private _texture;
+    constructor(texture: Texture);
+    uploadTexture(mip: number, texture: Texture): this;
+    uploadErpTexture(texture: Texture): this;
+    getGpuSource(mip: number): {
+        t: GPUTexture;
+        v: GPUTextureView;
+    };
+    private generateMipmap;
+    private generateMipmapAtLevel;
+}

package/dist/types/textures/Uint32ArrayTexture.d.ts

@@ -0,0 +1,11 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+/**
+ * @internal
+ * RGBA32Uint texture backed by Uint32Array
+ * @group Texture
+ */
+export declare class Uint32ArrayTexture extends Texture {
+    private _dataBuffer;
+    create(width: number, height: number, data: Uint32Array): this;
+    updateTexture(width: number, height: number, data: Uint32Array): void;
+}

package/dist/types/textures/Uint8ArrayTexture.d.ts

@@ -0,0 +1,6 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+export declare class Uint8ArrayTexture extends Texture {
+    private _dataBuffer;
+    create(width: number, height: number, data: Uint8Array, useMipmap?: boolean): this;
+    updateTexture(width: number, height: number, data: Uint8Array): void;
+}

package/dist/types/textures/VirtualTexture.d.ts

@@ -0,0 +1,29 @@
+import { Texture } from "../gfx/graphics/webGpu/core/texture/Texture";
+/**
+ * 虚拟纹理 类似于 Three.js 的 WebGLRenderTarget
+ */
+export declare class VirtualTexture extends Texture {
+    resolveTarget: GPUTextureView;
+    sampleCount: number;
+    clone(): VirtualTexture;
+    /**
+     * create virtual texture
+     * @param width width of texture
+     * @param height height of texture
+     * @param format GPUTextureFormat, default value is rgba8unorm
+     * @param useMipmap whether or not gen mipmap
+     * @returns
+     */
+    constructor(width: number, height: number, format?: GPUTextureFormat, useMipMap?: boolean, usage?: GPUFlagsConstant, numberLayer?: number, sampleCount?: number, mipmapCount?: number);
+    resize(width: any, height: any): void;
+    /**
+     * create rt texture
+     * @param width texture width
+     * @param height texture height
+     * @param data  texture pixel data
+     * @param useMipmap texture use mipmap switch
+     * @returns
+     */
+    create(width: number, height: number, useMiamp?: boolean): void;
+    readTextureToImage(): ArrayBuffer;
+}