substance3d_baker command line options

substance3d_baker

Usage

Global options

--doc-html, --doc
Generate basic documentation html from the option's help.
--help, -h, -?
Display help about given subcommand. If no subcommand is provided, this help about global options is printed.
--opt-descr
Create json description of all available options
--quiet, -q
Disable warning messages.
--verbose, -v
Enable info and debug messages.
--version, -V
Display version of the program.

Subcommand AmbientOcclusion.Raytraced

Description

Computes soft shadowing in occluded areas and stores the ambient lighting intensities in a grayscale image, where brighter areas receive more ambient light.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--attenuation <string> [default: "linear"]
The method of attenuation applied to occlusion shadows according to the occluder distance. Available options: - none - smooth - linear
--culling_mode <string> [default: "never"]
The rule followed by occlusion rays for ignoring backfacing triangles in the high poly meshes. Available options: - never : No backfaces are ignored. - always : All backfaces are ignored. - match_mesh_name : Backfaces are only ignored for meshes which name includes the "_ignorebf" dedicated suffix.
--enable_ground_plane <bool> [default: "false"]
If enabled, adds an infinite occluding plane at the lowest mesh point in the scene.
--ground_offset <double> [default: "0"]
Vertical offset applied to the ground plane, relative to the lowest mesh point in the scene.
--normal_map_orientation <string> [default: "directx"]
The orientation of the normal map. Only used in combination with the "normal_map_path" option. Available options: - opengl - directx
--normal_map_path <string>
The path of the external normal map providing additional surface details.
--normal_map_space <string> [default: "tangent_space"]
The coordinate space used by the normal map. Only used in combination with the "normal_map_path" option. Available options: - world_space - tangent_space
--secondary.max_distance <double> [default: "1"]
Maximum distance of other detected surfaces. Surfaces farther than that distance are ignored.
--secondary.mesh_match_mode <string> [default: "match_all"]
The rule for detecting meshes in the high poly scene. Available options: - match_all : all meshes in the high poly scene are detected. - match_mesh_name : only meshes in the high poly scene with the same name as the source mesh in the low poly scene are detected.
--secondary.min_distance <double> [default: "1e-05"]
Minimum distance of other detected surfaces. Surfaces closer than that distance are ignored.
--secondary.normalized_distance <bool> [default: "true"]
Interpret the "min_distance" and "max_distance" values as multipliers of the mesh bounding box.
--secondary.sample_count <uint> [default: "64"]
Number of secondary rays. Range: [1; 256]
--secondary.sample_distribution <string> [default: "cosine"]
The angular distribution of rays. Available options: - uniform - cosine
--secondary.spread_angle <double> [default: "180"]
The maximum spread angle of rays.

Hidden options

--debug

Subcommand Color.Raytraced

Description

Computes an ID map used to select and mask triangles according to specified criteria. An ID map groups triangles by color value.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--color_generator <string> [default: "hue_shift"]
The method used to generate color IDs. Available options: - random : Assign a random RGB value. - hue_shift : Assign a random RGB value where hue is random while saturation and luminance are both constant. - grayscale : Assign a random luminance value.
--color_source <string> [default: "mesh_color"]
The source of data used to assign IDs. Available options: - vertex : Use the vertex colors from the meshes in the high poly scene(s) as IDs. - mesh_color : Use the material colors from the meshes in the high poly scene(s) as IDs (FBX files only). - scene_id : assigns an ID per mesh in the high poly scene(s). - mesh_index : Assigns an ID per subobject (also called element) from the meshes in the high poly scene(s). - contiguous_triangles_2d : Assigns an ID per contiguous UV island. - contiguous_triangles_3d : Assigns an ID per contiguous 3D sub-mesh.

Hidden options

--debug

Subcommand Curvature.Raytraced

Description

Computes the curvature of meshes and stores it in a grayscale image, where concave areas are brighter and convex areas are darker.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--auto_minmax <bool> [default: "true"]
Compute tonemapping bounds per UV tile. I.e., use the minimum and maximum values or each individual tile to remap their values in the [0;1] range.
--normal_map_orientation <string> [default: "directx"]
The orientation of the normal map. Only used in combination with the "normal_map_path" option. Available options: - opengl - directx
--normal_map_path <string>
The path of the external normal map providing additional surface details.
--normal_map_space <string> [default: "tangent_space"]
The coordinate space used by the normal map. Only used in combination with the "normal_map_path" option. Available options: - world_space - tangent_space
--secondary.mesh_match_mode <string> [default: "match_all"]
The rule for detecting meshes in the high poly scene. Available options: - match_all : all meshes in the high poly scene are detected. - match_mesh_name : only meshes in the high poly scene with the same name as the source mesh in the low poly scene are detected.
--secondary.normalized_distance <bool> [default: "true"]
Interpret the "min_distance" and "max_distance" values as multipliers of the mesh bounding box.
--secondary.sample_count <uint> [default: "32"]
Number of secondary rays. Range: [1; 256]
--secondary.sampling_radius <double> [default: "0.001"]
The radius of the disk to get surface samples from, around the hit position of a projection ray. A larger radius results in wider curvature gradients.
--value_bounds <double>,<double> [default: "-1,1"]
The bounds of the desired curvature value range.

