User Guide Cancel

sbsrender base parameters and pattern variables | Substance 3D Automation ToolKit

Last updated on May 24, 2023

Substance 3D Automation Toolkit

Open app

Substance 3D home
Home
Command Line Tools
1. Command Line overview
2. sbsbaker
3. sbscooker
4. sbsmtools
  1. sbsmtools overview
  2. sbsmtools command line options
5. sbsmutator
6. sbsrender
7. sbsupdater
  1. sbsupdater overview
  2. sbsupdater command line options
Pysbs - Python API
1. Pysbs - Python API overview
2. Getting started
3. General topics
4. Examples
5. API Content
  1. API Content overview
  2. Substance definitions
    1. Common interfaces
    2. compnode
    3. context projectmgr
    4. graph
    5. mdl
    6. modelgraphindex
    7. params
    8. projectmgrdoc
    9. sbsarchive
    10. sbscommon
      1. connections
      2. gui
      3. nodes
      4. values
    11. sbspreset
    12. sbsproject
    13. substance
  3. Libraries
    1. sbsenum
    2. sbslibrary
    3. sbsbakerslibrary
    4. Helpers
      1. sbscleaner
      2. sbsexporter
      3. sbsgenerator
      4. sbsparser
      5. sbswriter
      6. qtclasses
        
        qtclasses overview
        
        qtvariantreader
        
        qtvariantwriter
      7. psdparser
      8. sbsimpactmanager
      9. batchtools
      10. autograph
        
        ag_functions
        
        ag_layout
        
        ag_types
      11. info_mesh_parser
      12. sbsbaker_info_handlers
      13. sbsrender_render_handlers
      14. output_handlers
      15. spotcolorinfo_handler
      16. thumbnail
      17. batchtools overview
    5. Execution context
      1. context
      2. functions
    6. API Change log
Samples
Setup and Getting Started
Integrations
1. Substance Maya toolset
  1. Substance Maya Toolset overview
  2. Installing
  3. Launching
  4. Baking
  5. Changelog
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

Get help faster and easier

New user?