sbscooker

Usage

• sbscooker [...]

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.

--help-advanced

Display full help about every options of given subcommand. If no subcommand is provided, 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.

--version-cooker

Display the version of the cooker.

--version-linker

Display the version of the linker.

Subcommand cook

I⁄O options

--alias

Add an alias definition. syntax of : ':⁄⁄' Every occurence of in every url of every input file with be replaced with before cooking.

--enable-icons

Include graph icons files in the SBSAR if they exist.

--inputs

Paths to the substance files to cook (in the .sbs file format).

--merge

Merge all the results in one file

--no-archive

Generate non packaged SBSASM and XML.

--output-name [default: "{inputName}"]

Set the output name of the generated files, without the extension."The name is "{inputName}" by default. You can use the following patterns that will be replaced by the program when saving the result of the process: {inputName} Replaced by the name of the first processed sbs file. {udim} Replaced by the UDIM id of the cooked tile (MARI convention).

--output-path

Set the output path for the generated files. By default the path is empty, i.e. the files will be saved in the current directory. You can use the following patterns that will be replaced by the program when saving the result of the process: {inputPath} Replaced by the path of the first processed sbs file.

--presets-path, --includes

--presets-path⁄includes is deprecated, built-in packages location is autodetect next to sbscooker executable. If you need to use another location please use the --alias sbs:⁄⁄ option.

Cooking 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

--icc-profiles-dir

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

--compression-mode [default: "0"]

Set the compression mode : specify '0' for "auto", '1' for "best" and '2' for "none".

--expose-output-size [default: "yes"]

Expose output size ? ('0' = "no", '1' = "yes").

--expose-pixel-size [default: "no"]

Expose pixel size ? ('0' = "no", '1' = "yes").

--expose-random-seed [default: "yes"]

Expose random seed ? ('0' = "no", '1' = "yes").

--no-optimization

Disable optimization. Check advanced parameters for finer tweaks with optimization.

--ocio

Specify the OpenColorIO configuration file to use for managing bitmap resources. When not set, the legacy mode is used.

--size-limit

Maximum width and height of all compositing nodes,given as the exponent of a power in base 2.In other words, you must provide the logarithm in base 2 of the actual width⁄height. For example '--size-limit 10' means nodes have a size limit of 1024x1024 pixels. [Default value: Engine specific]

--udim

Coordinates of the uv tile to compute, given as a UDIM id (MARI convention) (e.g "1022"). [default: "1001"]

--uv-tile ,

Coordinates of the uv tile to compute, given as two zero-based indices, e.g. "1,2". [default: "0,0"]

Linking options

--link

Call linker to generate .sbsbin file for an engine identified with the or parameter.

--link-output-name [default: "{outputName}_{engineName}"]

Set the output name of the generated linked files, without the extension.The name is "{outputName}_{engineName}" by default. You can use the following patterns that will be replaced by the program when saving the result of the process: - {inputName} Replaced by the name of the processed sbs. - {engineName} Replaced by the name of the engine used to link the sbs. - {outputName} Replaced by the output name specified by the --output-name command.

--link-output-path [default: "{outputPath}"]

Set the output path of the generated linked files.The path is "{outputPath}" by default. program when saving the result of the process: - {inputPath} Replaced by the path of the processed sbs. - {engineName} Replaced by the name of the engine used to link the sbs. - {outputPath} Replaced by the output path specified by the --output-path command.

Watermarking options

--post-filter

Post-filter substance file to apply (in the .sbs file format).

Cooking optimization options

can either be "0", "off", "no" or "false" to disable the optimizationor "1", "on", "yes" or "true" to turn it on.

--crc [default: "0"]

Reduce cooking time.

--full [default: "1"]

Full optimizations options. Best performance and memory footprint, slower cooking process.

--merge-data [default: "0"]

Reduce binary size.

--merge-graph [default: "0"]

Best performance.

--reordering [default: "0"]

Reduce memory footprint.

Other options

--internal