API overview

Pysbs allows reading, editing and creating substances through Python.

• Basic manipulation of a Substance
  • Opening and writing a substance
  • Requesting information on a Substance
• Creation of a Substance from scratch
  • Sample 1: Hello World
  • Sample 2: Full creation demonstration
  • Highlights on the most important modules and classes of the API
• Modification of Substances
  • Massive modification of Substances
  • Baking Parameters modification
  • Iteration generation
    • Sample 1: Compositing node iteration
    • Sample 2: Iteration inside a Pixel Processor
    • Sample 3: Iteration inside a function, and use of variables
• Dependency path storage method
• Dependencies management
  • Exporting a package with its dependencies
  • Impact propagation
  • Get all substance dependencies recursively
  • Dependency path resolution method
• PySBS batchtools presentation
  • batchtool’s OutputHandlers
  • render animation sequence
  • command_only option
  • Generate thumbnails
• Package metadata manipulation
  • Metadata from a sbsar
  • Resource of type OTHER
• SAT and Spot colors
  • Spot colors with spotcolorinfo
  • Spot colors with PySBS
• Generate thumbnails
  • Generate thumbnail with pysbs.batchtools.thumbnail
  • Setup a graph correctly to be render as thumbnail
  • Generating and embedding thumbnail directly from a substance or substance archive
• Edit sbsar with SBSARManager
• SAT demos
  • demohelloworld module: A very simple function that creates a basic Substance, which uses the API without argument file
    • demoHelloWorld()
    • main()
  • demos module: Set a sample functions to demonstrate the use of the API, using argument files
    • demoBakingParameters()
    • demoBuildSBSFromPainterBitmaps()
    • demoCreation()
    • demoExportWithDependencies()
    • demoIteration()
    • demoIterationFlame()
    • demoIterationPixProc()
    • demoMassiveModification()
    • demoReadWriteSBS()
  • demos_batchtools module: Set a sample functions to demonstrate the use of the API with the batchtools, using argument files
    • demoUdimPipeline()
  • script_update_with_sbsupdater: Script allowing to update all Substances in a folder using the Batch Tool SBSUpdater
    • scriptUpdatePackagesVersion()