- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
sbsrender base parameters and pattern variables
Base parameters
With sbsrender command line it's possible to tweak some sbsar's exposed parameters with the flag --set-value
windows, depends the console escape using ' :
sbsrender render C:pathtofile.sbsar --set-value '$outputsize@11,11'
linux (macos) escape the $ using \ :
sbsrender render /path/to/file.sbsar --set-value $outputsize@11,11
The list of the base parameters name:
Output Size: $outputsize@,
Output Format: $format@
Pixel Size: $pixelsize@,
Pixel Ratio: $pixelration@
Tiling Mode: $tiling@
Random Seed: $randomseed@
Pattern variables
SbsRender can replace some pattern by the content of its variable as shown in the next example:
sbsrender render C:pathtofile.sbsar --output-name map_{outputNodeName}
The list of the available pattern variables:
{inputName}
the name of the input sbsar file
{inputGraphUrl}
the graph name
{outputNodeName}
the processed output node's identifier
{inputPath}
the directory path of the input sbsar file, usable only with --output-path flag
{outputIndex}
the processed output node's index, 0, 1, 2 ... by creation order
{outputUsages}
the processed output node's usages, if more than one usage is set they will be concatenated with _ (underscore)
{outputLabel}
the processed output node's label
{outputGroup}
the processed output node's group name
{outputUserData}
the processed output node's user data
{colorspace}
the processed output node's colorspace