docs.unity3d.com
Version: 

    Unwrap UV

    API function: algo.unwrapUV

    Considering a set of UV islands (defined either by existing UV coordinates or by lines of interest over the mesh surface), this function generates UV coordinates by flattening each 3D surface patch corresponding to an island onto the Euclidean plane while minimizing a distortion criterion between both 3D and UV spaces.

    An open cube to unwrap Isometric unwrapping
    (edge length preserving)
    Conformal unwrapping
    (angle preserving)
    Warning

    This function only unwraps UV islands, but doesn't pack texture coordinates into the unit square. To do so, you must call algo.repackUV afterwards.

    Parameters

    Occurrences

    List of occurrences to process.

    Method

    Determines the type of solver used for unwrapping (using the enum algo.UnwrapUVMethod):

    • Isometric: minimizes edge length distortions using ARAP solver.
    • Conformal: minimizes face angle distortions using ABF++ solver.

    Channel

    UV channel to run the unwrapping on. If lines of interest are used, the channel corresponds to the destination where the new UV coordinates are stored.

    Create seams from LoI

    If checked, UV islands are created by considering lines of interest as boundaries (in other words, as cutting lines over the mesh surface). Otherwise, islands defined by existing UV coordinates are used.

    Lines of interests can be computed by algo.segmentMesh, for instance.

    Iter max

    Solver stopping criterion: maximum number of iterations allowed.

    Tolerance

    Solver stopping criterion: error threshold.

    Version 2025.2.0.1
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX.