1. Epic GamesDeveloper
  3. UInterchangeShaderPortsAPI

UInterchangeShaderPortsAPI

The Shader Ports API manages a set of inputs and outputs attributes.

API > API/Plugins > API/Plugins/InterchangeNodes

Inheritance Hierarchy

References

   
Module InterchangeNodes
Header /Engine/Plugins/Interchange/Runtime/Source/Nodes/Public/InterchangeShaderGraphNode.h
Include #include "InterchangeShaderGraphNode.h"

Syntax

UCLASS (BlueprintType)  
class UInterchangeShaderPortsAPI : public UObject

Remarks

The Shader Ports API manages a set of inputs and outputs attributes. This API can be used over any InterchangeBaseNode that wants to support shader ports as attributes.

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category bool

ConnectDefaultOuputToInput ( UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
const FString& ExpressionUid
)

 Adds an input connection attribute.
Public function Static bool

ConnectOuputToInput ( UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
const FString& ExpressionUid,
const FString& OutputName
)

  
Public function Static UFunction BlueprintCallable, Category bool

ConnectOuputToInputByIndex ( UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
const FString& ExpressionUid,
int32 OutputIndex
)

 Adds an input connection attribute.
Public function Static UFunction BlueprintCallable, Category bool

ConnectOuputToInputByName ( UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
const FString& ExpressionUid,
const FString& OutputName
)

 Adds an input connection attribute.
Public function Static UFunction BlueprintCallable, Category void

GatherInputs ( const UInterchangeBaseNode* InterchangeNode,
TArray< FString >& OutInputNames
)

 Retrieves the names of all the inputs for a given node.
Public function Static UFunction BlueprintCallable, Category bool

GetInputConnection ( const UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
FString& OutExpressionUid,
FString& OutputName
)

 Retrieves the node unique id and the output name connected to a given input, if any.
Public function Static UE::Interchange::EAttributeTypes

GetInputType ( const UInterchangeBaseNode* InterchangeNode,
const FString& InputName,
bool bIsAParameter
)

 For an input with a value, returns the type of the stored value.
Public function Static int32

GetOutputIndexFromName ( const FString& OutputName
)

 Returns INDEX_NONE if OutputName is not an index.
Public function Static UFunction BlueprintCallable, Category bool

HasInput ( const UInterchangeBaseNode* InterchangeNode,
const FName& InInputName
)

 Checks whether a particular input exists on a given node.
Public function Static UFunction BlueprintCallable, Category bool

HasParameter ( const UInterchangeBaseNode* InterchangeNode,
const FName& InInputName
)

 Checks whether a particular input exists as a parameter on a given node.
Public function Static UFunction BlueprintCallable, Category bool

IsAnInput ( const FString& AttributeKey
)

 Returns true if the attribute key is associated with an input (starts with "Inputs:").
Public function Static UFunction BlueprintCallable, Category bool

IsAParameter ( const FString& AttributeKey
)

 Returns true if the attribute key is an input that represents parameters (ends with ":Parameter").
Public function Static UFunction BlueprintCallable, Category FString

MakeInputConnectionKey ( const FString& InputName
)

 Makes an attribute key to represent a node being connected to an input (that is, Inputs:InputName:Connect).
Public function Static UFunction BlueprintCallable, Category FString

MakeInputName ( const FString& InputKey
)

 From an attribute key associated with an input (that is, Inputs:InputName:Value), retrieves the input name.
Public function Static UFunction BlueprintCallable, Category FString

MakeInputParameterKey ( const FString& InputName
)

 Makes an attribute key to represent a parameter being given to an input (that is, Inputs:InputName:Parameter).
Public function Static UFunction BlueprintCallable, Category FString

MakeInputValueKey ( const FString& InputName
)

 Makes an attribute key to represent a value being given to an input (that is, Inputs:InputName:Value).

Constants

Name Description
InputPrefix  
InputSeparator  
OutputByIndex  
ParameterSuffix  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page