xatlas

xatlas is a small C++11 library with no external dependencies that generates unique texture coordinates suitable for baking lightmaps or texture painting.

It is an independent fork of thekla_atlas, used by The Witness.

Screenshots

Example - Cesium Milk Truck

Viewer	Random packing	Brute force packing

Example - Godot Third Person Shooter demo

How to use

Building

Premake is used. For CMake support, see here.

Integration into an existing build is simple, only xatlas.cpp and xatlas.h are required.

Windows

Run build\premake.bat. Open build\vs2019\xatlas.sln.

Note: change the build configuration to "Release". The default - "Debug" - severely degrades performance.

Linux

Install premake5. Run premake5 gmake, cd build/gmake, make.

Generate an atlas (simple API)

Create an empty atlas with xatlas::Create.
Add one or more meshes with xatlas::AddMesh.
Call xatlas::Generate. Meshes are segmented into charts, which are parameterized and packed into an atlas.

The xatlas::Atlas instance created in the first step now contains the result: each input mesh added by xatlas::AddMesh has a corresponding new mesh with a UV channel. New meshes have more vertices (the UV channel adds seams), but the same number of indices.

Cleanup with xatlas::Destroy.

Example code here.

Generate an atlas (tools/editor integration API)

Instead of calling xatlas::Generate, the following functions can be called in sequence:

xatlas::ComputeCharts: meshes are segmented into charts and parameterized.
xatlas::PackCharts: charts are packed into one or more atlases.

All of these functions take a progress callback. Return false to cancel.

You can call any of these functions multiple times, followed by the proceeding functions, to re-generate the atlas. E.g. calling xatlas::PackCharts multiple times to tweak options like unit to texel scale and resolution.