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

thumbnail

 class batchtools.thumbnail.ThumbnailRenderSbsarUsages

Bases: object

 AMBIENTOCCLUSION = ('ambientOcclusion',)

 ANISOTROPYANGLE = ('anisotropyAngle',)

 ANISOTROPYLEVEL = ('anisotropyLevel',)

 BASECOLOR = ('baseColor',)

 EMISSIVE = ('emissive',)

 HEIGHT = ('height',)

 METALLIC = ('metallic',)

 NORMAL = ('normal',)

 OPACITY = ('opacity',)

 PHYSICALSIZE = ('physicalSize',)

 ROUGHNESS = ('roughness',)

 SPECULARLEVEL = ('specularLevel',)

 batchtools.thumbnail.generate(aInput, aSize=(10, 10), aOutputPath=None, aThumbnailTemplate=None, aContext=None, aOutputInputMapping=None)

Generate a thumbnail for the given sbsar input. By default the connection between the input file and the thumbnail render sbsar is based on the usage names

Parameters:	aInput (str) – the sbs or sbsar to render aSize (tuple(int, int), list(int, int)) – the output size for the rendering textures, 10x10 (1024x1024) by default. aThumbnailSize (tuple(int, int), list(int, int)) – the output size for the thumbnail image, 9x9 (512x512) by default. aOutputPath (str) – the thumbnail output path aThumbnailTemplate (str) – a sbsar use to generate thumbnail, use the internal one by default. aContext (class:.Context) – use a context different that the default one. Useful if some aliases are set. engine (str) – the engine to use, by default use gpu with ogl3 or d3d11pc. aGraphIdentifier (str) – the graph identifier for the thumbnail generation, if None the first graph will be used. aPreset (str) – render graph thumbnail for the given preset label. aCachePath (str) – the cache files directory path, by default cache files needs by thumbnail generator are saved in a TEMP folder. quiet (bool) – disable warning messages customValues (list(str)) – pass a list of custom param input values, the values must look a str “inputparam@value,value,value”. customValues overwrite the default values.
Returns:	generated thumbnail output path

Parameters:

aInput (str) – the sbs or sbsar to render
aSize (tuple(int, int), list(int, int)) – the output size for the rendering textures, 10x10 (1024x1024) by default.
aThumbnailSize (tuple(int, int), list(int, int)) – the output size for the thumbnail image, 9x9 (512x512) by default.
aOutputPath (str) – the thumbnail output path
aThumbnailTemplate (str) – a sbsar use to generate thumbnail, use the internal one by default.
aContext (class:.Context) – use a context different that the default one. Useful if some aliases are set.
engine (str) – the engine to use, by default use gpu with ogl3 or d3d11pc.
aGraphIdentifier (str) – the graph identifier for the thumbnail generation, if None the first graph will be used.
aPreset (str) – render graph thumbnail for the given preset label.
aCachePath (str) – the cache files directory path, by default cache files needs by thumbnail generator are saved in a TEMP folder.
quiet (bool) – disable warning messages
customValues (list(str)) – pass a list of custom param input values, the values must look a str “inputparam@value,value,value”. customValues overwrite the default values.

Returns:

generated thumbnail output path

Get help faster and easier

New user?

thumbnail | Substance 3D Automation ToolKit

thumbnail

Get help faster and easier

Ask the Community

Contact Us