sbsrender command line options


sbsrender

Usage

  • sbsrender [<global_options>...] info [<options>...]
  • sbsrender [<global_options>...] render [<options>...]

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 info

Description

Return description of a substance archive file.

I⁄O options

--input <path>
Substance Archive File described. This option is implicit, so you can just provide a filepath at the end of your arguments, they will be interpreted as input.

Subcommand render

Description

Render outputs of a substance archive file to image files.

I⁄O options

--input, --inputs <path>
The substance archive to render.
--input-graph <graph_url>
Select specific graph to be rendered. If no graph are selected, all graphs are rendered.
--input-graph-output <name>
Select output to be rendered. If no output are selected, all outputs are rendered.
--no-report
Inhibits writing of JSON output to stdout.
--output-bit-depth <name>
Change the bit depth of the result image. The computation is still done in the bit depth the cooked graph uses. This option only affects the bit depth of the output image. <name> can be set to "8" (or "int8"), "16" (or "int16"),"16f" (or "float16") or "32f" (or "float32").
--output-format <format> [default: "png"]
Format to use for output image file. Default='png'. Formats Supported: dds, bmp, jpg, jif, jpeg, jpe, png, tga, targa, tif, tiff, wap, wbmp, wbm, hdr, exr, webp, psd.
--output-name <name> [default: "{inputName}_{inputGraphUrl}_{outputNodeName}"]
Output file name. Default='{inputName}_{inputGraphUrl}_{outputNodeName}'. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputName} replaced by the archive filename. - {inputGraphUrl} replaced by the graph url. - {outputNodeName} replaced by the output name.
--output-path <path>
Output file path. Default path is empty. You can use the following patterns that will be replaced by the program when saving the result of the process: -{inputPath} replaced by the input filepath.
--png-format-compression <format> [default: "default"]
PNG compression to use for output image. Default='default'. Compressions Supported: default, best_speed, best_compression, none.

Specific options

--set-entry <arg>
Set image data to an image input. Format of <arg>: <input_identifier>@<filepath_of_image>.
--set-value <arg>
Set value to a numerical input parameter. Format of <arg> : <input_identifier>@<value>.
--use-preset <name>
Use a specific preset to set values. <name> is the name of preset that must be included in the input sbsar file.

Runtime options

--cache-dir <string>
Sets the folder where intermediate render results will be stored.
--cpu-count <uint>
Set the maximum amount of CPU cores that the Substance Engine is allowed to use.
--engine <arg>
Switch to specific engine implementation. format of <arg> : <dynamic_library_filepath> or <engine_version_basename_substring> e.g.: ogl3, d3d10pc, ...
--memory-budget <uint>
Set the maximum amount of memory that the Substance Engine is allowed to use. In MB (default 1000 MB).