Add chart_image to the usage examples

mworchel · Oct 10, 2021 · ebdb99a · ebdb99a
1 parent 1a7a138
commit ebdb99a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,12 @@ atlas[i]          # Convenience binding for `atlas.get_mesh`
 atlas.width       # Width of the atlas 
 atlas.height      # Height of the atlas
 
+# The image requires passing custom PackOptions:
+#   pack_options = xatlas.PackOptions()
+#   pack_options.create_image = True
+#   atlas.generate(pack_options=pack_options)
+atlas.chart_image # Debug image of the atlas
+
 ...               # See xatlas documentation for all properties
 ```