User Guide Cancel

sbsenum | 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

sbsenum

Module sbsenum provides all the enumeration used in Pysbs.

class sbsenum.ParamTypeEnum

Bases: object

Enumeration of all the types manipulated by Substance Designer

DUMMY_TYPE          = 0 
ENTRY_COLOR         = 1 
ENTRY_GRAYSCALE     = 2 
ENTRY_VARIANT       = ENTRY_COLOR | ENTRY_GRAYSCALE         # grayscale or color entry 
BOOLEAN             = 4 
INTEGER1            = 16 
INTEGER2            = 32 
INTEGER3            = 64 
INTEGER4            = 128 
FLOAT1              = 256 
FLOAT2              = 512 
FLOAT3              = 1024 
FLOAT4              = 2048 
FLOAT_VARIANT       = FLOAT4 | FLOAT1                       # grayscale or color value 
ENTRY_COLOR_OPT     = ENTRY_COLOR | FLOAT4                  # optional color entry 
ENTRY_GRAYSCALE_OPT = ENTRY_GRAYSCALE | FLOAT1              # optional grayscale entry 
ENTRY_VARIANT_OPT   = ENTRY_COLOR_OPT | ENTRY_GRAYSCALE_OPT 
ENTRY_PARAMETER     = 4096                                  # parameter graph entry (used for fx-map) 
COMPLEX             = 8192 
STRING              = 16384 
PATH                = 32768 
VOID_TYPE           = 65536                                 # no return type, function only 
TEMPLATE1           = 131072                                # Template type 1, function only 
TEMPLATE2           = 262144                                # Template type 2, function only
class sbsenum.InputValueTypeEnum

Bases: object

Enumeration of all the types compatible with input values

BOOLEAN             = ParamTypeEnum.BOOLEAN 
INTEGER1            = ParamTypeEnum.INTEGER1 
INTEGER2            = ParamTypeEnum.INTEGER2 
INTEGER3            = ParamTypeEnum.INTEGER3 
INTEGER4            = ParamTypeEnum.INTEGER4 
FLOAT1              = ParamTypeEnum.FLOAT1 
FLOAT2              = ParamTypeEnum.FLOAT2 
FLOAT3              = ParamTypeEnum.FLOAT3 
FLOAT4              = ParamTypeEnum.FLOAT4
class sbsenum.TypeMasksEnum

Bases: object

Helper masks enumeration

ENTRY          = ParamTypeEnum.ENTRY_COLOR | ParamTypeEnum.ENTRY_GRAYSCALE 
INTEGER        = ParamTypeEnum.INTEGER1 | ParamTypeEnum.INTEGER2 | ParamTypeEnum.INTEGER3 | ParamTypeEnum.INTEGER4 
SINGLE         = ParamTypeEnum.BOOLEAN | ParamTypeEnum.INTEGER1 | ParamTypeEnum.FLOAT1 
DIM2           = ParamTypeEnum.INTEGER2| ParamTypeEnum.FLOAT2 
DIM3           = ParamTypeEnum.INTEGER3| ParamTypeEnum.FLOAT3 
DIM4           = ParamTypeEnum.INTEGER4| ParamTypeEnum.FLOAT4 
LIST           = DIM2 | DIM3 | DIM4 
FLOAT          = ParamTypeEnum.FLOAT1 | ParamTypeEnum.FLOAT2 | ParamTypeEnum.FLOAT3 | ParamTypeEnum.FLOAT4 
NUMERIC        = ParamTypeEnum.BOOLEAN | INTEGER | FLOAT 
AUTHORING      = ParamTypeEnum.STRING | ParamTypeEnum.PATH 
FUNCTION_ALL   = FLOAT | ParamTypeEnum.BOOLEAN | INTEGER | ParamTypeEnum.VOID_TYPE | ParamTypeEnum.STRING | ParamTypeEnum.PATH   # All functions types 
TEMPLATE_TYPE  = ParamTypeEnum.TEMPLATE1 | ParamTypeEnum.TEMPLATE2                                                               # Type templates (func. only) 
VALUE_TYPES    = NUMERIC | ParamTypeEnum.STRING 
OUTPUT_DEF     = ParamTypeEnum.ENTRY_VARIANT | VALUE_TYPES
class sbsenum.AttributesEnum