Hidden options

--debug

Subcommand Height.Raytraced

Description

Extracts the vertical position of a mesh surface and stores it in a grayscale image, where higher areas are brighter and lower areas are darker.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--divisor <double> [default: "1"]
Divide the raw extracted height by this value. Only used when the "maximize_range" option is set to "manual".
--maximize_range <string> [default: "low_poly_distance"]
The value remapping applied to the extracted heights, if any. I.e., how to map the values to a specified range. Available options: - ray_distance : Remap the values to the range of distances of ray hits. - low_poly_distance : No normalization. The distance from the low poly meshes' surfaces to the high poly's are stored as is. - min_max : Remap the values from 0 to 1 where 0 is the lowest high poly mesh point and 1 is the highest. - manual : Scales the values using a user-specified divisor.

Hidden options

--debug

Subcommand Normal.BentNormals

Description

Computes the average directions of ambient lighting and stores them as normalised vectors in a color image, where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels. The computation is very similar to the AmbientOcclusion.Raytraced baker.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--culling_mode <string> [default: "never"]
The rule followed by occlusion rays for ignoring backfacing triangles in the high poly meshes. Available options: - never : No backfaces are ignored. - always : All backfaces are ignored. - match_mesh_name : Backfaces are only ignored for meshes which name includes the dedicated suffix (Default: "_ignorebf")
--output_texture_orientation <string> [default: "directx"]
The orientation of the computed normal map. Available options: - opengl - directx
--output_texture_space <string> [default: "tangent_space"]
The coordinate space used by the computed normal map. Available options: - world_space - tangent_space
--secondary.max_distance <double> [default: "1"]
Maximum distance of other detected surfaces. Surfaces farther than that distance are ignored.
--secondary.mesh_match_mode <string> [default: "match_all"]
The rule for detecting meshes in the high poly scene. Available options: - match_all : all meshes in the high poly scene are detected. - match_mesh_name : only meshes in the high poly scene with the same name as the source mesh in the low poly scene are detected.
--secondary.min_distance <double> [default: "1e-05"]
Minimum distance of other detected surfaces. Surfaces closer than that distance are ignored.
--secondary.normalized_distance <bool> [default: "true"]
Interpret the "min_distance" and "max_distance" values as multipliers of the mesh bounding box.
--secondary.sample_count <uint> [default: "64"]
Number of secondary rays. Range: [1; 256]
--secondary.sample_distribution <string> [default: "cosine"]
The angular distribution of rays. Available options: - uniform - cosine
--secondary.spread_angle <double> [default: "180"]
The maximum spread angle of rays.

Hidden options

--debug

Subcommand Normal.Raytraced

Description

Extracts the normals of meshes in a high poly scene and computes a normal map, where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--output_texture_orientation <string> [default: "directx"]
The orientation of the computed normal map. Available options: - opengl - directx
--output_texture_space <string> [default: "tangent_space"]
The coordinate space used by the computed normal map. Available options: - world_space - tangent_space

Hidden options

--debug

Subcommand Normal.TangentToWorld

Description

Extracts the surface direction vectors of meshes and stores them in a color image, where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Baker options

--bake_type <string> [default: "normal"]
The direction vector to be baked. Available options: - normal - tangent - binormal
--normal_map_orientation <string> [default: "directx"]
The orientation of the normal map. Only used in combination with the "normal_map_path" option. Available options: - opengl - directx
--normal_map_path <string>
The path of the external normal map providing additional surface details.
--normal_map_space <string> [default: "tangent_space"]
The coordinate space used by the normal map. Only used in combination with the "normal_map_path" option. Available options: - world_space - tangent_space

Hidden options

--debug

Subcommand Normal.WorldToTangent

Description

Transforms surface directions of meshes from world space into tangent space and stores them in a color image, where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Baker options

