- Substance 3D home
- Ecosystems and Plugins
- Home
- Game Engines
- Unreal Engine
- Unreal Engine 5
- Unreal Engine 5 overview
- Unreal Engine 5 Release Notes
- Plugin Overview - UE5
- Plugin Settings - UE5
- Substance Input Image - UE5
- Material Instance Definition - UE5
- Material Template Usage - UE5
- Out-of-the-Box Material Templates
- Tiling Substance - UE5
- Substance 3D Plugin Default Templates
- Substance 3D Assets Library Usage - UE5
- Blueprints - UE5
- Unreal Engine 5 Scripting
- Installing to Source Builds
- Unreal Engine 5 overview
- Unreal Engine 4
- Unreal Engine 4 overview
- Unreal Engine 4 plugin release notes
- Unreal plugin 4.27.0.1
- Unreal plugin 4.26.0.21
- Unreal plugin 4.26.0.2
- Unreal plugin 4.26.0.1
- Unreal plugin 4.25.0.5
- Unreal plugin 4.25.0.4
- Unreal plugin 4.25.0.3
- Unreal plugin 4.24.0.3
- Unreal plugin 4.23.0.2
- Unreal plugin 4.23.0.1
- Unreal plugin 4.22.0.33
- Unreal plugin 4.22.0.32
- Unreal plugin 4.21.0.31
- Plugin Overview - UE4
- Plugin Settings - UE4
- Substance Input Image - UE4
- Material Instance Definition - UE4
- Tiling Substance - UE4
- Working with Bump Offset (Parallax) - UE4
- Working with Displacement - UE4
- Source in UE4
- Live Link in UE4
- Blueprints - UE4
- Unreal Engine 4 Scripting
- Unreal Engine 4 overview
- Unreal Engine 5
- Unity
- Unity overview
- Unity Release Notes
- Downloading Substance 3D Plugin in Unity
- Unity Plugin Overview
- Unity Preferences
- Optimization Guidelines
- Upgrading Projects/Known Issues
- Managing Substance Graphs
- Changing parameters
- Generated Textures (Packing)
- Rendering Color Space
- Using Image Inputs
- Publishing for Mobile
- Substance 3D for Unity Scripting
- Scripting in Unity (Deprecated)
- API Overview
- Scripting API
- C# Example Script
- Substance 3D Assets Library Usage
- Removing Substance Plugin
- Substance 3D in Unity Tutorials
- Physical Size in Unity
- Sharing sbsar Files Between Projects
- Unity overview
- Lumberyard
- Roblox
- Unreal Engine
- 3D Applications
- Maya
- 3ds Max
- MODO
- MODO overview
- Modo Plugin Release Notes
- Substance in MODO Overview
- Modo Installation
- Parameters
- Custom Materials
- Working with Normals
- Working with Emissive
- Bump and Displacement
- Working with References
- Animating Substances
- Copy/Duplicate Substance
- Environment and Rendering Setup
- Modo Switch Engine
- Tiling Modo textures
- MODO overview
- Cinema 4D
- Houdini
- Blender
- Blender overview
- Release Notes
- Substance in Blender Overview
- Downloading and Installing the Plugin
- Preferences
- The Substance 3D Panel
- Shortcuts and Navigation
- Workflows
- Physical size in Blender
- Substance 3D Assets Library
- Troubleshooting
- Uninstalling the Add-on
- Substance 3D Add-on for Blender Tutorials
- Blender overview
- Creative Cloud Applications
- Renderers
- Partnerships
Member Function Documentation
AttachGraph()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.AttachGraph ( SubstanceGraphSO graph ) [inline]
Attaches a new graph object to this runtime handler.
Parameters
graph | Target substance graph. |
CreatePresetFromCurrentState()
string Adobe.Substance.Runtime.SubstanceRuntimeGraph.CreatePresetFromCurrentState ( ) [inline]
Saves the current graph state into a preset XML.
Returns
Preset created using the current state of the graph inputs.
GetGeneratedTextures()
List< Texture2D > Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetGeneratedTextures ( ) [inline]
Returns a list with all output textures for the substance instance.
Returns
Output texture.
GetInputBool()
bool Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputBool ( string inputName ) [inline]
Get Substance Boolean Input.
Parameters
inputName | Name of the input in the SBSAR. |
Returns
Current input value.
GetInputColor()
Color Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputColor ( string inputName ) [inline]
Get Substance Color
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputDescription()
SubstanceInputDescription Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputDescription ( string inputName ) [inline]
Returns the complete input description for the target input name.
Parameters
inputName | Target input name. |
Returns
Complete input description for the target input.
GetInputFloat()
float Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputFloat ( string inputName ) [inline]
Get Substance Float Input
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputInt()
int Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputInt ( string inputName ) [inline]
Get Substance Int Input
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputString()
string Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputString ( string inputName ) [inline]
Get Substance string input.
Parameters
inputName | Name of the input in the SBSAR |
Returns
Input current value.
GetInputVector2()
Vector2 Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector2 ( string inputName ) [inline]
Get Substance Vector2 Input
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputVector2Int()
Vector2Int Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector2Int ( string inputName ) [inline]
Get array of 2 int.
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputVector3()
Vector3 Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector3 ( string inputName ) [inline]
Get Substance Vector3 Input.
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputVector3Int()
Vector3Int Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector3Int ( string inputName ) [inline]
Get array of 3 int (Vector3Int’s x, y & z values)
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputVector4()
Vector4 Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector4 ( string inputName ) [inline]
Get Substance Vector4 Input
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetInputVector4Int()
int[] Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetInputVector4Int ( string inputName ) [inline]
Get array of 4 int (Vector4Int’s x, y, z & w values)
Parameters
inputName | Name of the input in the SBSAR |
Returns
Current input value.
GetOutputTexture()
Texture2D Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetOutputTexture ( string outputName ) [inline]
Returns the output texture for a given output name.
Parameters
outputName | Output name. |
Returns
Output texture.
GetTexturesResolution()
Vector2Int Adobe.Substance.Runtime.SubstanceRuntimeGraph.GetTexturesResolution ( ) [inline]
Returns instance texture output resolution.
Returns
Current output resolution.
HasInput()
bool Adobe.Substance.Runtime.SubstanceRuntimeGraph.HasInput ( string inputName ) [inline]
Returns true if this substance instance has an input with a given name.
Parameters
inputName | Input name. |
Returns
TRUE if the substance instance has input with the given name.
LoadPreset()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.LoadPreset ( string presetXML ) [inline]
Uses a preset XML to set graph input parameters.
Parameters
presetXML | Preset XML data. |
RenderAsync()
Task Adobe.Substance.Runtime.SubstanceRuntimeGraph.RenderAsync ( ) [inline]
Renders the substance instance asynchronously.
Returns
Task that will finish once render is done.
SetInputBool()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputBool ( string inputName, bool value ) [inline]
Update Substance Boolean Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputColor()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputColor ( string inputName, Color value ) [inline]
Update Substance Color Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputFloat()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputFloat ( string inputName, float value ) [inline]
Update Substance Float Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputInt()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputInt ( string inputName, int value ) [inline]
Update Substance Int Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputString()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputString ( string inputName, string value ) [inline]
Update Substance string Input.
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputTexture()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputTexture (string inputName, Texture2D value ) [inline]
Update Substance Texture2D Input.
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector2()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector2 ( string inputName, Vector2 value ) [inline]
Update Substance Vector2 Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector2Int()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector2Int ( string inputName, Vector2Int value ) [inline]
Update Substance Vector2Int Input.
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector3()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector3 ( string inputName, Vector3 value ) [inline]
Update Substance Vector3 Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector3Int()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector3Int ( string inputName, Vector3Int value ) [inline]
Update Substance Vector3Int Input.
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector4()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector4 ( string inputName, Vector4 value ) [inline]
Update Substance Vector4 Input
Parameters
inputName | Name of the input in the SBSAR |
value | Value used to update parameter |
SetInputVector4Int()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetInputVector4Int ( string inputName, int x, int y, int z, int w ) [inline]
Update Substance Vector4Int Input
Parameters
inputName | Name of the input in the SBSAR |
x | Value used to update the parameter |
y | Value used to update the parameter |
z | Value used to update the parameter |
w | Value used to update the parameter |
SetTexturesResolution()
void Adobe.Substance.Runtime.SubstanceRuntimeGraph.SetTexturesResolution ( Vector2Int size ) [inline]
Sets instance texture output resolution.
Parameters
size |