Bases: object

Enumeration of the different attributes available on a SBSGraph or a SBSFunction

Category     = 0 
Label        = 1 
Author       = 2 
AuthorURL    = 3 
Tags         = 4 
Description  = 5 
UserTags     = 6 
Icon         = 7 
HideInLibrary= 8 
PhysicalSize = 9
class sbsenum.BitmapFormatEnum

Bases: object

Enumeration of the supported bitmap format

RAW        = 0 
DDS        = 1 
DDSSTRIPPED= 2 
BMP        = 3 
JPG        = 4 
TGA        = 5 
HDR        = 6 
PPM        = 7 
PFM        = 8
class sbsenum.InputEnum

Bases: object

Enumeration of the input identifier available on the compositing node filters (SBSCompFilter)

BACKGROUND       = 0 
DESTINATION      = 1 
INPUT            = 2 
INPUT1           = 3 
INPUT2           = 4 
INPUT_GRADIENT   = 5 
INPUT_INTENSITY  = 6 
INPUT_NODE_OUTPUT= 7 
INPUT_PATTERN    = 8 
MASK             = 9 
OPACITY          = 10 
SOURCE           = 11
class sbsenum.OutputEnum

Bases: object

Enumeration of the output identifiers

OUTPUT = 0 
OUTPUT0= 1 
OUTPUT1= 2 
OUTPUT2= 3 
OUTPUT3= 4 
OUTPUTN= 5
class sbsenum.FilterEnum

Bases: object

Enumeration of the available compositing node filters (SBSCompFilter)

BITMAP               = 0 
BLEND                = 1 
BLUR                 = 2 
COMPINSTANCE         = 3 
CURVE                = 4 
DIRECTIONALMOTIONBLUR= 5 
DIRECTIONALWARP      = 6 
DISTANCE             = 7 
DYNAMICGRADIENT      = 8 
EMBOSS               = 9 
FXMAPS               = 10 
GRADIENT             = 11 
GRAYSCALECONVERSION  = 12 
HSL                  = 13 
LEVELS               = 14 
NORMAL               = 15 
PIXEL_PROCESSOR      = 16 
SHARPEN              = 17 
SHUFFLE              = 18 
SVG                  = 19 
TEXT                 = 20 
TRANSFORMATION       = 21 
UNIFORM              = 22 
VALUE_PROCESSOR      = 23 
WARP                 = 24 
PASSTHROUGH          = 25
class sbsenum.BaseParamEnum

Bases: object

Enumeration of the parameters (SBSParameter) associated to a graph or node (SBSGraph), (SBSCompFilter) and FxMap node (SBSParamsGraphNode)

OUTPUT_FORMAT        = 0 
OUTPUT_SIZE          = 1 
PIXEL_SIZE           = 2 
PIXEL_RATIO          = 3 
QUALITY              = 4 
RANDOM_SEED          = 5 
TILING_MODE          = 6 
ITERATION            = 7
class sbsenum.CompNodeParamEnum

Bases: object

Enumeration of the parameters (SBSParameter) associated to the compositing node filters (SBSCompFilter) and FxMap node (SBSParamsGraphNode)

