Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve MergeMeshes documentation. #12881

Merged
merged 1 commit into from
Aug 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions packages/dev/core/src/Meshes/mesh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4423,12 +4423,12 @@ export class Mesh extends AbstractMesh implements IGetSetVerticesData {

/**
* Merge the array of meshes into a single mesh for performance reasons.
* @param meshes defines he vertices source. They should all be of the same material. Entries can empty
* @param disposeSource when true (default), dispose of the vertices from the source meshes
* @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
* @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
* @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
* @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
* @param meshes array of meshes with the vertices to merge. Entries cannot be empty meshes.
* @param disposeSource when true (default), dispose of the vertices from the source meshes.
* @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true.
* @param meshSubclass (optional) can be set to a Mesh where the merged vertices will be inserted.
* @param subdivideWithSubMeshes when true (false default), subdivide mesh into subMeshes.
* @param multiMultiMaterials when true (false default), subdivide mesh into subMeshes with multiple materials, ignores subdivideWithSubMeshes.
* @returns a new mesh
*/
public static MergeMeshes(
Expand All @@ -4444,12 +4444,12 @@ export class Mesh extends AbstractMesh implements IGetSetVerticesData {

/**
* Merge the array of meshes into a single mesh for performance reasons.
* @param meshes defines he vertices source. They should all be of the same material. Entries can empty
* @param disposeSource when true (default), dispose of the vertices from the source meshes
* @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
* @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
* @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
* @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
* @param meshes array of meshes with the vertices to merge. Entries cannot be empty meshes.
* @param disposeSource when true (default), dispose of the vertices from the source meshes.
* @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true.
* @param meshSubclass (optional) can be set to a Mesh where the merged vertices will be inserted.
* @param subdivideWithSubMeshes when true (false default), subdivide mesh into subMeshes.
* @param multiMultiMaterials when true (false default), subdivide mesh into subMeshes with multiple materials, ignores subdivideWithSubMeshes.
* @returns a new mesh
*/
public static MergeMeshesAsync(
Expand Down