--direction <string> [default: "from_texture"]
Select the input method of the world space direction vector(s) which should be transformed into tangent space. Available options: - from_texture : use a specified world space normal map. - from_uniform_vector : use a uniform vector which coordinates are specified in dedicated options.
--normal_map_path <string>
The path of the external world space normal map providing the per-pixel directions which should be transformed into tangent space. Only used in combination with the "direction" option set to "from_texture".
--output_texture_orientation <string> [default: "directx"]
The orientation of the computed normal map. Available options: - opengl - directx
--world_direction_x <double> [default: "0"]
The X component of the world space direction vector. Only used in combination with the "direction" option set to "from_uniform_vector".
--world_direction_y <double> [default: "-1"]
The Y component of the world space direction vector. Only used in combination with the "direction" option set to "from_uniform_vector".
--world_direction_z <double> [default: "0"]
The Z component of the world space direction vector. Only used in combination with the "direction" option set to "from_uniform_vector".

Hidden options

--debug

Subcommand Opacity.Raytraced

Description

Computes an opacity map where ray hits are white and ray misses are black. I.e., any ray hitting a mesh surface in the high poly scene will result in a white pixel.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

Hidden options

--debug

Subcommand Position.Rasterised

Description

Extracts the world space positions of the meshes' vertices in the low poly scene, and stores them in a grayscale or color image, according to the specified scope.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Baker options

--axis <string> [default: "x"]
The axis along which the vertex positions should be extracted. Only used in combination with the "mode" option set to "single_axis". Available options: - x - y - z
--mode <string> [default: "all_axes"]
Select the scope of the positions which should be extracted. Available options: - all_axes : extract positions along all axes, resulting in a color image where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels. - single_axis : extract positions along a specified single axis, resulting in a grayscale image.
--normalization <string> [default: "bsphere"]
The normalization method applied to the extracted positions. I.e., remaps the values to a specified range. Available options: - bbox : The coordinate range of the scene's bounding box (Bbox) - bsphere : The coordinate range of the scene's bounding sphere (Bsphere) - none : No normalization is applied.
--normalization_scale <string> [default: "full_scene"]
The scope of the scene used to set the bounds of the bounding volumes used in the normalization process. Only used in combination with the "normalization" option. Available options: - selection : Only consider the meshes selected using the "selected_meshes" options. - full_scene : Consider all the meshes in the scene.

Hidden options

--debug

Subcommand Position.Raytraced

Description

Extracts the world space positions of the meshes' vertices in the high poly scene(s), and stores them in a grayscale or color image, according to the specified scope.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--axis <string> [default: "x"]
The axis along which the vertex positions should be extracted. Only used in combination with the "mode" option set to "single_axis". Available options: - x - y - z
--mode <string> [default: "all_axes"]
Select the scope of the positions which should be extracted. Available options: - all_axes : extract positions along all axes, resulting in a color image where (X, Y, Z) coordinates are mapped to the image's (R, G, B) channels. - single_axis : extract positions along a specified single axis, resulting in a grayscale image.
--normalization <string> [default: "bsphere"]
The normalization method applied to the extracted positions. I.e., remaps the values to a specified range. Available options: - bbox : The coordinate range of the scene's bounding box (Bbox) - bsphere : The coordinate range of the scene's bounding sphere (Bsphere) - none : No normalization is applied.
--normalization_scale <string> [default: "full_scene"]
The scope of the scene used to set the bounds of the bounding volumes used in the normalization process. Only used in combination with the "normalization" option. Available options: - selection : Only consider the meshes selected using the "selected_meshes" options. - full_scene : Consider all the meshes in the scene.

Hidden options

--debug

Subcommand TextureTransfer.Raytraced

Description

Projects a source texture from the meshes in the high poly scene(s) onto the meshes in the low poly scene. Can also be used to transfer a texture across UV sets on a same mesh.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--filtering_mode <string> [default: "bilinear"]
The method of interpolating the pixels in the texture projection. Available options: - nearest : No interpolation, colors are applied as is to the destination pixels nearest to the source. - bilinear : Colors are interpolated in the destination pixels using bilinear filtering.
--highpoly_uv_set <uint> [default: "0"]
The UV set used to map the source texture on the meshes in the high poly scene(s).
--output_texture_orientation <string> [default: "directx"]
The orientation of the computed normal map. Available options: - opengl - directx
--source_texture_isnormal <bool> [default: "false"]
Specifies whether the source texture is a normal map.
--source_texture_orientation <string> [default: "directx"]
The orientation of the source normal map. Only used when the "source_texture_isnormal" option is set to "true". Available options: - opengl - directx
--source_texture_path <string>
The path of the projected texture.
--source_texture_space <string> [default: "tangent_space"]
The coordinate space used by the source normal map. Only used when the "source_texture_isnormal" option is set to "true". Available options: - world_space - tangent_space