OUTPUT_FORMAT        = 0 
OUTPUT_SIZE          = 1 
PIXEL_SIZE           = 2 
PIXEL_RATIO          = 3 
QUALITY              = 4 
RANDOM_SEED          = 5 
TILING_MODE          = 6 
ITERATION            = 7 
ALPHA_BLENDING       = 8 
BACKGROUND           = 9 
BACKGROUND_VALUE     = 10 
BLENDING_MODE        = 11 
BLUR_ANGLE           = 12 
BITMAP_RESOURCE_PATH = 13 
BITMAP_RESIZE_METHOD = 14 
CHANNEL_ALPHA        = 15 
CHANNEL_BLUE         = 16 
CHANNEL_GREEN        = 17 
CHANNEL_RED          = 18 
CHANNELS_WEIGHTS     = 19 
CLAMP_IN_TERM        = 20 
COLOR_MODE           = 21 
COMBINE_DISTANCE     = 22 
CROPPING_AREA        = 23 
FILTERING            = 24 
FLATTEN_ALPHA        = 25 
GRADIENT_ADDRESSING  = 26 
GRADIENT_ORIENTATION = 27 
GRADIENT_POSITION    = 28 
HIGHLIGHT_COLOR      = 29 
HUE                  = 30 
INTENSITY            = 31 
NORMAL_FORMAT        = 32 
LEVEL_IN_HIGH        = 33 
LEVEL_IN_LOW         = 34 
LEVEL_IN_MID         = 35 
LEVEL_OUT_HIGH       = 36 
LEVEL_OUT_LOW        = 37 
LIGHT_ANGLE          = 38 
LIGHTNESS            = 39 
MATTE_COLOR          = 40 
MAX_DISTANCE         = 41 
MIPMAP_MODE          = 42 
MIPMAP_LEVEL         = 43 
OPACITY              = 44 
OFFSET               = 45 
OUTPUT_COLOR         = 46 
PER_PIXEL            = 47 
FUNCTION             = 48 
RENDER_REGION        = 49 
ROUGHNESS            = 50 
SATURATION           = 51 
SHADOW_COLOR         = 52 
SVG_RESOURCE_PATH    = 53 
TEXT                 = 54 
TEXT_ALIGN           = 55 
TEXT_FONT            = 56 
TEXT_FONT_SIZE       = 57 
TEXT_FONT_COLOR      = 58 
TEXT_POSITION        = 59 
TILING_REGION        = 60 
TRANSFORM_MATRIX     = 61 
WARP_ANGLE           = 62 
NORMAL_ALPHA_CHANNEL = 63 
FX_BLENDING_MODE      = 64 
FX_BRANCH_OFFSET      = 65 
FX_COLOR_LUM          = 66 
FX_IMAGE_ALPHA_PREMUL = 67 
FX_IMAGE_FILTERING    = 68 
FX_IMAGE_INDEX        = 69 
FX_ITERATIONS         = 70 
FX_PATTERN_OFFSET     = 71 
FX_PATTERN_ROTATION   = 72 
FX_PATTERN_SIZE       = 73 
FX_PATTERN_TYPE       = 74 
FX_PATTERN_VARIATION  = 75 
FX_RANDOM_INHERITED   = 76 
FX_RANDOM_SEED        = 77 
FX_SELECTOR           = 78
class sbsenum.FunctionEnum

Bases: object

Enumeration of the available function nodes (SBSParamNode)

SEQUENCE      = 0 
IF_ELSE       = 1 
SET           = 2 
GET_BOOL      = 3 
GET_INTEGER1  = 4 
GET_INTEGER2  = 5 
GET_INTEGER3  = 6 
GET_INTEGER4  = 7 
GET_FLOAT1    = 8 
GET_FLOAT2    = 9 
GET_FLOAT3    = 10 
GET_FLOAT4    = 11 
GET_STRING    = 12 
CONST_BOOL    = 13 
CONST_INT     = 14 
CONST_INT2    = 15 
CONST_INT3    = 16 
CONST_INT4    = 17 
CONST_FLOAT   = 18 
CONST_FLOAT2  = 19 
CONST_FLOAT3  = 20 
CONST_FLOAT4  = 21 
CONST_STRING  = 22 
INSTANCE      = 23 
VECTOR2       = 24 
VECTOR3       = 25 
VECTOR4       = 26 
SWIZZLE1      = 27 
SWIZZLE2      = 28 
SWIZZLE3      = 29 
SWIZZLE4      = 30 
VECTOR_INT2   = 31 
VECTOR_INT3   = 32 
VECTOR_INT4   = 33 
SWIZZLE_INT1  = 34 
SWIZZLE_INT2  = 35 
SWIZZLE_INT3  = 36 
SWIZZLE_INT4  = 37 
TO_INT        = 38 
TO_INT2       = 39 
TO_INT3       = 40 
TO_INT4       = 41 
TO_FLOAT      = 42 
TO_FLOAT2     = 43 
TO_FLOAT3     = 44 
TO_FLOAT4     = 45 
ADD           = 46 
SUB           = 47 
MUL           = 48 
MUL_SCALAR    = 49 
DIV           = 50 
NEG           = 51 
MOD           = 52 
DOT           = 53 
CROSS         = 54 
AND           = 55 
OR            = 56 
NOT           = 57 
EQ            = 58 
NOT_EQ        = 59 
GREATER       = 60 
GREATER_EQUAL = 61 
LOWER         = 62 
LOWER_EQUAL   = 63 
ABS           = 64 
FLOOR         = 65 
CEIL          = 66 
COS           = 67 
SIN           = 68 
SQRT          = 69 
LOG           = 70 
LOG2          = 71 
EXP           = 72 
POW2          = 73 
TAN           = 74 
ATAN2         = 75 
CARTESIAN     = 76 
LERP          = 77 
MIN           = 78 
MAX           = 79 
RAND          = 80 
SAMPLE_LUM    = 81 
SAMPLE_COL    = 82 
PASSTHROUGH   = 83
class sbsenum.FunctionInputEnum

