@galacean/effects-core 2.10.0-alpha.1 → 2.10.0-alpha.2

package/dist/plugins/particle/particle-mesh.d.ts

@@ -139,11 +139,11 @@ export declare class ParticleMesh implements ParticleMeshData {
     private cachedRotationMatrix;
     private cachedLinearMove;
     private tempMatrix3;
+    private readonly attributeData;
     VERT_MAX_KEY_FRAME_COUNT: number;
     constructor(engine: Engine, props: ParticleMeshProps);
     getPointColor(index: number): number[];
     clearPoints(): void;
-    resetGeometryData(geometry: Geometry): void;
     onUpdate(dt: number): void;
     minusTime(time: number): void;
     removePoint(index: number): void;
@@ -151,6 +151,9 @@ export declare class ParticleMesh implements ParticleMeshData {
     private applyTranslation;
     private applyRotation;
     private applyLinearMove;
+    private getAttributeData;
+    private setAttributeData;
+    private setAttributeSubData;
     private expandArray;
 }
 export declare function getParticleMeshShader(item: spec.ParticleItem, gpuCapability: GPUCapability, env?: string): {

package/dist/plugins/particle/particle-system.d.ts

@@ -171,6 +171,13 @@ export declare class ParticleSystem extends Component implements Maskable {
     private update;
     drawStencilMask(maskRef: number): void;
     onDestroy(): void;
+    /**
+     * @hidden
+     * Internal utility.
+     * Not part of the public API — do not rely on this in your code.
+     */
+    rebuild(): void;
+    dispose(): void;
     getParticleBoxes(): {
         center: Vector3;
         size: Vector3;

package/dist/plugins/particle/trail-mesh.d.ts

@@ -41,6 +41,7 @@ export declare class TrailMesh {
     checkVertexDistance: boolean;
     private pointStart;
     private trailCursors;
+    private readonly attributeData;
     constructor(engine: Engine, props: TrailMeshProps);
     get time(): number;
     set time(t: number);
@@ -52,5 +53,8 @@ export declare class TrailMesh {
     getPointStartPos(index: number): Vector3;
     setPointStartPos(index: number, pos: Vector3): void;
     onUpdate(escapeTime: number): any;
+    private getAttributeData;
+    private setAttributeData;
+    private setAttributeSubData;
 }
 export declare function getTrailMeshShader(trails: spec.ParticleTrail, particleMaxCount: number, name: string, gpuCapability: GPUCapability, env?: string): ShaderWithSource;

package/dist/plugins/shape/shape-component.d.ts

@@ -158,6 +158,7 @@ export declare class ShapeComponent extends RendererComponent implements Maskabl
     getBoundingBox(): BoundingBoxTriangle;
     getBoundingBoxInfo(): BoundingBoxInfo;
     private buildGeometryFromPath;
+    private updateAttributeData;
     private computeScreenScale;
     private buildPath;
     private updateMaterials;

package/dist/plugins/sprite/sprite-item.d.ts

@@ -76,5 +76,6 @@ export declare class SpriteComponent extends MaskableGraphic {
      * 不依赖组件状态，splits 由参数传入（同时存在帧动画与多 split 的数据不存在）。
      */
     protected updateGeometryFromMultiSplit(splits: spec.SplitParameter[]): void;
+    private updateAttributeData;
 }
 export {};

package/dist/render/buffer.d.ts

@@ -0,0 +1,33 @@
+import type { Engine } from '../engine';
+import type { Disposable } from '../utils';
+import type { DataArray } from './data-buffer';
+import { DataBuffer } from './data-buffer';
+import { VertexBuffer } from './vertex-buffer';
+/**
+ * 管理顶点数据及其对应的后端缓冲区。
+ */
+export declare class Buffer implements Disposable {
+    readonly engine: Engine;
+    readonly byteStride: number;
+    private data?;
+    private buffer?;
+    private readonly updatable;
+    private readonly instanced;
+    private readonly divisor;
+    private readonly label?;
+    private isAlreadyOwned;
+    private _isDisposed;
+    constructor(engine: Engine, data: DataArray | DataBuffer, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number, label?: string);
+    get isDisposed(): boolean;
+    get capacity(): number;
+    isUpdatable(): boolean;
+    getData(): DataArray | undefined;
+    getBuffer(): DataBuffer | undefined;
+    getStrideSize(): number;
+    createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
+    create(data?: DataArray): void;
+    update(data: DataArray): void;
+    updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
+    dispose(): void;
+    private getDataBufferOptions;
+}

package/dist/render/data-buffer.d.ts

@@ -0,0 +1,39 @@
+import type * as spec from '@galacean/effects-specification';
+export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
+export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
+export type IndexData = Int32Array | Uint32Array | Uint16Array;
+export declare enum BufferUsage {
+    Stream = 35040,
+    Static = 35044,
+    Dynamic = 35048
+}
+export declare enum BufferDataType {
+    Byte = 5120,
+    UnsignedByte = 5121,
+    Short = 5122,
+    UnsignedShort = 5123,
+    Int = 5124,
+    UnsignedInt = 5125,
+    Float = 5126
+}
+export interface DataBufferOptions {
+    usage: number;
+    type: number;
+    byteStride: number;
+    instanceDivisor: number;
+    label?: string;
+}
+/**
+ * 后端缓冲区的最小抽象，只保存资源状态。
+ */
+export declare class DataBuffer {
+    references: number;
+    capacity: number;
+    is32Bits: boolean;
+    get underlyingResource(): unknown;
+}
+export declare function getBytesPerElement(type: number): number;
+export declare function getDataType(data: DataArray): BufferDataType;
+export declare function getDataByteLength(data: DataArray): number;
+export declare function toBufferView(data: DataArray): ArrayBufferView;
+export declare function createTypedArray(type: number, length: number): spec.TypedArray;

package/dist/render/geometry.d.ts

@@ -1,26 +1,28 @@
-import type * as spec from '@galacean/effects-specification';
+import * as spec from '@galacean/effects-specification';
 import type { Engine } from '../engine';
 import { EffectsObject } from '../effects-object';
-export declare const BYTES_TYPE_MAP: Record<string, number>;
-/**
- * Geometry 的绘制模式
- */
-export type GeometryDrawMode = WebGLRenderingContext['POINTS'] | WebGLRenderingContext['TRIANGLES'] | WebGLRenderingContext['TRIANGLE_STRIP'] | WebGLRenderingContext['TRIANGLE_FAN'] | WebGLRenderingContext['LINES'] | WebGLRenderingContext['LINE_STRIP'] | WebGLRenderingContext['LINE_LOOP'];
+import { Buffer } from './buffer';
+import type { DataBuffer, IndexData, IndicesArray } from './data-buffer';
+import { VertexBuffer } from './vertex-buffer';
+import type { ShaderVariant } from './shader';
+export type GeometryDrawMode = number;
 export type Attribute = spec.AttributeWithData | spec.AttributeWithDataPointer | spec.AttributeWithType | spec.AttributeWithDataSource;
 export interface GeometryProps {
     name?: string;
     attributes: Record<string, Attribute>;
     indices?: {
-        data: spec.TypedArray;
-        releasable?: boolean;
+        data: IndexData;
     };
     mode?: GeometryDrawMode;
     drawCount?: number;
     drawStart?: number;
     instanceCount?: number;
-    bufferUsage?: WebGLRenderingContext['STATIC_DRAW'] | WebGLRenderingContext['DYNAMIC_DRAW'];
     /**
-     * 粒子最大数量，适用于无法更新 GPU 缓存长度的引擎接入
+     * 顶点和索引缓冲区的使用方式，默认使用静态缓冲区。
+     */
+    bufferUsage?: number;
+    /**
+     * 为初始空缓冲区预留的最大顶点数量。
      */
     maxVertex?: number;
 }
@@ -30,93 +32,69 @@ export interface SkinProps {
     inverseBindMatrices?: number[];
 }
 /**
- * Geometry 抽象类
+ * 几何数据、属性布局和绘制范围的后端无关实现。
  */
-export declare abstract class Geometry extends EffectsObject {
-    /**
-     * Geometry 的名称
-     */
+export declare class Geometry extends EffectsObject {
+    static create: (engine: Engine, props?: GeometryProps) => Geometry;
     name: string;
-    /**
-     * 子网格数据
-     */
     subMeshes: spec.SubMesh[];
-    /**
-     * Geometry 创建函数
-     */
-    static create: (engine: Engine, opts?: GeometryProps) => Geometry;
-    /**
-     * 获取 Geometry 的 attribute 数据。
-     * @param name - attribute 名称
-     */
-    abstract getAttributeData(name: string): spec.TypedArray | undefined;
-    /**
-     * 设置 Geometry 的 attribute 数据。
-     * @param name - attribute 名称
-     * @param data - 要设置的 attribute 数据
-     */
-    abstract setAttributeData(name: string, data: spec.TypedArray): void;
-    /**
-     * 设置 attribute 的部分数据，当 attribute 数据只有部分更新时，可调用此函数。
-     * @param name - attribute 名称
-     * @param offset - 更新数据在 attribute 数组的起始位置 index
-     * @param data - 要设置的 attribute 数据
-     */
-    abstract setAttributeSubData(name: string, offset: number, data: spec.TypedArray): void;
-    /**
-     * 获取 attribute 的步长
-     * @param name - attribute 名称
-     */
-    abstract getAttributeStride(name: string): number;
-    /**
-     * 获取当前 Geometry 所有的 attribute 名称。
-     */
-    abstract getAttributeNames(): string[];
-    /**
-     * 获取当前 Geometry 的 indices 数据。
-     */
-    abstract getIndexData(): spec.TypedArray | undefined;
-    /**
-     * 设置 Geometry 的 indices 数据。
-     * @param data - 要设置的 indices 数据
-     */
-    abstract setIndexData(data: spec.TypedArray): void;
-    /**
-     * 设置 indices 的部分数据，当 indices 数据只有部分更新时，可调用此函数。
-     * @param offset - 更新数据在 indices 数组的起始位置 index
-     * @param data - 要设置的 indices 数据
-     */
-    abstract setIndexSubData(offset: number, data: spec.TypedArray): void;
-    /**
-     * 设置 Geometry 绘制的 drawStart
-     * @param value 要设置的 drawStart 值
-     */
-    abstract setDrawStart(count: number): void;
-    /**
-     * 获取当前 Geometry 的 drawStart
-     */
-    abstract getDrawStart(): number;
-    /**
-     * 设置 Geometry 绘制的 drawCount。
-     * @param count 要设置的 drawCount 值
-     */
-    abstract setDrawCount(count: number): void;
-    /**
-     * 获取当前 Geometry 的 drawcount
-     */
-    abstract getDrawCount(): number;
-    /**
-     * 获取当前 Geometry 关联的蒙皮数据
-     */
-    abstract getSkinProps(): SkinProps;
-    /**
-     * 初始化 GPU 资源
-     * @override
-     */
+    /** @hide */
+    mode: GeometryDrawMode;
+    /** @hide */
+    instanceCount: number;
+    private vertexBuffers;
+    private indices;
+    private drawCount;
+    private drawStart;
+    private skin;
+    private indexBuffer?;
+    private disposed;
+    private initialized;
+    private options?;
+    private bufferUsage;
+    private vertexArrayObjects?;
+    /** @hide */
+    constructor(engine: Engine, props?: GeometryProps);
+    /** @hide */
+    isDisposed(): boolean;
+    /** @hide */
+    getVertexBuffer(name: string): VertexBuffer | undefined;
+    /** @hide */
+    setVerticesBuffer(vertexBuffer: VertexBuffer, disposeExistingBuffer?: boolean): void;
+    /** @hide */
+    getAttributeBuffer(name: string): Buffer | undefined;
+    getAttributeData(name: string): spec.TypedArray | undefined;
+    setAttributeData(name: string, data: spec.TypedArray): void;
+    setAttributeSubData(name: string, offset: number, data: spec.TypedArray): void;
+    getAttributeStride(name: string): number;
+    getAttributeNames(): string[];
+    /** @hide */
+    getIndexBuffer(): DataBuffer | undefined;
+    getIndexData(): IndexData;
+    /** @hide */
+    getIndexType(): number;
+    setIndexData(data: IndicesArray): void;
+    setIndexSubData(offset: number, data: IndicesArray): void;
+    setDrawStart(start: number): void;
+    getDrawStart(): number;
+    setDrawCount(count: number): void;
+    getDrawCount(): number;
+    getSkinProps(): SkinProps;
+    /** @hide */
+    bind(shader: ShaderVariant): void;
+    private releaseVertexArrayObject;
     initialize(): void;
-    /**
-     * 几何数据刷新
-     */
     flush(): void;
+    /** @hide */
+    restore(): void;
+    fromData(data: spec.GeometryData): void;
+    dispose(): void;
+    private processProps;
+    private releaseCurrentBuffers;
+    private disposeVertexArrayObjects;
+    private createIndexBuffer;
+    private releaseIndexBuffer;
+    private forEachVertexBuffer;
 }
-export declare function generateEmptyTypedArray(type: number): Float32Array | Int16Array | Int32Array;
+export declare const BYTES_TYPE_MAP: Record<string, number>;
+export declare function generateEmptyTypedArray(type: number): spec.TypedArray;

package/dist/render/gpu-capability.d.ts

@@ -14,6 +14,8 @@ export interface GPUCapabilityDetail {
     maxTextureAnisotropy: number;
     shaderTextureLod: boolean;
     instanceDraw?: boolean;
+    /** @hide */
+    vertexArrayObject?: boolean;
     ktx2Support: boolean;
     drawBuffers?: boolean;
     asyncShaderCompile: boolean;

package/dist/render/graphics.d.ts

@@ -62,6 +62,7 @@ export declare class Graphics {
      * 提交当前累积的顶点到 renderer，清空缓冲(批次内部 flush 不重置 batchType)
      */
     private flushBatch;
+    private updateAttributeData;
     /**
      * 线段顶点按顺序连接 (p0-p1, p1-p2, p2-p3, ...)
      * @param points - 点数组，格式 [x1,y1,x2,y2,...]，至少需要2个点(4个数值)

package/dist/render/index.d.ts

@@ -7,6 +7,9 @@ export * from './shader';
 export * from './gpu-capability';
 export * from './mesh';
 export * from './geometry';
+export * from './data-buffer';
+export * from './buffer';
+export * from './vertex-buffer';
 export * from './framebuffer';
 export * from './renderer';
 export * from './graphics';

package/dist/render/shader.d.ts

@@ -57,8 +57,9 @@ export interface SharedShaderWithSource {
 export type ShaderWithSource = SharedShaderWithSource;
 export declare abstract class ShaderVariant extends EffectsObject {
     readonly source: ShaderWithSource;
+    readonly key: string;
     shader: Shader;
-    constructor(engine: Engine, source: ShaderWithSource);
+    constructor(engine: Engine, source: ShaderWithSource, key: string);
     initialize(): void;
     abstract setFloat(name: string, value: number): void;
     abstract setInt(name: string, value: number): void;

package/dist/render/vertex-buffer.d.ts

@@ -0,0 +1,72 @@
+import type * as spec from '@galacean/effects-specification';
+import type { Engine } from '../engine';
+import type { Disposable } from '../utils';
+import { Buffer } from './buffer';
+import type { DataArray, DataBuffer } from './data-buffer';
+import { BufferDataType } from './data-buffer';
+export interface VertexBufferProps {
+    updatable?: boolean;
+    postponeInternalCreation?: boolean;
+    stride?: number;
+    instanced?: boolean;
+    offset?: number;
+    size?: number;
+    type?: number;
+    normalized?: boolean;
+    useBytes?: boolean;
+    divisor?: number;
+    takeBufferOwnership?: boolean;
+    label?: string;
+}
+/**
+ * 描述一个顶点属性如何读取共享缓冲区。
+ */
+export declare class VertexBuffer implements Disposable {
+    static readonly PositionKind = "aPos";
+    static readonly NormalKind = "aNormal";
+    static readonly TangentKind = "aTangent";
+    static readonly UVKind = "aUV";
+    static readonly UV2Kind = "aUV2";
+    static readonly UV3Kind = "aUV3";
+    static readonly UV4Kind = "aUV4";
+    static readonly UV5Kind = "aUV5";
+    static readonly UV6Kind = "aUV6";
+    static readonly ColorKind = "aColor";
+    static readonly JointsKind = "aJoints";
+    static readonly WeightsKind = "aWeights";
+    static readonly BYTE = BufferDataType.Byte;
+    static readonly UNSIGNED_BYTE = BufferDataType.UnsignedByte;
+    static readonly SHORT = BufferDataType.Short;
+    static readonly UNSIGNED_SHORT = BufferDataType.UnsignedShort;
+    static readonly INT = BufferDataType.Int;
+    static readonly UNSIGNED_INT = BufferDataType.UnsignedInt;
+    static readonly FLOAT = BufferDataType.Float;
+    readonly byteStride: number;
+    readonly byteOffset: number;
+    readonly normalized: boolean;
+    readonly type: spec.BufferType;
+    readonly engine: Engine;
+    private readonly kind;
+    private readonly size;
+    private _isDisposed;
+    private instanced;
+    private _instanceDivisor;
+    constructor(engine: Engine, data: DataArray | Buffer | DataBuffer, kind: string, props?: VertexBufferProps);
+    get isDisposed(): boolean;
+    get instanceDivisor(): number;
+    set instanceDivisor(value: number);
+    getKind(): string;
+    isUpdatable(): boolean;
+    getData(): DataArray | undefined;
+    getBuffer(): DataBuffer | undefined;
+    getWrapperBuffer(): Buffer;
+    getStrideSize(): number;
+    getOffset(): number;
+    getSize(sizeInBytes?: boolean): number;
+    getIsInstanced(): boolean;
+    getInstanceDivisor(): number;
+    create(data?: DataArray): void;
+    update(data: DataArray): void;
+    updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
+    dispose(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.10.0-alpha.1",
+  "version": "2.10.0-alpha.2",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",