User Guide Cancel

batchtools | Substance 3D Automation ToolKit

Search
Substance 3D Automation Toolkit

Substance 3D Automation Toolkit

Open app
  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

batchtools

Content included in batchtools package:

 batchtools.batchtools.sbsbaker_ambient_occlusion(*pargs, **kwargs)

Launch process sbsbaker ambient-occlusion ..

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker ambient-occlusion, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker ambient-occlusion --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker ambient-occlusion
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker ambient-occlusion
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_ambient_occlusion_from_mesh(*pargs, **kwargs)

Launch process sbsbaker ambient-occlusion-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker ambient-occlusion-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker ambient-occlusion-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker ambient-occlusion-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker ambient_occlusion-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_bent_normal_from_mesh(*pargs, **kwargs)

Launch process sbsbaker bent-normal-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker bent-normal-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker bent-normal-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker bent-normal-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker bent-normal-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_color_from_mesh(*pargs, **kwargs)

Launch process sbsbaker color-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker color-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker color-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker color-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker color-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_curvature(*pargs, **kwargs)

Launch process sbsbaker curvature with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker curvature, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker curvature --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker curvature
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker curvature
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_curvature_from_mesh(*pargs, **kwargs)

Launch process sbsbaker curvature-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker curvature-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker curvature-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker curvature-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker curvature-from-mesh
  • legacy – use the old curvature-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_height_from_mesh(*pargs, **kwargs)

Launch process sbsbaker height-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker height-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker height-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker height-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker height-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_info(*pargs, **kwargs)

Launch process sbsbaker info with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker info, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker info --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker info
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker info
Returns:

The popen object used to call the command or SbsBakerInfoOutputHandler if output_handler=True

 
 batchtools.batchtools.sbsbaker_info_get_mesh_info(meshPath)

Get the list of materials, entities, and number of UV set of the given mesh and return them as a triplet.

Parameters:meshPath (str) – Path of the mesh to inspect
Returns:A triplet: [materials],[entities],nb_of_uvset 
 batchtools.batchtools.sbsbaker_normal_from_mesh(*pargs, **kwargs)

Launch process sbsbaker normal-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker normal-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker normal-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker normal-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker normal-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_normal_world_space(*pargs, **kwargs)

Launch process sbsbaker normal-world-space with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker normal-world-space, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker normal-world-space --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker normal-world-space
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker normal-world-space
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_opacity_mask_from_mesh(*pargs, **kwargs)

Launch process sbsbaker opacity-mask-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker opacity-mask-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker opacity-mask-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker opacity-mask-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker opacity_mask-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_position(*pargs, **kwargs)

Launch process sbsbaker position with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker position, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker position --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker position
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker position
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_position_from_mesh(*pargs, **kwargs)

Launch process sbsbaker position-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker position-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker position-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker position-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker position-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_run(*pargs, **kwargs)

Launch process sbsbaker run with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker run, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker run --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker run
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker run
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_texture_from_mesh(*pargs, **kwargs)

Launch process sbsbaker texture-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker texture-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker texture-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker texture-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker texture-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_thickness_from_mesh(*pargs, **kwargs)

Launch process sbsbaker thickness-from-mesh with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker thickness-from-mesh, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker thickness-from-mesh --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker thickness-from-mesh
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker thickness-from-mesh
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_uv_map(*pargs, **kwargs)

Launch process sbsbaker uv-map with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker uv-map, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker uv-map --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker uv-map
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker uv-map
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsbaker_world_space_direction(*pargs, **kwargs)

Launch process sbsbaker world-space-direction with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker world-space-direction, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsbaker world-space-direction --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsbaker world-space-direction
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsbaker world-space-direction
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbscooker(*pargs, **kwargs)

Launch process sbscooker with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbscooker, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbscooker --help-advanced to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbscooker
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbscooker
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsmtools_export(*pargs, **kwargs)

Launch process sbsmtools export with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmtools export, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender info --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsmtools export
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender info
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsmutator_edit(*pargs, **kwargs)