Bases: object

Enumeration of the input identifier of the function nodes (SBSParamNode)

A               = 0 
B               = 1 
COMPONENTS_IN   = 2 
COMPONENTS_LAST = 3 
CONDITION       = 4 
ELSE_PATH       = 5 
ENTRIES         = 6 
IF_PATH         = 7 
LOOP            = 8 
POS             = 9 
RHO             = 10 
SCALAR          = 11 
SEQUENCE_IN     = 12 
SEQUENCE_LAST   = 13 
THETA           = 14 
VALUE           = 15 
VECTOR          = 16 
X               = 17 
INPUT           = 18
class sbsenum.FxMapNodeEnum

Bases: object

Enumeration of the available FxMap nodes (ParamsGraphNode)

ITERATE     = 0 
QUADRANT    = 1 
SWITCH      = 2 
PASSTHROUGH = 3
class sbsenum.TextureFormatEnum

Bases: object

Enumeration of all the texture formats available in Substance Designer

DEFAULT_FORMAT = 0 
RGBA           = 1 
LUMINANCE      = 2 
RGBA16         = 3 
LUMINANCE16    = 4 
DXT1           = 5 
DXT2           = 6 
DXT3           = 7 
DXT4           = 8 
DXT5           = 9 
DXT1a          = 10 
ATI1           = 11 
ATI2           = 12 
RGB24          = 13 
RGBA16F        = 14 
LUMINANCE16F   = 15 
RGBA32F        = 16 
LUMINANCE32F   = 17
class sbsenum.MipmapEnum

Bases: object

Enumeration of the mipmap format available on an Output node

FULL_PYRAMID = 0 
NO_MIPMAP    = 1 
LEVELS_2     = 2 
LEVELS_3     = 3 
LEVELS_4     = 4 
LEVELS_5     = 5 
LEVELS_6     = 6 
LEVELS_7     = 7 
LEVELS_8     = 8 
LEVELS_9     = 9 
LEVELS_10    = 10 
LEVELS_11    = 11 
LEVELS_12    = 12 
LEVELS_13    = 13 
LEVELS_14    = 14 
LEVELS_15    = 15
class sbsenum.UsageEnum

Bases: object

Enumeration of the usages available on an Output node

DIFFUSE           = 0 
BASECOLOR         = 1 
OPACITY           = 2 
EMISSIVE          = 3 
AMBIENT           = 4 
AMBIENT_OCCLUSION = 5 
MASK              = 6 
NORMAL            = 7 
BUMP              = 8 
HEIGHT            = 9 
DISPLACEMENT      = 10 
SPECULAR          = 11 
SPECULAR_LEVEL    = 12 
SPECULAR_COLOR    = 13 
GLOSSINESS        = 14 
ROUGHNESS         = 15 
ANISOTROPY_LEVEL  = 16 
ANISOTROPY_ANGLE  = 17 
TRANSMISSIVE      = 18 
REFLECTION        = 19 
REFRACTION        = 20 
ENVIRONMENT       = 21 
IOR               = 22 
SCATTERING0       = 23 
SCATTERING1       = 24 
SCATTERING2       = 25 
SCATTERING3       = 26 
ANY               = 27 
METALLIC          = 28 
PANORAMA          = 29
class sbsenum.ComponentsEnum

