Version: 2023.1
LanguageEnglish
  • C#

Unwrapping.GenerateSecondaryUVSet

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static bool GenerateSecondaryUVSet(Mesh src);

Declaration

public static bool GenerateSecondaryUVSet(Mesh src, UnwrapParam settings);

Parameters

src The Mesh to update.
settings Settings that configure the calculation.

Returns

bool Returns true if the calculation succeeded. Otherwise, returns false.

Description

Compute a unique UV layout for a Mesh, and store it in Mesh.uv2.

When you import a model asset, you can instruct Unity to compute a lightmap UV layout for it using [[ModelImporter-generateSecondaryUV]] or the Model Import Settings Inspector. This function allows you to do the same to procedurally generated meshes.

If this process requires multiple UV charts to flatten the the mesh, the mesh might contain more vertices than before. If the mesh uses 16-bit indices (see Mesh.indexFormat) and the process would result in more vertices than are possible to use with 16-bit indices, this function fails and returns false.

See Also: Mesh class, ModelImporter class, Generating Lightmap UVs.