Hidden options

--debug

Subcommand Thickness.Raytraced

Description

Computes the thickness of the meshes in the high poly scene(s) and stores it in a grayscale image, where brighter areas represent thicker volumes. The computation is very similar to the AmbientOcclusion.Raytraced baker, except the rays are cast in the direction opposite of the surface normal (I.e., inward) and hit an opposite surface.

Common options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--base.uv_set <uint> [default: "0"]
The target UV set of the meshes in the input scene.
--cpu
Run the bakers exclusively on the CPU.
--enable_mip_diffusion <bool> [default: "true"]
Applies a diffusion post-process to the baked image, after padding.
--inputs <string;string;string;...>
The 3D scene file(s) to process, which hold the low poly meshes. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--name_filtering_mode <string> [default: "parent_name"]
The scene object which names should be used for matching the low poly and high poly scene objects: Available options: - geometry_name: Use the name of the mesh geometry object - parent_name: Use the name of the parent of the mesh geometry object (same as in 'sbsbaker' tool)
--name_suffix_high <string> [default: "_high"]
Suffix used by the high poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--name_suffix_low <string> [default: "_low"]
Suffix used by the low poly meshes in the scene. Used by the options matching meshes by name, such as "projection.mesh_match_mode".
--output_format <string> [default: "png"]
Format to use for the output image file. Supported formats: surface, dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, psd, psb, hdr, exr, webp.
--output_name <string> [default: "{scenename}_{bakername}"]
Output name of the output image files, without the extension. Macros may be used to tailor the name to the context of a bake. Available macros: - {scenename}. Replaced by the scene name before the last "." (E.g.: scene.ext.fbx --> scene.ext) - {bakername}. Replaced by the current baker's name - {udim}. Replaced by the UDIM ID of the current tile (MARI convention). - {sizex} ⁄ {sizey}. Replaced by the size of the output image in X⁄Y, in pixels. - {sizexk} ⁄ {sizeyk}. Replaced by the shorthand for the output image size as a multiple of 1024. (E.g.: 2k for 2048)
--output_path <string> [default: ".⁄"]
Path of the destination directory for the output image files. Available macros: - {inputPath} : Replaced by the path of the directory hosting the first input 3D scene file.
--output_size <uint>,<uint> [default: "2048,2048"]
Size of the output image files, in pixels.
--padding_radius <uint> [default: "2"]
Width of the dilation post-process applied to the borders of UV islands in the output images, in pixels. Dilation is applied before diffusion.
--per_fragment_binormal <bool> [default: "true"]
Selects the source of data for computing the binormal of the tangent frame: - true : fragment shader. - false : vertex shader.
--recompute_tangents <bool> [default: "false"]
Forces the recomputation of tangents, dismissing those from the mesh. Computed tangents use the MikkT standard.
--selected_meshes <string>
Selects meshes to include in the baking process. Expects the full path of a selected mesh in the input scene(s). If unused or empty, all meshes are selected. Use 'info' subcommand to list meshes and their full paths in an input scene. The option should be repeated for each selected mesh. E.g.: --selected_meshes "⁄root⁄firstMesh" --selected_meshes "⁄root⁄secondMesh"
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.
--udim <int> [default: "1001"]
Coordinates of the UV tile to compute, as a UDIM ID using the MARI convention. E.g.: "1022"
--uv_tiles <int>,<int> [default: "uint2(0,0)"]
Coordinates of the UV tile(s) to compute, as two zero-based indices. E.g.: "1,2"

Projection options

