sbsrender

Usage

• sbsrender [...] info [...]
• sbsrender [...] render [...]

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

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

The substance archive to render.

--input-graph

Select specific graph to be rendered. If no graph are selected, all graphs are rendered.

--input-graph-output

Select output to be rendered. If no output are selected, all outputs are rendered.

--input-graph-output-usage

Select output to be rendered by giving usage name.

--no-report

Inhibits writing of JSON output to stdout.

--output-bit-depth

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. can be set to "8" (or "int8"), "16" (or "int16"),"16f" (or "float16") or "32f" (or "float32").

--output-colorspace

Specify the colorspace name for outputs. --output-colorspace sRGB.

--output-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, psd, psb, hdr, exr, webp, surface.

--output-name [default: "{inputName}_{inputGraphUrl}_{outputNodeName}"]

Output file name, if the correct file extension is not present it will be added. 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. - {colorspace} replaced by the output colorspace.

--output-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 [default: "default"]

PNG compression to use for output image. Default='default'. Compressions Supported: default, best_speed, best_compression, none.

Specific options

--set-entry

Set image data to an image input. Format of : @.

--set-entry-colorspace

Specify the colorspace name for an input. --set-entry-colorspace input_id@sRGB.

--set-entry-usage

Set image data to an image input. Format of : @.

--set-output-bit-depth

Change the bit depth of an output node.

--set-output-colorspace

Specify the colorspace name for an output. --set-output-colorspace output_id@sRGB.

--set-output-format

Change the image format of an output node.

--set-value

Set value to a numerical input parameter. Format of : @.

--use-preset

Use a specific preset to set values. is the name of preset that must be included in the input sbsar file.

Runtime options

--ace

Use Adobe ACE color management engine.

--ace-render-intent

Render intent to use when using Adobe ACE. The default value if not specified is relative-colorimetric. Valid options include perceptual, saturation, relative-colorimetric and absolute-colorimetric

--ace-working-space

Working color space to use when using Adobe ACE. The default value if not specified is srgb. Valid options include srgb, linear-srgb and acescg

--cache-dir

Sets the folder where intermediate render results will be stored.

--cpu-count

Set the maximum amount of CPU cores that the Substance Engine is allowed to use.

--engine

Switch to specific engine implementation. format of : or e.g.: ogl3, d3d11pc, ...

--icc-profiles-dir

Specify the directory to search for user ICC profiles. Only used when ACE color management is enabled.

--memory-budget

Set the maximum amount of memory that the Substance Engine is allowed to use. In MB (default 2000 MB).

--ocio

Specify an OpenColorIO configuration to use.