Bases: object

Enumeration of the components associated to a usage on an Output node

RGBA = 0 
RGB  = 1 
R    = 2 
G    = 3 
B    = 4 
A    = 5
class sbsenum.ColorSpacesEnum

Bases: object

Enumeration of the color spaces associated to a usage on an Output node

SRGB             = 0 
LINEAR           = 1 
PASSTHRU         = 2 
SNORM            = 3 
NORMAL_XYZ_LEFT  = 4 
NORMAL_XYZ_RIGHT = 5
class sbsenum.UsageDataEnum

Bases: object

Enumeration of the data contained in a usage

COMPONENTS = 0 
COLOR_SPACE = 1
class sbsenum.ResourceTypeEnum

Bases: object

Enumeration of the kind of resources handled by the application

NONE            = 0 
FONT            = 1 
SVG             = 2 
BITMAP          = 3 
M_BSDF          = 4 
LIGHT_PROFILE   = 5 
SCENE           = 6 
OTHER = NONE
class sbsenum.ParamInheritanceEnum

Bases: object

Enumeration of the Inheritance parameter of filters

ABSOLUTE = 0 
PARENT   = 1 
INPUT    = 2
class sbsenum.TilingEnum

Bases: object

Enumeration of the kind of tiling

NO_TILING      = 0 
H_TILING       = 1 
V_TILING       = 2 
H_AND_V_TILING = 3
class sbsenum.OutputFormatEnum

Bases: object

Enumeration of the output format

FORMAT_8BITS        = 0 
FORMAT_16BITS       = 1 
FORMAT_16BITS_FLOAT = 2 
FORMAT_32BITS_FLOAT = 3
class sbsenum.OutputSizeEnum

Bases: object

Enumeration of the Output size option

SIZE_1    = 0 
SIZE_2    = 1 
SIZE_4    = 2 
SIZE_8    = 3 
SIZE_16   = 4 
SIZE_32   = 5 
SIZE_64   = 6 
SIZE_128  = 7 
SIZE_256  = 8 
SIZE_512  = 9 
SIZE_1024 = 10 
SIZE_2048 = 11 
SIZE_4096 = 12 
SIZE_8192 = 13
class sbsenum.PixelRatioEnum

Bases: object

Enumeration of the pixel ratio option

STRETCH= 0 
SQUARE = 1
class sbsenum.QualityEnum

Bases: object

Enumeration of the quality property

VERY_LOW  = 0 
LOW       = 1 
MEDIUM    = 2 
HIGH      = 3 
VERY_HIGH = 4
class sbsenum.ColorModeEnum

Bases: object

Enumeration of the color switch values

GRAYSCALE = 0 
COLOR     = 1
class sbsenum.BlendBlendingModeEnum

Bases: object

Enumeration of the blending mode for the Blend filter

COPY       = 0 
ADD        = 1 
SUBSTRACT  = 2 
MULTIPLY   = 3 
ADD_SUB    = 4 
MAX        = 5 
MIN        = 6 
SWITCH     = 7 
DIVIDE     = 8 
OVERLAY    = 9 
SCREEN     = 10 
SOFT_LIGHT = 11
class sbsenum.AlphaBlendingEnum

Bases: object

Enumeration of the alpha blending mode for the Blend filter

USE_SOURCE_ALPHA = 0 
IGNORE_ALPHA     = 1 
STRAIGHT_ALPHA   = 2 
PREMULTIPLIED    = 3
class sbsenum.ChannelShuffleEnum

Bases: object

Enumeration of the alpha blending mode for the Blend filter

INPUT1_RED   = 0 
INPUT1_GREEN = 1 
INPUT1_BLUE  = 2 
INPUT1_ALPHA = 3 
INPUT2_RED   = 4 
INPUT2_GREEN = 5 
INPUT2_BLUE  = 6 
INPUT2_ALPHA = 7
class sbsenum.CombineDistanceEnum