--cage_scene_path <string>
The path of the 3D scene hosting the meshes that rays are casted from.
--high_scene_paths <string>
The path(s) of the 3D scene(s) from which information should be baked onto the input scene.
--projection.cull_backfaces <bool> [default: "true"]
Ignore backfacing triangles when trying to match low poly and high poly meshes.
--projection.hit_strategy <string> [default: "inward"]
The method of selecting the intersection of rays with high poly meshes. Available options: - inward: Suited to capture floater geometry - closest_from_source: Take extra steps to select the closest low poly point
--projection.max_depth <double> [default: "0.01"]
Maximum rear distance for raytracing. I.e., the distance behind the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.max_height <double> [default: "0.01"]
Maximum frontal distance for raytracing. I.e., the distance in front of the surface of the low poly mesh. This option has no effect when the "use_cage" option is set to "true".
--projection.mesh_match_mode <string> [default: "match_all"]
The method of matching the low poly and high poly meshes. - match_all : Intersections with any mesh in the high poly scene are used. - match_mesh_name : Only intersections with meshes of the same name than the low poly are used. E.g.: the "clock_low" mesh is only matched with "clock_high" mesh.
--projection.normalized_distance <bool> [default: "true"]
Interpret the max distances as a factor of the mesh bounding box.
--projection.offset_map_path <string>
The path of a grayscale texture used to adjust the projection cage, by applying a per-pixel offset to the Max frontal distance.
--projection.sampling_rate <string> [default: "none"]
The supersampling ratio used to improve the quality of the output images. "none" means no supersampling is applied. Available options: - none - 2x2 - 4x4 - 8x8
--projection.skew_map_invert <bool> [default: "false"]
Invert the values of the skew map, such that bright areas in the skew map describe averaged directions while dark areas describe straightened directions. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.skew_map_path <string>
The path of the skew map. This option has no effect when the "skew_correction" option is not provided or set to "false".
--projection.smooth_normals <bool> [default: "true"]
Compute the rays' directions based on the averaged normals of the low poly mesh.
--skew_correction <bool> [default: "false"]
Enable the straightening of the rays' directions based on a grayscale texture: the skew map, which is used to specify the areas of the low poly meshes where the direction of rays should be smoothed (dark areas) or straightened (bright areas). This is useful to avoid projection deformation.
--use_cage <bool> [default: "false"]
Enable the use of a dedicated scene which meshes are used as a source for the projection rays. When set to "false", the "projection.max_depth" and "projection.max_height" options are used to set arbitrary values for all meshes.
--use_lowdef_as_highdef <bool> [default: "false"]
Use the low poly scene as the high poly scene. This is meant for using most bakers without adding extra detail from other scenes.

Baker options

--maximize_range <string> [default: "min_max"]
The normalization method applied to the computed image, if any. I.e., how to map the values to a specified range. Available options: - ray_distance : Remap the values to the range of distances of ray hits. - min_max : Remap the values from 0 to 1 where 0 is the thinnest high poly mesh volume and 1 is the thickest. - none : No normalization is applied.
--secondary.max_distance <double> [default: "0.1"]
Maximum distance of other detected surfaces. Surfaces farther than that distance are ignored.
--secondary.mesh_match_mode <string> [default: "match_all"]
The rule for detecting meshes in the high poly scene. Available options: - match_all : all meshes in the high poly scene are detected. - match_mesh_name : only meshes in the high poly scene with the same name as the source mesh in the low poly scene are detected.
--secondary.min_distance <double> [default: "1e-05"]
Minimum distance of other detected surfaces. Surfaces closer than that distance are ignored.
--secondary.normalized_distance <bool> [default: "true"]
Interpret the "min_distance" and "max_distance" values as multipliers of the mesh bounding box.
--secondary.sample_count <uint> [default: "64"]
Number of secondary rays. Range: [1; 256]
--secondary.sample_distribution <string> [default: "cosine"]
The angular distribution of rays. Available options: - uniform - cosine
--secondary.spread_angle <double> [default: "180"]
The maximum spread angle of rays.

Hidden options

--debug

Subcommand info

Description

Prints information about 3D scene(s): meshes, UVs, materials, etc.

Input options

--inputs <path>
The 3D scene file(s) to process. Alternatively, a list of paths may be provided without the '--inputs' option at the end of the command.

Specific options

--hide-bounding-box
Do not print the bounding box information of entities in the scene.
--hide-location
Do not print the location of entities in the scene.
--list-all
Print information of all entities in the scene.
--list-uv-tiles
List all UV tiles used by each entity in the scene.
--print-camera
Print information about camera entities in the scene.
--print-lighting
Print information about lighting entities in the scene.

Subcommand run

Description

Executes a list of bakers described in a JSON file. JSON execution plans may be exported from Substance 3D Designer's baking interface.

Batch options

--backends <string,...>
Specifies the prioritization order of the raytracing backends, from first to last, as an ordered list. Defaults to the "SAL" GPU backend if unused. Available backends: - GPU: SAL - CPU: Embree, SoRa E.g.: --backends SAL,SoRa,Embree
--cpu
Run the bakers exclusively on the CPU.
--json <path>
The JSON file describing an execution plan, which contains a list of bakers with global and discrete options.
--keep_meshes_in_cache <bool> [default: "yes"]
Keep the meshes in memory between bakes.
--texture_cache_size <int> [default: "222490"]
Amount of memory allocated to intermediary textures used in the baking process, in MB. Default value is 222490 MB.

Hidden options

--debug

Subcommand update

Description

Updates a JSON file describing an execution plan to the format used by this version of the Substance 3D bakers.

Options

--input <path>
The JSON file to update.
--output <path>
Specify the path of the output JSON file. If not specified the input file is updated in place.