Note

Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.

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

Share this page

Ask the Community

Contact Us