Bases: object

Enumeration of the ways to combine source / distance in the Distance filter

ONLY_SOURCE = 0 
COMBINE     = 1
class sbsenum.CurveTypeEnum

Bases: object

Enumeration of the kind of curve available in Substance Designer for the Curve filter

LUMINANCE = 0 
RED       = 1 
GREEN     = 2 
BLUE      = 3 
ALPHA     = 4
class sbsenum.GradientAddressingEnum

Bases: object

Enumeration of the gradient addressing for the Dynamic Gradient and Gradient Map filters

CLAMP  = 0 
REPEAT = 1
class sbsenum.GradientOrientationEnum

Bases: object

Enumeration of the gradient orientation for the Dynamic Gradient filter

HORIZONTAL = 0 
VERTICAL   = 1
class sbsenum.NormalFormatEnum

Bases: object

Enumeration of the normal format for the Normal filter

DIRECTX = 0 
OPENGL  = 1
class sbsenum.NormalAlphaChannelContentEnum

Bases: object

Enumeration of the alpha channel content for the Normal filter

FORCE_TO_ONE = 0 
INPUT_ALPHA  = 1
class sbsenum.MipMapModeEnum

Bases: object

Enumeration of the mipmap mode for the Transformation 2D filter

AUTOMATIC = 0 
MANUAL    = 1
class sbsenum.FilteringEnum

Bases: object

Enumeration of the filtering mode for the Transformation 2D filter

NEAREST   = 0 
BILINEAR  = 1
class sbsenum.TextAlignEnum

Bases: object

Enumeration of the text alignment enumeration for the Text filter

LEFT    = 0 
CENTER  = 1 
RIGHT   = 2
class sbsenum.FX_PatternType

Bases: object

Enumeration of the pattern available on the Quadrant node of an FxMap

NO_PATTERN            = 0 
INPUT_IMAGE           = 1 
SQUARE                = 2 
DISC                  = 3 
PARABOLOID            = 4 
BELL                  = 5 
GAUSSIAN              = 6 
THORN                 = 7 
PYRAMID               = 8 
BRICK                 = 9 
GRADATION             = 10 
WAVES                 = 11 
HALF_BELL             = 12 
RIDGED_BELL           = 13 
CRESCENT              = 14 
CAPSULE               = 15 
CONE                  = 16 
GRADATION_WITH_OFFSET = 17
class sbsenum.FX_BlendingModeEnum

Bases: object

Enumeration of the blending mode available on the Quadrant node of an FxMap

ADD_SUB     = 0 
MAX         = 1 
ALPHA_BLEND = 2
class sbsenum.FX_InputImageAlphaEnum

Bases: object

Enumeration of the alpha blending mode available on the Quadrant node of an FxMap

STRAIGHT      = 0 
PREMULTIPLIED = 1
class sbsenum.FX_InputImageFilteringEnum

Bases: object

Enumeration of the filtering mode available on the Quadrant node of an FxMap

BILINEAR_MIPMAP = 0 
BILINEAR        = 1 
NEAREST         = 2
class sbsenum.FX_SelectorEnum

Bases: object

Enumeration of the selector available on the Switch node of an FxMap

LEFT  = 0 
RIGHT = 1
class sbsenum.BitmapResizeMethodEnum

Bases: object

Enumeration of the bitmap resize methods

SMOOTH_STRETCH  = 0 
NEAREST_STRETCH = 1
class sbsenum.WidgetTypeEnum

Bases: object

Enumeration of the kind of widget available in Substance Designer for the parameter definition

BUTTON                = 0 
SLIDER                = 1 
DROP_DOWN_LIST        = 2 
SIZE_POW_2            = 3 
ANGLE                 = 4 
COLOR                 = 5 
TEXT                  = 6 
TRANSFORMATION_INVERSE= 7 
TRANSFORMATION_FORWARD= 8 
POSITION              = 9 
OFFSET                = 10
class sbsenum.WidgetOptionEnum

Bases: object

