@galacean/engine-core 1.6.8 → 1.6.9

package/types/mesh/ModelMesh.d.ts

@@ -0,0 +1,254 @@
+import { Color, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
+import { Engine } from "../Engine";
+import { Buffer } from "../graphic/Buffer";
+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.
+ */
+export declare class ModelMesh extends Mesh {
+    private static _tempVec0;
+    private static _tempVec1;
+    private static _tempVec2;
+    private static _tempVec3;
+    private static _tempVec4;
+    private _vertexCount;
+    private _vertexCountDirty;
+    private _dataVersionCounter;
+    private _positions;
+    private _normals;
+    private _colors;
+    private _tangents;
+    private _uv;
+    private _uv1;
+    private _uv2;
+    private _uv3;
+    private _uv4;
+    private _uv5;
+    private _uv6;
+    private _uv7;
+    private _boneWeights;
+    private _boneIndices;
+    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 mesh.
+     */
+    get vertexCount(): number;
+    /**
+     * Vertex element collection.
+     */
+    get vertexElements(): Readonly<VertexElement[]>;
+    /**
+     * Vertex buffer binding collection.
+     */
+    get vertexBufferBindings(): ReadonlyArray<VertexBufferBinding>;
+    /**
+     * BlendShapes of this ModelMesh.
+     */
+    get blendShapes(): Readonly<BlendShape[]>;
+    /**
+     * BlendShape count of this ModelMesh.
+     */
+    get blendShapeCount(): number;
+    /**
+     * Create a model mesh.
+     * @param engine - Engine to which the mesh belongs
+     * @param name - Mesh name
+     */
+    constructor(engine: Engine, name?: string);
+    /**
+     * Set positions for the mesh.
+     * @param positions - The positions for the mesh
+     */
+    setPositions(positions: Vector3[] | null): void;
+    /**
+     * Get positions for the mesh.
+     * @remarks Please call the setPositions() method after modification to ensure that the modification takes effect.
+     */
+    getPositions(): Vector3[] | null;
+    /**
+     * Set per-vertex normals for the mesh.
+     * @param normals - The normals for the mesh
+     */
+    setNormals(normals: Vector3[] | null): void;
+    /**
+     * Get normals for the mesh.
+     * @remarks Please call the setNormals() method after modification to ensure that the modification takes effect.
+     */
+    getNormals(): Vector3[] | null;
+    /**
+     * Set per-vertex colors for the mesh.
+     * @param colors - The colors for the mesh
+     */
+    setColors(colors: Color[] | null): void;
+    /**
+     * Get colors for the mesh.
+     * @remarks Please call the setColors() method after modification to ensure that the modification takes effect.
+     */
+    getColors(): Color[] | null;
+    /**
+     * Set per-vertex bone weights for the mesh.
+     * @param boneWeights - The bone weights for the mesh
+     */
+    setBoneWeights(boneWeights: Vector4[] | null): void;
+    /**
+     * 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
+     */
+    setBoneIndices(boneIndices: Vector4[] | null): void;
+    /**
+     * 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
+     */
+    setTangents(tangents: Vector4[] | null): void;
+    /**
+     * Get tangents for the mesh.
+     * @remarks Please call the setTangents() method after modification to ensure that the modification takes effect.
+     */
+    getTangents(): Vector4[] | null;
+    /**
+     * Set per-vertex 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
+     */
+    setUVs(uv: Vector2[] | null, channelIndex: number): void;
+    /**
+     * Get uv for the mesh.
+     * @remarks Please call the setUV() method after modification to ensure that the modification takes effect.
+     */
+    getUVs(): Vector2[] | null;
+    /**
+     * Get uv for the mesh by channelIndex.
+     * @param channelIndex - The index of uv channels, in [0 ~ 7] range.
+     * @remarks Please call the setUV() method after modification to ensure that the modification takes effect.
+     */
+    getUVs(channelIndex: number): Vector2[] | null;
+    /**
+     * Set indices for the mesh.
+     * @param indices - The indices for the mesh
+     */
+    setIndices(indices: Uint8Array | Uint16Array | Uint32Array): void;
+    /**
+     * Get indices for the mesh.
+     */
+    getIndices(): Uint8Array | Uint16Array | Uint32Array;
+    /**
+     * 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;
+    /**
+     * Set vertex buffer binding.
+     * @param vertexBufferBinding - Vertex buffer binding
+     * @param index - Vertex buffer index, the default value is 0
+     */
+    setVertexBufferBinding(vertexBufferBinding: VertexBufferBinding, index?: number): void;
+    /**
+     * Set vertex buffer binding.
+     * @param vertexBuffer - Vertex buffer
+     * @param stride - Vertex buffer data stride
+     * @param index - Vertex buffer index, the default value is 0
+     */
+    setVertexBufferBinding(vertexBuffer: Buffer, stride: number, index?: number): void;
+    /**
+     * Set vertex buffer binding.
+     * @param vertexBufferBindings - Vertex buffer binding
+     * @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
+     */
+    addBlendShape(blendShape: BlendShape): void;
+    /**
+     * Clear all BlendShapes.
+     */
+    clearBlendShapes(): void;
+    /**
+     * Get name of BlendShape by given index.
+     * @param index - The index of BlendShape
+     * @returns The name of BlendShape
+     */
+    getBlendShapeName(index: number): string;
+    /**
+     * 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(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 _getVertexElementData;
+    private _beforeSetAdvancedVertexData;
+    private _updateAdvancedVertexDataMarks;
+    private _updateInternalVertexBuffer;
+    private _readVector2VertexData;
+    private _readVector3VertexData;
+    private _readVector4VertexData;
+    private _readColorVertexData;
+    private _readVertexData;
+    private _updateAdvancedVertexElement;
+    private _updateAdvancedVertexElements;
+    private _updateVertexElements;
+    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

@@ -0,0 +1,112 @@
+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;
+    private static readonly _sphereSeedPositions;
+    private static readonly _sphereSeedCells;
+    private static _sphereEdgeIdx;
+    private static _spherePoleIdx;
+    /**
+     * Create a sphere mesh.
+     * @param engine - Engine
+     * @param radius - Sphere radius
+     * @param segments - Number of segments
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Sphere model mesh
+     */
+    static createSphere(engine: Engine, radius?: number, segments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a sphere mesh by implementing Catmull-Clark Surface Subdivision Algorithm.
+     * Max step is limited to 6.
+     * @param engine - Engine
+     * @param radius - Sphere radius
+     * @param step - Number of subdiv steps
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Sphere model mesh
+     */
+    static createSubdivisionSurfaceSphere(engine: Engine, radius?: number, step?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a cuboid mesh.
+     * @param engine - Engine
+     * @param width - Cuboid width
+     * @param height - Cuboid height
+     * @param depth - Cuboid depth
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Cuboid model mesh
+     */
+    static createCuboid(engine: Engine, width?: number, height?: number, depth?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a plane mesh.
+     * @param engine - Engine
+     * @param width - Plane width
+     * @param height - Plane height
+     * @param horizontalSegments - Plane horizontal segments
+     * @param verticalSegments - Plane vertical segments
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Plane model mesh
+     */
+    static createPlane(engine: Engine, width?: number, height?: number, horizontalSegments?: number, verticalSegments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a cylinder mesh.
+     * @param engine - Engine
+     * @param radiusTop - The radius of top cap
+     * @param radiusBottom - The radius of bottom cap
+     * @param height - The height of torso
+     * @param radialSegments - Cylinder radial segments
+     * @param heightSegments - Cylinder height segments
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Cylinder model mesh
+     */
+    static createCylinder(engine: Engine, radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number, heightSegments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a torus mesh.
+     * @param engine - Engine
+     * @param radius - Torus radius
+     * @param tubeRadius - Torus tube
+     * @param radialSegments - Torus radial segments
+     * @param tubularSegments - Torus tubular segments
+     * @param arc - Central angle
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Torus model mesh
+     */
+    static createTorus(engine: Engine, radius?: number, tubeRadius?: number, radialSegments?: number, tubularSegments?: number, arc?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a cone mesh.
+     * @param engine - Engine
+     * @param radius - The radius of cap
+     * @param height - The height of torso
+     * @param radialSegments - Cone radial segments
+     * @param heightSegments - Cone height segments
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Cone model mesh
+     */
+    static createCone(engine: Engine, radius?: number, height?: number, radialSegments?: number, heightSegments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a capsule mesh.
+     * @param engine - Engine
+     * @param radius - The radius of the two hemispherical ends
+     * @param height - The height of the cylindrical part, measured between the centers of the hemispherical ends
+     * @param radialSegments - Hemispherical end radial segments
+     * @param heightSegments - Cylindrical part height segments
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Capsule model mesh
+     */
+    static createCapsule(engine: Engine, radius?: number, height?: number, radialSegments?: number, heightSegments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Duplicate vertices at the poles and adjust their UV coordinates.
+     */
+    private static _generateAndReplacePoleUV;
+    /**
+     * Get edge point index for subdivision surface sphere.
+     */
+    private static _calculateEdgeIndex;
+    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/PrimitiveMeshRestorer.d.ts

@@ -0,0 +1 @@
+export {};

package/types/mesh/Skin.d.ts

@@ -0,0 +1,35 @@
+import { Matrix } from "@galacean/engine-math";
+import { Entity } from "../Entity";
+import { EngineObject } from "../base/EngineObject";
+import { IComponentCustomClone } from "../clone/ComponentCloner";
+/**
+ * Skin used for skinned mesh renderer.
+ */
+export declare class Skin extends EngineObject implements IComponentCustomClone {
+    name: string;
+    /** Inverse bind matrices. */
+    inverseBindMatrices: Matrix[];
+    private _rootBone;
+    private _bones;
+    private _updateMark;
+    /**
+     * Root bone.
+     */
+    get rootBone(): Entity;
+    set rootBone(value: Entity);
+    /**
+     * Bones of the skin.
+     */
+    get bones(): ReadonlyArray<Entity>;
+    set bones(value: ReadonlyArray<Entity>);
+    constructor(name: string);
+    /** @deprecated Please use `bones` instead. */
+    joints: string[];
+    /** @deprecated Please use `rootBone` instead. */
+    get skeleton(): string;
+    set skeleton(value: string);
+}
+export declare enum SkinUpdateFlag {
+    BoneCountChanged = 0,
+    RootBoneChanged = 1
+}

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -0,0 +1,50 @@
+import { BoundingBox } from "@galacean/engine-math";
+import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { MeshRenderer } from "./MeshRenderer";
+import { Skin } from "./Skin";
+/**
+ * SkinnedMeshRenderer.
+ */
+export declare class SkinnedMeshRenderer extends MeshRenderer {
+    private static _jointCountProperty;
+    private static _jointSamplerProperty;
+    private static _jointMatrixProperty;
+    private _localBounds;
+    private _jointDataCreateCache;
+    private _blendShapeWeights;
+    private _maxVertexUniformVectors;
+    private _jointTexture;
+    private _skin;
+    /**
+     * Skin of the SkinnedMeshRenderer.
+     */
+    get skin(): Skin;
+    set skin(value: Skin);
+    /**
+     * The weights of the BlendShapes.
+     * @remarks Array index is BlendShape index.
+     */
+    get blendShapeWeights(): Float32Array;
+    set blendShapeWeights(value: Float32Array);
+    /**
+     * Local bounds.
+     */
+    get localBounds(): BoundingBox;
+    set localBounds(value: BoundingBox);
+    protected _update(context: RenderContext): void;
+    private _checkBlendShapeWeightLength;
+    private _onLocalBoundsChanged;
+    private _onSkinUpdated;
+    private _applySkin;
+    /**
+     * @deprecated use {@link SkinnedMeshRenderer.skin.rootBone} instead.
+     */
+    get rootBone(): Entity;
+    set rootBone(value: Entity);
+    /**
+     * @deprecated use {@link SkinnedMeshRenderer.skin.bones} instead.
+     */
+    get bones(): Readonly<Entity[]>;
+    set bones(value: Readonly<Entity[]>);
+}

package/types/mesh/enums/VertexAttribute.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Vertex attribute types of a vertex in a ModelMesh.
+ */
+export declare enum VertexAttribute {
+    /** Vertex position. */
+    Position = "POSITION",
+    /** Vertex normal. */
+    Normal = "NORMAL",
+    /** Vertex color. */
+    Color = "COLOR_0",
+    /** Vertex tangent. */
+    Tangent = "TANGENT",
+    /** Vertex bone weight. */
+    BoneWeight = "WEIGHTS_0",
+    /** Vertex bone index. */
+    BoneIndex = "JOINTS_0",
+    /** Vertex UV. */
+    UV = "TEXCOORD_0",
+    /** Vertex UV1. */
+    UV1 = "TEXCOORD_1",
+    /** Vertex UV2. */
+    UV2 = "TEXCOORD_2",
+    /** Vertex UV3. */
+    UV3 = "TEXCOORD_3",
+    /** Vertex UV4. */
+    UV4 = "TEXCOORD_4",
+    /** Vertex UV5. */
+    UV5 = "TEXCOORD_5",
+    /** Vertex UV6. */
+    UV6 = "TEXCOORD_6",
+    /** Vertex UV7. */
+    UV7 = "TEXCOORD_7"
+}

package/types/mesh/index.d.ts

@@ -0,0 +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 { SkinnedMeshRenderer } from "./SkinnedMeshRenderer";
+export { VertexAttribute } from "./enums/VertexAttribute";

package/types/particle/ParticleBufferUtils.d.ts

@@ -0,0 +1 @@
+export {};

package/types/particle/ParticleGenerator.d.ts

@@ -0,0 +1,94 @@
+import { ParticleStopMode } from "./enums/ParticleStopMode";
+import { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
+import { EmissionModule } from "./modules/EmissionModule";
+import { ForceOverLifetimeModule } from "./modules/ForceOverLifetimeModule";
+import { MainModule } from "./modules/MainModule";
+import { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule";
+import { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
+import { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
+import { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
+/**
+ * Particle Generator.
+ */
+export declare class ParticleGenerator {
+    private static _tempVector20;
+    private static _tempVector21;
+    private static _tempVector22;
+    private static _tempVector30;
+    private static _tempVector31;
+    private static _tempMat;
+    private static _tempColor0;
+    private static _tempParticleRenderers;
+    private static readonly _particleIncreaseCount;
+    private static readonly _transformedBoundsIncreaseCount;
+    /** Use auto random seed. */
+    useAutoRandomSeed: boolean;
+    /** Main module. */
+    readonly main: MainModule;
+    /** Emission module. */
+    readonly emission: EmissionModule;
+    /** Velocity over lifetime module. */
+    readonly velocityOverLifetime: VelocityOverLifetimeModule;
+    /** Force over lifetime module. */
+    readonly forceOverLifetime: ForceOverLifetimeModule;
+    /** Size over lifetime module. */
+    readonly sizeOverLifetime: SizeOverLifetimeModule;
+    /** Rotation over lifetime module. */
+    readonly rotationOverLifetime: RotationOverLifetimeModule;
+    /** Color over lifetime module. */
+    readonly colorOverLifetime: ColorOverLifetimeModule;
+    /** Texture sheet animation module. */
+    readonly textureSheetAnimation: TextureSheetAnimationModule;
+    private _isPlaying;
+    private _instanceBufferResized;
+    private _waitProcessRetiredElementCount;
+    private _instanceVertexBufferBinding;
+    private _instanceVertices;
+    private _randomSeed;
+    private _transformedBoundsArray;
+    private _transformedBoundsCount;
+    private _firstActiveTransformedBoundingBox;
+    private _firstFreeTransformedBoundingBox;
+    private _playStartDelay;
+    /**
+     * Whether the particle generator is contain alive or is still creating particles.
+     */
+    get isAlive(): boolean;
+    /**
+     * Random seed.
+     *
+     * @remarks
+     * If `useAutoRandomSeed` is true, this value will be random changed when play.
+     * If you set this value custom, `useAutoRandomSeed` will be false.
+     */
+    get randomSeed(): number;
+    set randomSeed(value: number);
+    /**
+     * Start emitting particles.
+     * @param withChildren - Whether to start the particle generator of the child entity
+     */
+    play(withChildren?: boolean): void;
+    /**
+     * Stop emitting particles.
+     * @param withChildren - Whether to stop the particle generator of the child entity
+     * @param stopMode - Stop mode
+     */
+    stop(withChildren?: boolean, stopMode?: ParticleStopMode): void;
+    /**
+     * Manually emit certain number of particles immediately.
+     * @param count - Number of particles to emit
+     */
+    emit(count: number): void;
+    private _addNewParticle;
+    private _retireActiveParticles;
+    private _freeRetiredParticles;
+    private _addActiveParticlesToVertexBuffer;
+    private _addVertexBufferBindingsFilterDuplicate;
+    private _resizeTransformedBoundsArray;
+    private _retireTransformedBounds;
+    private _calculateGeneratorBounds;
+    private _mergeTransformedBounds;
+    private _calculateTransformedBounds;
+    private _addGravityToBounds;
+    private _getExtremeValueFromZero;
+}

package/types/particle/ParticleMaterial.d.ts

@@ -0,0 +1,38 @@
+import { Color } from "@galacean/engine-math";
+import { Engine } from "../Engine";
+import { BaseMaterial } from "../material/BaseMaterial";
+import { Texture2D } from "../texture/Texture2D";
+/**
+ * Particle Material.
+ */
+export declare class ParticleMaterial extends BaseMaterial {
+    /**
+     * Base color.
+     */
+    get baseColor(): Color;
+    set baseColor(value: Color);
+    /**
+     * Base texture.
+     */
+    get baseTexture(): Texture2D;
+    set baseTexture(value: Texture2D);
+    /**
+     * Emissive color.
+     */
+    get emissiveColor(): Color;
+    set emissiveColor(value: Color);
+    /**
+     * Emissive texture.
+     */
+    get emissiveTexture(): Texture2D;
+    set emissiveTexture(value: Texture2D);
+    /**
+     * Create a unlit material instance.
+     * @param engine - Engine to which the material belongs
+     */
+    constructor(engine: Engine);
+    /**
+     * @inheritdoc
+     */
+    clone(): ParticleMaterial;
+}

package/types/particle/ParticleRenderer.d.ts

@@ -0,0 +1,47 @@
+import { BoundingBox, Vector3 } from "@galacean/engine-math";
+import { RenderContext } from "../RenderPipeline/RenderContext";
+import { Renderer } from "../Renderer";
+import { ModelMesh } from "../mesh/ModelMesh";
+import { ParticleGenerator } from "./ParticleGenerator";
+import { ParticleRenderMode } from "./enums/ParticleRenderMode";
+/**
+ * Particle Renderer Component.
+ */
+export declare class ParticleRenderer extends Renderer {
+    private static readonly _billboardModeMacro;
+    private static readonly _stretchedBillboardModeMacro;
+    private static readonly _horizontalBillboardModeMacro;
+    private static readonly _verticalBillboardModeMacro;
+    private static readonly _renderModeMeshMacro;
+    private static readonly _pivotOffsetProperty;
+    private static readonly _lengthScale;
+    private static readonly _speedScale;
+    private static readonly _currentTime;
+    /** Particle generator. */
+    readonly generator: ParticleGenerator;
+    /** Specifies how much particles stretch depending on their velocity. */
+    velocityScale: number;
+    /** How much are the particles stretched in their direction of motion, defined as the length of the particle compared to its width. */
+    lengthScale: number;
+    /** The pivot of particle. */
+    pivot: Vector3;
+    private _renderMode;
+    private _currentRenderModeMacro;
+    private _mesh;
+    private _supportInstancedArrays;
+    /**
+     * Specifies how particles are rendered.
+     */
+    get renderMode(): ParticleRenderMode;
+    set renderMode(value: ParticleRenderMode);
+    /**
+     * The mesh of particle.
+     * @remarks Valid when `renderMode` is `Mesh`.
+     */
+    get mesh(): ModelMesh;
+    set mesh(value: ModelMesh);
+    protected _updateBounds(worldBounds: BoundingBox): void;
+    protected _update(context: RenderContext): void;
+    protected _render(context: RenderContext): void;
+    protected _onDestroy(): void;
+}