DOCS // meshfx

meshfx errors and exit codes Available

meshfx names unsupported inputs and records warnings in its report. Exit code 5 means files were written but a budget limit was missed.

Contents3 sections
  1. Errors and exits
  2. Warnings and settings
  3. Questions

meshfx runs on the hosted API: try it in the Playground.

Errors and exits

ExitCodesMeaning
0Done. Warnings, if any, are in the report.
1BAD_SCALE, SOURCE_MISSING, TARGET_LIMITThe spec or the command is wrong; the message names the key and what it accepts.
2STAGE_FAILED, GPU_ERROR, OUT_OF_MEMORYA step could not make a valid result.
3FILE_READ, FILE_WRITE, MODEL_INVALID, JOINTS_NEED_TREE, JOINT_REBUILD_UNSUPPORTED, MODEL_UNSUPPORTED, MODEL_EMPTY, TEXTURE_UNREADABLE, SKIN_NOT_SUPPORTEDA file could not be read, used or written; the message names it.
4NO_GPUOnly for an unavailable stage.
5BUDGET_EXCEEDEDThe run finished and wrote every file, but missed a [budget] limit.

Warnings and settings

WarningKey to change
NON_MANIFOLD_EDGESrepair.remesh
FLIPPED_NORMALSrepair.fix_winding
OPEN_HOLESrepair.fill_holes
DUPLICATE_VERTICESrepair.weld_m
ZERO_AREA_FACESrepair.enabled
BAD_SCALEunits.size_m
POSE_NOT_READYpose.expect
WRONG_PIVOTunits.pivot
UV_OVERLAPuv.mode, uv.lightmap
UV_OUT_OF_RANGEuv.mode
UV_STRETCH_HIGHuv.iterations
UV_FALLBACKuv.time_limit_s, uv.padding_px
TEXEL_DENSITY_LOWtextures.size_px
SELF_INTERSECTIONSrepair.remesh
HIDDEN_GEOMETRYrepair.remove_hidden
JOINT_PART_FLOORlod.triangles, simplify.triangles, repair.enabled
JOINT_NORMAL_NEEDS_UVuv.mode
FLOATERS_REMOVEDrepair.floaters
REPAIR_REJECTEDrepair.max_error
NOT_WATERTIGHTrepair.remesh
ZERO_THICKNESSrepair.thicken_m
LOD_BUDGET_MISSEDsimplify.max_error, lod.max_error, lod.count, lod.triangles, simplify.protect, simplify.forbid, uv.mode
SILHOUETTE_CHANGEDsimplify.triangles
PART_LOSTsimplify.triangles
LOD_FAULTS_ADDEDsimplify.triangles, lod.ratio, simplify.forbid
BAKE_MISSESbake.max_distance
BAKE_MISMATCHbake.max_distance
BAKED_LIGHTINGtextures.delight
ALBEDO_OUT_OF_RANGEtextures.pbr_check
TEXTURE_DOWNSIZEDtextures.size_px, budget.max_texture_px, budget.max_bytes
MATERIAL_SIMPLIFIEDtextures.atlas
ATTRIBUTE_DROPPEDuv.lightmap
ANIMATION_DROPPEDsource.skin
COLLISION_LOOSEcollision.max_hulls
COLLISION_CAPPEDcollision.max_hulls
OCCLUDER_SKIPPEDoccluder.inset
STAGE_NOT_BUILTcollision.mode

Read the full report before using a result. A finished compile can still miss a budget; exit code 5 keeps all output files.

Questions

What does exit code 5 mean in meshfx?

Exit code 5 means BUDGET_EXCEEDED, so the run finished and wrote every file but missed a budget limit.

Which warning appears if a triangle target is too low for a rigid part?

A triangle target below the rigid part floor triggers JOINT_PART_FLOOR and names lod.triangles, simplify.triangles or repair.enabled to adjust.

What is the difference between exit code 1 and exit code 3 in meshfx?

Exit code 1 means the spec or command is wrong, while exit code 3 means a file could not be read, used or written.