1. Epic GamesDeveloper
  3. UInterchangeShaderPortsAPI

UInterchangeShaderPortsAPI

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

API > API/Plugins > API/Plugins/InterchangeNodes

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.

   
Name UInterchangeShaderPortsAPI
Type class
Header File /Engine/Plugins/Interchange/Runtime/Source/Nodes/Public/InterchangeShaderGraphNode.h
Include Path #include "InterchangeShaderGraphNode.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UInterchangeShaderPortsAPI : public UObject

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
InputPrefix const TCHAR *   InterchangeShaderGraphNode.h
InputSeparator const TCHAR *   InterchangeShaderGraphNode.h
OutputByIndex const TCHAR *   InterchangeShaderGraphNode.h
ParameterSuffix const TCHAR *   InterchangeShaderGraphNode.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

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

 Adds an input connection attribute. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

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

   InterchangeShaderGraphNode.h  

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

 Adds an input connection attribute. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

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

 Adds an input connection attribute. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

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

 Retrieves the names of all the inputs for a given node. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static 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. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

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. InterchangeShaderGraphNode.h  

static int32 GetOutputIndexFromName ( const FString& OutputName
)

 Returns INDEX_NONE if OutputName is not an index. InterchangeShaderGraphNode.h  

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

 Checks whether a particular input exists on a given node. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

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

 Checks whether a particular input exists as a parameter on a given node. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static bool IsAnInput ( const FString& AttributeKey
)

 Returns true if the attribute key is associated with an input (starts with "Inputs:"). InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static bool IsAParameter ( const FString& AttributeKey
)

 Returns true if the attribute key is an input that represents parameters (ends with ":Parameter"). InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static FString MakeInputConnectionKey ( const FString& InputName
)

 Makes an attribute key to represent a node being connected to an input (that is, Inputs:InputName:Connect). InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static FString MakeInputName ( const FString& InputKey
)

 From an attribute key associated with an input (that is, Inputs:InputName:Value), retrieves the input name. InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static FString MakeInputParameterKey ( const FString& InputName
)

 Makes an attribute key to represent a parameter being given to an input (that is, Inputs:InputName:Parameter). InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

static FString MakeInputValueKey ( const FString& InputName
)

 Makes an attribute key to represent a value being given to an input (that is, Inputs:InputName:Value). InterchangeShaderGraphNode.h
  • BlueprintCallable
  • Category="Interchange | Node | Material"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page