User Guide Cancel

sbsrender example command lines | Substance 3D Automation ToolKit

  1. Substance 3D home
  2. Home
  3. Command Line Tools
    1. Command Line overview
    2. sbsbaker
      1. sbsbaker overview
      2. sbsbaker command line options
      3. sbsbaker Example Command Lines
    3. sbscooker
      1. sbscooker overview
      2. sbscooker command line options
      3. sbscooker pattern variables
    4. sbsmtools
      1. sbsmtools overview
      2. sbsmtools command line options
    5. sbsmutator
      1. sbsmutator overview
      2. sbsmutator command line options
      3. sbsmutator Example Command Lines
    6. sbsrender
      1. sbsrender overview
      2. sbsrender base parameters and pattern variables
      3. sbsrender command line options
      4. sbsrender example command lines
    7. sbsupdater
      1. sbsupdater overview
      2. sbsupdater command line options
  4. Pysbs - Python API
    1. Pysbs - Python API overview
    2. Getting started
    3. General topics
      1. Basic manipulation
      2. Substance creation
      3. Substances modification
      4. Dependencies management
      5. PySbs batchtools module
      6. metadata manipulation
      7. SAT demos
      8. Edit sbsar with SBSARManager
      9. Spot Colors
      10. Thumbnail creation with SAT
    4. Examples
      1. demohelloworld
      2. demos
      3. demos_batchtools
      4. script_update_with_sbsupdater
    5. API Content
      1. API Content overview
      2. Substance definitions
        1. Common interfaces
          1. basegraph
          2. package
          3. sbsarobject
          4. sbsobject
        2. compnode
          1. compnode overview
          2. common
          3. compimplementation
          4. paramgraph
        3. context projectmgr
        4. graph
          1. graph overview
          2. function
          3. inputparameters
          4. output
        5. mdl
          1. mdlannotation
          2. mdlcommon
          3. mdldictionaries
          4. mdlenum
          5. mdlgraph
          6. mdllibclasses
          7. mdlmanager
          8. mdlnode
          9. mdlnodeimpl
          10. mdloperand
          11. mdlsbsbridge
        6. modelgraphindex
          1. modelannotationnames
          2. modelgraph
          3. modelgraphgenerator
          4. modelgraphimplementation
          5. modelnodenames
          6. modeloperand
          7. modulegraphindex
          8. moduleannotation
          9. moduleconnection
          10. modulegraph
          11. modulegraphgenerator
          12. modulegraphimplementation
          13. modulegraphlibrary
          14. modulegraphregister
          15. modulenode
          16. modulenodeimplementation
          17. modulenodeinstance
          18. moduleoperand
          19. moduleoutputbridging
          20. moduleparaminput
        7. params
          1. params overview
          2. dynamicvalue
          3. paramnode
        8. projectmgrdoc
        9. sbsarchive
          1. sbsarchive overview
          2. sbsarenum
          3. sbsargraph
          4. sbsargui
          5. sbsarguiwidgets
          6. sbsarmanager
        10. sbscommon
          1. connections
          2. gui
          3. nodes
          4. values
        11. sbspreset
        12. sbsproject
        13. substance
          1. substance overview
          2. content
          3. resource
      3. Libraries
        1. sbsenum
        2. sbslibrary
          1. sbslibrary overview
          2. sbsdictionaries
          3. sbsfilters
          4. sbsfunctions
          5. sbsfxmapnodes
          6. sbslibclasses
          7. sbswidgets
        3. sbsbakerslibrary
          1. sbsbakerslibrary overview
          2. sbsbakersdef
          3. sbsbakersdefaultprops
          4. sbsbakersdictionaries
          5. sbsbakersenum
          6. sbsbakingconverter
          7. sbsbakingconverterparam
          8. sbsbakingparameters
          9. sbsdialogstate
          10. sbsscenedata
        4. Helpers
          1. sbscleaner
          2. sbsexporter
          3. sbsgenerator
          4. sbsparser
          5. sbswriter
          6. qtclasses
            1. qtclasses overview
            2. qtvariantreader
            3. qtvariantwriter
          7. psdparser
          8. sbsimpactmanager
          9. batchtools
          10. autograph
            1. ag_functions
            2. ag_layout
            3. 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
  5. Samples
    1. Samples overview
    2. Texturing Template Demo
    3. Batch Tools Demo
    4. Variations
    5. Texture Mat
    6. Pixel Processor Ray tracer
  6. Setup and Getting Started
    1. Setup and Getting Started overview
    2. Compatibility
    3. Frequently asked Questions
    4. Known issues
    5. SAT Cookbook
    6. Use Pysbs in different python interpreter (maya, sd, blender...)
  7. Integrations
    1. Substance Maya toolset
      1. Substance Maya Toolset overview
      2. Installing
      3. Launching
      4. Baking
        1. Baking overview
        2. Export parameters
        3. Baker parameters
        4. Mesh setup
        5. Using a template
      5. Changelog
  8. Changelog overview

sbsrender example command lines

This page contains examples of command lines for invoking the command line processors in various environments. In the examples, the command line tools are assumed to be in the PATH.

OpenColorIO with sbsrender

Substance Designer 2019.3 support OpenColorIO (https://opencolorio.org/).

The examples assumes that you are already familiar with OCIO and a color workflow like ACES. SAT and SD provide three different color workflows (luts and config files are present in $SAT_INSTALL_DIR/resources/ocio):

  • Legacy, the color workflow used in previous versions. Legacy uses the old color engine.
  • Aces, the Academy Color Encoding System (https://en.wikipedia.org/wiki/Academy_Color_Encoding_System) which provides a set of color transforms adapted to the tv and cinema industry. Aces uses the OCIO color engine.
  • Substance, a simplified Aces workflow. A selection of the most used colorspaces in the VFX and animation industry. Substance also uses the OCIO color engine.

A new set of flags have been added to sbsrender to control OCIO:

--ocio Specify an OpenColorIO configuration to use (can be a config.ocio present in $SAT_INSTALL_DIR/resources/ocio). If you don't set this flag the legacy color engine will be used.

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

Input colorspace is controlled using:

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

Output colorspace is controlled using the following flags:

--set-output-bit-depth Specify the bit depth of an output node. --set-output-bit-depth output_id@16f

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

--set-output-format Specify the image format of an output node. --set-output-format output_id@exr

The new colorspace pattern {colorspace} will be converted to the used colorspace when generating filenames.

Example of using OCIO in sbsrender command line:

Note, The substance file must have been authored with an OCIO workflow in Designer work properly. If using bitmap resources the cooking must be done with OCIO option (sbscooker --ocio or publishing using Substance Designers publish feature)

The colorspace value must correspond to a colorspace present in the config.ocio file.

sbsrender render /path/to/ocio_graph.sbar --output-name "ocio_{outputNodeName}_{colorspace}" --output-colorspace Linear --set-output-colorspace basecolor_output@sRGB --set-entry bitmap_input@/path/to/bitmap.png --set-entry-colorspace Linear --ocio $SAT_INSTALL_DIR/resources/ocio/substance/config.ocio

 Adobe

Get help faster and easier

New user?