enumeration of all the options available among the different kind of widget

BOOL_EDITOR_TYPE     = 0 
CLAMP                = 1 
DEFAULT              = 2 
LABEL0               = 3 
LABEL1               = 4 
LABEL2               = 5 
LABEL3               = 6 
MAX                  = 7 
MIN                  = 8 
PARAMETERS           = 9 
STEP                 = 10 
VALUE_INTERPRETATION = 11
class sbsenum.WidgetEnum

Bases: object

Enumeration of the kind of widget available in Substance Designer for the parameter definition

BUTTON_BOOL            = 0 
SLIDER_INT1            = 1 
SLIDER_INT2            = 2 
SLIDER_INT3            = 3 
SLIDER_INT4            = 4 
SLIDER_FLOAT1          = 5 
SLIDER_FLOAT2          = 6 
SLIDER_FLOAT3          = 7 
SLIDER_FLOAT4          = 8 
DROPDOWN_INT1          = 9 
SIZE_POW2_INT2         = 10 
ANGLE_FLOAT1           = 11 
COLOR_FLOAT1           = 12 
COLOR_FLOAT3           = 13 
COLOR_FLOAT4           = 14 
MATRIX_INVERSE_FLOAT4  = 15 
MATRIX_FORWARD_FLOAT4  = 16 
TEXT_STRING            = 17 
POSITION_FLOAT2        = 18 
OFFSET_FLOAT2          = 19
class sbsenum.GUIObjectTypeEnum

Bases: object

Enumeration of the type of GUI Objects in a compositing graph or a function graph

class sbsenum.CompImplementationKindEnum

Bases: object

Enumeration of the kind of comp implementation available for a SBSCompImplementation

FILTER        = 0 
INSTANCE      = 1 
INPUT         = 2 
OUTPUT        = 3
class sbsenum.BatchToolsEnum

Bases: object

Enumeration of the different BatchTools

AXFTOOLS = 0 
BAKER    = 1 
COOKER   = 2 
MDLTOOLS = 3 
MUTATOR  = 4 
RENDER   = 5 
UPDATER  = 6 
SPOTCOLORINFO= 7 
SBSMTOOLS= 8
class sbsenum.GraphTemplateEnum

Bases: object

Enumeration of the Substance Graph templates available in Substance Designer

EMPTY                               = 0 
PBR_METALLIC_ROUGHNESS              = 1 
PBR_SPECULAR_GLOSSINESS             = 2 
STANDARD                            = 3 
SCAN_PBR_METALLIC_ROUGHNESS         = 4 
SCAN_PBR_SPECULAR_GLOSSINESS        = 5 
AXF_2_PBR_METALLIC_ROUGHNESS        = 6 
AXF_2_PBR_SPECULAR_GLOSSINESS       = 7 
STUDIO_PANORAMA                     = 8 
PAINTER_FILTER_GENERIC              = 9 
PAINTER_FILTER_SPECIFIC             = 10 
PAINTER_FILTER_SPECIFIC_MORE_MAPS   = 11 
PAINTER_GENERATOR_MORE_MAPS         = 12 
SAMPLER_FILTER                      = 13
class sbsenum.BaseTypeEnum

Bases: object

Enumeration of the base types used in autograph module

FLOAT = 0 
INT   = 1 
BOOL  = 2
class sbsenum.UVTileFormat

Bases: object

Enumeration of the different UV tiles format supported by the API

UDIM      = 0 # '1002' 
UxV       = 1 # '1x0' 
uU_vV     = 2 # 'u1_v0' 
UV_LIST   = 3 # [1,0] 
UV_TUPLE  = 4 # (1,0)
class sbsenum.GraphTypeEnum

Bases: object

Enumeration of the different graph type

UNSPECIFIED= 0 
MESH_BASED_GENERATOR= 1 
TEXTURE_GENERATOR= 2 
LIGHT= 3 
MATERIAL= 4 
FILTER= 5 
ATLAS_MATERIAL= 6 
DECAL_MATERIAL= 7 
LIGHT_TEXTURE= 8 
ENVIRONMENT_LIGHT= 9

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