@galacean/engine-core 0.0.0-experimental-double11.4 → 0.0.0-experimental-double11.5

package/types/graphic/BufferUtil.d.ts

@@ -4,6 +4,7 @@ export interface ElementInfo {
     size: number;
     type: DataType;
     normalized: boolean;
+    normalizedScaleFactor: number;
 }
 export declare class BufferUtil {
     static _getGLIndexType(indexFormat: IndexFormat): DataType;

package/types/graphic/Mesh.d.ts

@@ -1,12 +1,12 @@
 import { BoundingBox } from "@galacean/engine-math";
 import { Engine } from "../Engine";
-import { GraphicsResource } from "../asset/GraphicsResource";
+import { ReferResource } from "../asset/ReferResource";
 import { SubMesh } from "../graphic/SubMesh";
 import { MeshTopology } from "../graphic/enums/MeshTopology";
 /**
  * Mesh.
  */
-export declare abstract class Mesh extends GraphicsResource {
+export declare abstract class Mesh extends ReferResource {
     /** Name. */
     name: string;
     private _bounds;
@@ -54,6 +54,5 @@ export declare abstract class Mesh extends GraphicsResource {
      */
     clearSubMesh(): void;
     _addReferCount(value: number): void;
-    _rebuild(): void;
     private _onBoundsChanged;
 }

package/types/graphic/VertexElement.d.ts

@@ -4,16 +4,16 @@ import { VertexElementFormat } from "./enums/VertexElementFormat";
  * Vertex element.
  */
 export declare class VertexElement {
-    _glElementInfo: ElementInfo;
-    private _semantic;
+    _formatMetaInfo: ElementInfo;
+    private _attributeName;
     private _offset;
     private _format;
     private _bindingIndex;
     private _instanceStepRate;
     /**
-     * Vertex semantic.
+     * Vertex attribute.
      */
-    get semantic(): string;
+    get attribute(): string;
     /**
      * Vertex data byte offset.
      */
@@ -34,11 +34,15 @@ export declare class VertexElement {
     get instanceStepRate(): number;
     /**
      * Create vertex element.
-     * @param semantic - Input vertex semantic
+     * @param attribute - Input attribute
      * @param offset - Vertex data byte offset
      * @param format - Vertex data format
      * @param bindingIndex - Vertex buffer binding index
      * @param instanceStepRate - Instance cadence, the number of instances drawn for each vertex in the buffer, non-instance elements must be 0.
      */
-    constructor(semantic: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    constructor(attribute: string, offset: number, format: VertexElementFormat, bindingIndex: number, instanceStepRate?: number);
+    /**
+     * @deprecated use `attributeName` instead
+     */
+    get semantic(): string;
 }

package/types/graphic/index.d.ts

@@ -11,3 +11,4 @@ export { Mesh } from "./Mesh";
 export { SubMesh } from "./SubMesh";
 export { VertexBufferBinding } from "./VertexBufferBinding";
 export { VertexElement } from "./VertexElement";
+export { Primitive } from "./Primitive";

package/types/index.d.ts

@@ -26,6 +26,7 @@ export * from "./RenderPipeline/index";
 export * from "./base";
 export { Background } from "./Background";
 export { BackgroundMode } from "./enums/BackgroundMode";
+export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
 export { ColorSpace } from "./enums/ColorSpace";

package/types/input/InputManager.d.ts

@@ -1,7 +1,7 @@
+import { Vector3 } from "@galacean/engine-math";
 import { Keys } from "./enums/Keys";
-import { Pointer } from "./pointer/Pointer";
 import { PointerButton } from "./enums/PointerButton";
-import { Vector3 } from "@galacean/engine-math";
+import { Pointer } from "./pointer/Pointer";
 /**
  * InputManager manages device input such as mouse, touch, keyboard, etc.
  */

package/types/lighting/DirectLight.d.ts

@@ -7,7 +7,6 @@ export declare class DirectLight extends Light {
     private static _cullingMaskProperty;
     private static _colorProperty;
     private static _directionProperty;
-    private static _combinedData;
     private _reverseDirection;
     /**
      * Get direction.
@@ -18,3 +17,11 @@ export declare class DirectLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of direct lights in the scene.
+ */
+export interface IDirectLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    direction: Float32Array;
+}

package/types/lighting/Light.d.ts

@@ -6,10 +6,6 @@ import { ShadowType } from "../shadow";
  * Light base class.
  */
 export declare abstract class Light extends Component {
-    /**
-     * Each type of light source is at most 10, beyond which it will not take effect.
-     * */
-    protected static _maxLight: number;
     /** Light Intensity */
     intensity: number;
     /**

package/types/lighting/LightManager.d.ts

@@ -2,5 +2,12 @@
  * Light manager.
  */
 export declare class LightManager {
+    /**
+     * Each type of light source is at most 10, beyond which it will not take effect.
+     * */
+    private static _maxLight;
+    private _directData;
+    private _pointData;
+    private _spotData;
     private _getSunLightIndex;
 }

package/types/lighting/PointLight.d.ts

@@ -8,7 +8,6 @@ export declare class PointLight extends Light {
     private static _colorProperty;
     private static _positionProperty;
     private static _distanceProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /**
@@ -16,3 +15,12 @@ export declare class PointLight extends Light {
      */
     get position(): Vector3;
 }
+/**
+ * Shader properties data of point lights in the scene.
+ */
+export interface IPointLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    distance: Float32Array;
+}

package/types/lighting/SpotLight.d.ts

@@ -11,7 +11,6 @@ export declare class SpotLight extends Light {
     private static _distanceProperty;
     private static _angleCosProperty;
     private static _penumbraCosProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /** Angle, in radians, from centre of spotlight where falloff begins. */
@@ -33,3 +32,15 @@ export declare class SpotLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of spot lights in the scene.
+ */
+export interface ISpotLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    direction: Float32Array;
+    distance: Float32Array;
+    angleCos: Float32Array;
+    penumbraCos: Float32Array;
+}

package/types/mesh/BufferMesh.d.ts

@@ -27,10 +27,10 @@ export declare class BufferMesh extends Mesh {
     setVertexElements(elements: VertexElement[]): void;
     /**
      * Set vertex buffer binding.
-     * @param vertexBufferBindings - Vertex buffer binding
+     * @param vertexBufferBinding - Vertex buffer binding
      * @param index - Vertex buffer index, the default value is 0
      */
-    setVertexBufferBinding(vertexBufferBindings: VertexBufferBinding, index?: number): void;
+    setVertexBufferBinding(vertexBufferBinding: VertexBufferBinding, index?: number): void;
     /**
      * Set vertex buffer binding.
      * @param vertexBuffer - Vertex buffer

package/types/mesh/ModelMesh.d.ts

@@ -5,6 +5,7 @@ import { Mesh } from "../graphic/Mesh";
 import { VertexBufferBinding } from "../graphic/VertexBufferBinding";
 import { VertexElement } from "../graphic/VertexElement";
 import { BlendShape } from "./BlendShape";
+import { VertexAttribute } from "./enums/VertexAttribute";
 /**
  * Mesh containing common vertex elements of the model.
  */
@@ -15,12 +16,8 @@ export declare class ModelMesh extends Mesh {
     private static _tempVec3;
     private static _tempVec4;
     private _vertexCount;
-    private _readable;
-    private _verticesFloat32;
-    private _verticesUint8;
-    private _indices;
-    private _indicesFormat;
-    private _indicesChangeFlag;
+    private _vertexCountDirty;
+    private _dataVersionCounter;
     private _positions;
     private _normals;
     private _colors;
@@ -35,18 +32,20 @@ export declare class ModelMesh extends Mesh {
     private _uv7;
     private _boneWeights;
     private _boneIndices;
-    private _bufferStrides;
-    private _vertexBufferUpdateFlag;
-    private _vertexDataUpdateFlag;
-    private _vertexElementsUpdate;
-    private _customVertexElements;
-    private _vertexCountChanged;
-    /**
-     * Whether to read data of the mesh.
-     */
-    get readable(): boolean;
+    private _advancedElementUpdateFlag;
+    private _advancedDataUpdateFlag;
+    private _advancedVertexDataVersions;
+    private _advancedDataSyncToBuffer;
+    private _internalVertexBufferStride;
+    private _internalVertexBufferCreatedInfo;
+    private _internalVertexElementsOffset;
+    private _internalVertexElementsFlags;
+    private _vertexBufferInfos;
+    private _indices;
+    private _indicesFormat;
+    private _indicesChangeFlag;
     /**
-     * Vertex count of current mesh.
+     * Vertex count of mesh.
      */
     get vertexCount(): number;
     /**
@@ -56,7 +55,7 @@ export declare class ModelMesh extends Mesh {
     /**
      * Vertex buffer binding collection.
      */
-    get vertexBufferBindings(): Readonly<VertexBufferBinding[]>;
+    get vertexBufferBindings(): ReadonlyArray<VertexBufferBinding>;
     /**
      * BlendShapes of this ModelMesh.
      */
@@ -73,7 +72,7 @@ export declare class ModelMesh extends Mesh {
     constructor(engine: Engine, name?: string);
     /**
      * Set positions for the mesh.
-     * @param positions - The positions for the mesh.
+     * @param positions - The positions for the mesh
      */
     setPositions(positions: Vector3[] | null): void;
     /**
@@ -83,7 +82,7 @@ export declare class ModelMesh extends Mesh {
     getPositions(): Vector3[] | null;
     /**
      * Set per-vertex normals for the mesh.
-     * @param normals - The normals for the mesh.
+     * @param normals - The normals for the mesh
      */
     setNormals(normals: Vector3[] | null): void;
     /**
@@ -93,7 +92,7 @@ export declare class ModelMesh extends Mesh {
     getNormals(): Vector3[] | null;
     /**
      * Set per-vertex colors for the mesh.
-     * @param colors - The colors for the mesh.
+     * @param colors - The colors for the mesh
      */
     setColors(colors: Color[] | null): void;
     /**
@@ -103,27 +102,27 @@ export declare class ModelMesh extends Mesh {
     getColors(): Color[] | null;
     /**
      * Set per-vertex bone weights for the mesh.
-     * @param boneWeights - The bone weights for the mesh.
+     * @param boneWeights - The bone weights for the mesh
      */
     setBoneWeights(boneWeights: Vector4[] | null): void;
     /**
-     * Get weights for the mesh.
+     * Get bone weights for the mesh.
      * @remarks Please call the setWeights() method after modification to ensure that the modification takes effect.
      */
     getBoneWeights(): Vector4[] | null;
     /**
      * Set per-vertex bone indices for the mesh.
-     * @param boneIndices - The bone indices for the mesh.
+     * @param boneIndices - The bone indices for the mesh
      */
     setBoneIndices(boneIndices: Vector4[] | null): void;
     /**
-     * Get joints for the mesh.
+     * Get bone indices for the mesh.
      * @remarks Please call the setBoneIndices() method after modification to ensure that the modification takes effect.
      */
     getBoneIndices(): Vector4[] | null;
     /**
      * Set per-vertex tangents for the mesh.
-     * @param tangents - The tangents for the mesh.
+     * @param tangents - The tangents for the mesh
      */
     setTangents(tangents: Vector4[] | null): void;
     /**
@@ -133,13 +132,13 @@ export declare class ModelMesh extends Mesh {
     getTangents(): Vector4[] | null;
     /**
      * Set per-vertex uv for the mesh.
-     * @param uv - The uv for the mesh.
+     * @param uv - The uv for the mesh
      */
     setUVs(uv: Vector2[] | null): void;
     /**
      * Set per-vertex uv for the mesh by channelIndex.
-     * @param uv - The uv for the mesh.
-     * @param channelIndex - The index of uv channels, in [0 ~ 7] range.
+     * @param uv - The uv for the mesh
+     * @param channelIndex - The index of uv channels, in [0 ~ 7] range
      */
     setUVs(uv: Vector2[] | null, channelIndex: number): void;
     /**
@@ -155,7 +154,7 @@ export declare class ModelMesh extends Mesh {
     getUVs(channelIndex: number): Vector2[] | null;
     /**
      * Set indices for the mesh.
-     * @param indices - The indices for the mesh.
+     * @param indices - The indices for the mesh
      */
     setIndices(indices: Uint8Array | Uint16Array | Uint32Array): void;
     /**
@@ -163,21 +162,20 @@ export declare class ModelMesh extends Mesh {
      */
     getIndices(): Uint8Array | Uint16Array | Uint32Array;
     /**
-     * @beta
-     * @todo Update buffer should support custom vertex elements.
      * Set vertex elements.
      * @param elements - Vertex element collection
+     *
+     * @remarks
+     * Call this method will clear the vertex data set by the setPositions(), setNormals(), setColors(), setBoneWeights(), setBoneIndices(), setTangents(), setUVs() methods.
      */
     setVertexElements(elements: VertexElement[]): void;
     /**
-     * @beta
      * Set vertex buffer binding.
-     * @param vertexBufferBindings - Vertex buffer binding
+     * @param vertexBufferBinding - Vertex buffer binding
      * @param index - Vertex buffer index, the default value is 0
      */
-    setVertexBufferBinding(vertexBufferBindings: VertexBufferBinding, index?: number): void;
+    setVertexBufferBinding(vertexBufferBinding: VertexBufferBinding, index?: number): void;
     /**
-     * @beta
      * Set vertex buffer binding.
      * @param vertexBuffer - Vertex buffer
      * @param stride - Vertex buffer data stride
@@ -190,6 +188,12 @@ export declare class ModelMesh extends Mesh {
      * @param firstIndex - First vertex buffer index, the default value is 0
      */
     setVertexBufferBindings(vertexBufferBindings: VertexBufferBinding[], firstIndex?: number): void;
+    /**
+     * Get `VertexElement` by attribute.
+     * @param attribute - Vertex attribute
+     * @returns Vertex element
+     */
+    getVertexElement(attribute: VertexAttribute): VertexElement | null;
     /**
      * Add a BlendShape for this ModelMesh.
      * @param blendShape - The BlendShape
@@ -206,21 +210,45 @@ export declare class ModelMesh extends Mesh {
      */
     getBlendShapeName(index: number): string;
     /**
-     * Upload Mesh Data to GPU.
-     * @param noLongerReadable - Whether to read data later. If true, you'll never read data anymore (free memory cache)
+     * Upload data to GPU set by `setPositions()`, `setNormals()`, `setColors()`, `setBoneWeights()`, `setBoneIndices()`, `setTangents()`, `setUVs()`, `setIndices()` methods.
+     * This method will be auto generate vertex element and vertex buffer binding if needed.
+     *
+     * @param releaseData - Whether to release the data cache, release data can reduce memory usage.
      */
-    uploadData(noLongerReadable: boolean): void;
+    uploadData(releaseData: boolean): void;
     /**
      * Calculate mesh tangent.
      * @remark need to set positions(with or not with indices), normals, uv before calculation.
      * @remark based on http://foundationsofgameenginedev.com/FGED2-sample.pdf
      */
     calculateTangents(): void;
-    private _supplementaryVertexElements;
+    private _getVertexElementData;
+    private _beforeSetAdvancedVertexData;
+    private _updateAdvancedVertexDataMarks;
+    private _updateInternalVertexBuffer;
+    private _readVector2VertexData;
+    private _readVector3VertexData;
+    private _readVector4VertexData;
+    private _readColorVertexData;
+    private _readVertexData;
+    private _updateAdvancedVertexElement;
+    private _updateAdvancedVertexElements;
     private _updateVertexElements;
-    private _updateVertices;
-    private _insertVertexAttribute;
+    private _writeVector2AdvancedVertexData;
+    private _writeVector3AdvancedVertexData;
+    private _writeVector4AdvancedVertexData;
+    private _writeColorAdvancedVertexData;
+    private _writeAdvancedVertexData;
+    private _updateAdvancedVertices;
+    private _getInternalVertexBufferIndex;
     private _getAttributeFormat;
     private _getAttributeByteLength;
     private _releaseCache;
+    /** @deprecated */
+    private _accessible;
+    /**
+     * @deprecated
+     * Whether to access data of the mesh.
+     */
+    get accessible(): boolean;
 }

package/types/mesh/PrimitiveMesh.d.ts

@@ -1,9 +1,11 @@
 import { Engine } from "../Engine";
+import { Buffer } from "../graphic/Buffer";
 import { ModelMesh } from "./ModelMesh";
 /**
  * Used to generate common primitive meshes.
  */
 export declare class PrimitiveMesh {
+    private static _tempVec30;
     /**
      * Create a sphere mesh.
      * @param engine - Engine
@@ -80,8 +82,8 @@ export declare class PrimitiveMesh {
      * @returns Capsule model mesh
      */
     static createCapsule(engine: Engine, radius?: number, height?: number, radialSegments?: number, heightSegments?: number, noLongerAccessible?: boolean): ModelMesh;
-    static _setCylinderData(cylinderMesh: ModelMesh, radiusTop: number, radiusBottom: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean): void;
-    static _setCapsuleData(capsuleMesh: ModelMesh, radius: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean): void;
+    static _setCylinderData(cylinderMesh: ModelMesh, radiusTop: number, radiusBottom: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean, restoreVertexBuffer?: Buffer): void;
+    static _setCapsuleData(capsuleMesh: ModelMesh, radius: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean, restoreVertexBuffer?: Buffer): void;
     private static _initialize;
     private static _generateIndices;
     private static _createCapsuleCap;

package/types/mesh/Skin.d.ts

@@ -1,5 +1,6 @@
 import { Matrix } from "@galacean/engine-math";
 import { EngineObject } from "../base/EngineObject";
+import { Entity } from "../Entity";
 /**
  * Mesh skin data, equal glTF skins define
  */
@@ -8,6 +9,8 @@ export declare class Skin extends EngineObject {
     inverseBindMatrices: Matrix[];
     joints: string[];
     skeleton: string;
+    _rootBone: Entity;
+    _bones: Entity[];
     /**
      * Constructor of skin
      * @param name - name

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -9,27 +9,20 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private static _jointCountProperty;
     private static _jointSamplerProperty;
     private static _jointMatrixProperty;
-    private _hasInitSkin;
     private _jointDataCreateCache;
-    private _skin;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
     private _rootBone;
     private _localBounds;
     private _jointMatrices;
     private _jointTexture;
-    private _jointEntities;
+    private _bones;
     /**
      * The weights of the BlendShapes.
      * @remarks Array index is BlendShape index.
      */
     get blendShapeWeights(): Float32Array;
     set blendShapeWeights(value: Float32Array);
-    /**
-     * Skin Object.
-     */
-    get skin(): Skin;
-    set skin(value: Skin);
     /**
      * Local bounds.
      */
@@ -40,9 +33,25 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get rootBone(): Entity;
     set rootBone(value: Entity);
-    private _initSkin;
-    private _computeApproximateBindMatrix;
-    private _findByEntityName;
+    /**
+     * Bones of the SkinnedMeshRenderer.
+     */
+    get bones(): ReadonlyArray<Entity>;
+    set bones(value: ReadonlyArray<Entity>);
     private _checkBlendShapeWeightLength;
     private _onLocalBoundsChanged;
+    private _getEntityHierarchyPath;
+    private _skin;
+    /**
+     * @deprecated
+     * Skin Object.
+     *
+     * If you want get `skeleton`, use {@link SkinnedMeshRenderer.rootBone} instead.
+     * If you want get `bones`, use {@link SkinnedMeshRenderer.bones} instead.
+     * `inverseBindMatrices` will migrate to mesh in the future.
+     *
+     * @remarks `rootBone` and `bones` will not update when `skin` changed.
+     */
+    get skin(): Skin;
+    set skin(value: Skin);
 }

package/types/mesh/index.d.ts

@@ -1,8 +1,9 @@
+export { BlendShape } from "./BlendShape";
+export { BlendShapeFrame } from "./BlendShapeFrame";
+export { BufferMesh } from "./BufferMesh";
+export { MeshRenderer } from "./MeshRenderer";
 export { ModelMesh } from "./ModelMesh";
+export { PrimitiveMesh } from "./PrimitiveMesh";
 export { Skin } from "./Skin";
-export { MeshRenderer } from "./MeshRenderer";
 export { SkinnedMeshRenderer } from "./SkinnedMeshRenderer";
-export { PrimitiveMesh } from "./PrimitiveMesh";
-export { BufferMesh } from "./BufferMesh";
-export { BlendShape } from "./BlendShape";
-export { BlendShapeFrame } from "./BlendShapeFrame";
+export { VertexAttribute } from "./enums/VertexAttribute";

package/types/particle/ParticleGenerator.d.ts

@@ -1,4 +1,3 @@
-import { ParticleRenderer } from "./ParticleRenderer";
 import { ParticleStopMode } from "./enums/ParticleStopMode";
 import { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
 import { EmissionModule } from "./modules/EmissionModule";
@@ -47,7 +46,6 @@ export declare class ParticleGenerator {
      */
     get randomSeed(): number;
     set randomSeed(value: number);
-    constructor(renderer: ParticleRenderer);
     /**
      * Start emitting particles.
      * @param withChildren - Whether to start the particle generator of the child entity