Launch process sbsmutator edit with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator edit, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsmutator edit --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsmutator edit
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsmutator edit
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsmutator_export(*pargs, **kwargs)

Launch process sbsmutator export with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator export, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsmutator export --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsmutator export
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsmutator export
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsmutator_info(*pargs, **kwargs)

Launch process sbsmutator info with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator info, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsmutator info --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsmutator info
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsmutator info
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsmutator_instantiate(*pargs, **kwargs)

Launch process sbsmutator instantiate with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator instantiate, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsmutator instantiate --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsmutator instantiate
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsmutator instantiate
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsrender_info(*pargs, **kwargs)

Launch process sbsrender info with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender info, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender info --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsrender info
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender info
Returns:

The popen object used to call the command

 
 batchtools.batchtools.sbsrender_render(*pargs, **kwargs)

Launch process sbsrender render with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender render --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsrender render
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender render
Returns:

The popen object used to call the command or SbsRenderOutputHandler if output_handler=True

 
 batchtools.batchtools.sbsrender_render_animate(input_sbsar, start=0, end=100, output_name=None, fps=24, animated_parameters=(), cmds_output_stream=None, multi_proc=0, **kwargs)

Renders an image sequence from an sbsar input using sbsrender. It takes a start frame, an end frame and frames per second. The sbsrender command line tool will be run once for each frame.

By default the $time will be generated for each frame based on start, end and fps. It is possible to set sbsrender arguments as global frame parameters.

The animated_parameters can be used to tweak other sbsar parameters than $time This argument allow to pass a list of pairs of parameter names and functions taking frame and fps as parameters. e.g: animated_parameters=[(“input”, compute_input)] the value named “input” will be set to the result of calling compute_input(frame, fps). A lambda can also be used be used, e.g: animated_parameters=[(“input”, lambda frame, fps: frame / fps)] Multiple values can be animated by supplying a list of parameters and functions, e.g: animated_parameters=[(“input”, lambda frame, fps: frame / fps), (“other”, a_python_def(frame, fps))]

If setting multi_proc to a non-zero value the rendering will be multi processed in the specified number of processes executing the rendering sequentially frame by frame.

By providing a path to the argument cmds_output_path the sbsrender will not be executed but all command lines will be written in the file. So it possible for instance to dispatch theses command line through a render farm.

Parameters:
  • input_sbsar (str) – sbsar path file as input
  • start (int) – start frame
  • end (int) – end frame
  • output_name (str) – the name of the ouput files, it must contain a sequence pattern, e.g: ### or %3d for three digit.
  • fps (int) – frame rate
  • animated_parameters ((str, function(fram, fps) or [(str, function(fram, fps)]) – a pair of parameter name and corresponding function to compute it or a list of such pairs.
  • cmds_output_stream (io.TextIOBase) – stream to write commands to instead of executing them
  • multi_proc (int) – if greater than 0 the rendering will be parallelize by the multi_proc value.
  • kwargs – other key arguments
Returns:

bool, true if all frames succeeded, otherwise false

 
 batchtools.batchtools.sbsupdater(*pargs, **kwargs)

Launch process sbsupdater with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsupdater, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsupdater --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsupdater
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsupdater
Returns:

The popen object used to call the command

 
 batchtools.batchtools.spotcolorinfo_from_ids(*pargs, **kwargs)

Launch process spotcolorinfo from-ids with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender render --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsrender render
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender render
Returns:

The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True

 
 batchtools.batchtools.spotcolorinfo_from_names(*pargs, **kwargs)

Launch process spotcolorinfo from-names with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender render --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsrender render
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender render
Returns:

The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True

 
 batchtools.batchtools.spotcolorinfo_list(*pargs, **kwargs)

Launch process spotcolorinfo list with given positional arguments and options.

The call is done by subprocess.Popen from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render, with dashes - replaced with underscores _ and with the leading -- or - removed. Run sbsrender render --help to see the list of possible options.

Parameters:
  • pargs – the positional arguments to give to sbsrender render
  • kwargs – keyword arguments that can be given to subprocess.Popen or that correspond to options of sbsrender render
Returns:

The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy