1. Epic GamesDeveloper
  3. MetasoundGraphCore

MetasoundGraphCore

API > API/Plugins

   
Name MetasoundGraphCore
Type Runtime
Part of Plugins MetaSound
Location /Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/
Module Build Rules MetasoundGraphCore.Build.cs

Classes

Name Remarks
FAnyDataReference Container for any data reference.
FAudioBuffer FAudioBuffer
FBasicNode  
FBuildErrorBase FBuildErrorBase
FClassVertexInterface  
FDanglingVertexError FDanglingVertexError
FDataReferenceCollection  
FDataVertex FDataVertex
FDuplicateInputError FDuplicateInputError
FDynamicGraphIncrementalSorter FDynamicGraphIncrementalSorter implements a dynamic topological sorting algorithm which offers several optimizations over doing full sorts.
FDynamicOperatorTransactor The FDynamicOperatorTransactor is used for communicating with a dynamic MetaSound operator.
FEnvironmentDeclarationBuilder Interface builder for FEnvironmentInterface declarations.
FEnvironmentVertex FEnvironmentVertex
FEnvironmentVertexInterface Interface representing the environment variables used by a node.
FExecuter FExecuter
FGraph FGraph contains the edges between nodes as well as input and output vertices.
FGraphCycleError FGraphCycleError
FGraphLinter FGraphLinter
FGraphOperator  
FGraphRenderCost FGraphRenderCost represents the accumulated render cost of a graph.
FInputBinding An input binding which connects an FInputVertex to a IDataReference.
FInputDataVertex FInputDataVertex
FInputReceiverInitializationError FInputReceiverInitializationError
FInputVertexInterface Interface representing the inputs of a node.
FInputVertexInterfaceData An input vertex interface with optionally bound data references.
FInputVertexInterfaceDeclarationBuilder Interface builder for FInputVertexInterface declarations.
FInternalError FInternalError
FInvalidConnectionDataTypeError FInvalidConnectionDataTypeError
FMetasoundEnvironment FMetasoundEnvironment contains a set of TMetasoundEnvironmentVariables requiring that each environment variable has a unique name.
FMissingInputDataReferenceError FMissingInputDataReferenceError
FMissingOutputDataReferenceError FMissingOutputDataReferenceError
FMissingVertexError FMissingVertexError
FNode  
FNodeClassName Name of a node class.
FNodeFacade FNodeFacade implements a significant amount of boilerplate code required to build a MetasoundINode.
FNodePrunedError FNodePrunedError
FNodeRenderCost FNodeRenderCost allows individual nodes to report their render cost.
FNoOpOperator FNoOpOperator is for IOperators which do not perform any execution.
FOperatorBuilder FOperatorBuilder builds an IOperator from an IGraph.
FOperatorSettings FOperatorSettings
FOutputBinding Binds an IDataReference to a FOutputDataVertex.
FOutputDataVertex FOutputDataVertexVertex for outputs.
FOutputVertexInterface Interface representing the outputs of a node.
FOutputVertexInterfaceData An output vertex interface with optionally bound data references.
FOutputVertexInterfaceDeclarationBuilder Interface builder for FOutputVertexInterface declarations.
FPolyRegistry  
FSubInterfaceDeclarationBuilder Interface Declaration Builders create vertex interfaces from a template parameter pack.
FVertexInterface FVertexInterface provides access to a collection of input and output vertex interfaces.
FVertexInterfaceData A vertex interface with optionally bound data.
TDataReadReference Forward declare.
TDataReference Template class for a paramter reference.
TDataValueReference TDataValueReference represents a constant value and provides read only access.
TDataWriteReference Forward declare.
TExecutableOperator Convenience class for supporting the IOperator interface's GetExecuteFunction virtual member function.
TInputConstructorVertex Create a FInputDataVertex with a templated MetaSound data type which only reads data at operator time.
TInputDataVertex Create a FInputDataVertex with a templated MetaSound data type.
TIsFactoryMethodDeclared Helper template to determine whether a static class function is declared for a given template class.
TIsNodeInfoDeclared Helper template to determine whether a static class function is declared for a given template class.
TIsPostExecuteMethodDeclared Helper template to determine whether a member function is declared for a given template class.
TIsResetMethodDeclared Helper template to determine whether a member function is declared for a given template class.
TMetasoundEnvironmentVariable  
TNodeFacade TNodeFacade further reduces boilerplate code by allowing shorthand node implementations.
TOperatorData Node configuration CRTP.
TOutputConstructorVertex Create a FOutputDataVertex with a templated MetaSound data type which is only sets data at operator construction time.
TOutputDataVertex Create a FOutputDataVertex with a templated MetaSound data type.
TVariableAccessorOperator Operator for providing inline access to a variable
TVariableDeferredAccessorOperator Operator for providing delayed access to a variable
TVariableMutatorOperator Operator for providing setting a variable
TVariableNode Variable nodes initialize variable values.
TVariableOperator  
TVertexInterfaceGroupData  
TVertexInterfaceImpl TVertexInterfaceImpls encapsulates multiple related data vertices.

Structs

Name Remarks
FAssetMetaData  
FBeginSubInterface Declare the beginning of a sub interface in a vertex interface declaration.
FBuildDynamicGraphOperatorParams Parameters for building a dynamic graph operator consist of the parameters needed to build a standard graph operator as well as a transform queue and set of callbacks in order to communicate and react to changes in the dynamic operator.
FBuildGraphOperatorParams Parameters for building an operator from a graph.
FBuildGraphParams Parameters for building an operator from a graph.
FBuildOperatorParams FBuildOperatorParams holds the parameters provided to operator factories during the creation of an IOperator
FBuildResults Structure of all resulting data generated during graph operator build.
FConstructWithLiteral This tag resolves issues around the behavior of the TLiteralTraits<>::bIsParsable.
FDataEdge FDataEdge
FDataVertexMetadata Vertex metadata.
FDirectedGraphAlgo  
FDynamicOperatorUpdateCallbacks A collection of callbacks for handling updates to MetaSound dynamic operators.
FEndSubInterface  
FInputDataDestination FInputDataSource describes the destination of data which produced external to the graph and read internal to the graph.
FLiteral FLiteral represents a constant value in a Metasound graph and is primarily used to invoke the correct constructor of a Metasound data type.
FNodeClassMetadata Provides metadata for a given node.
FNodeData Data used to construct a Node.
FNodeDisplayStyle Node style data
FNodeInitData This struct is used to pass in any arguments required for constructing a single node instance.
FOperatorAndInputs Todo: better place to put this? needs to be in core
FOperatorBuilderSettings FOperatorBuilderSettings
FOrdinalSwap FOrdinalSwap represents a change in ordinal for an individual operator.
FOutputDataSource FOutputDataSource describes the source of data which is produced within a graph and exposed external to the graph.
FPolyTypeInfo  
FScopeDebugActiveNode  
FStronglyConnectedComponent A strongly connected component containing Metasound INodes and FDataEdges.
FSubInterfaceConfiguration  
FSubInterfaceDescription  
FSubInterfaceLayout Contains a list of sub-interface spans where the span indices refer to vertex indices of an array containing vertices.
FVertexDataState FVertexDataState encapsulates which data reference a vertex is associated with.
TAnyConstructorForwarding Denotes that parameter pack arguments and/or FOperatorSettings is optional when constructing the Metasound Data Type.
TCreateInputBinding Functor for creating a new FInputBinding from a IDataReference derived class and a vertex name.
TCreateOutputBinding Functor for creating a new FOutputBinding from a IDataReference derived class and a vertex name.
TDataFactory A base factory type for creating objects related to Metasound DataTypes.
TDataFactoryInternal Core factory type for creating objects related to metasound data types.
TDataLiteralFactory A base factory type for creating objects related to Metasound DataTypes.
TDataReadReferenceFactory TDataReadReferenceFactory creates TDataReadReferences for the given DataType.
TDataReadReferenceLiteralFactory TDataReadReferenceLiteralFactory creates TDataReadReferences for the given DataType.
TDataReferenceTypeInfo  
TDataTypeConstructorTraits Description of available constructors for a registered Metasound Data Type.
TDataTypeCreator Create a DataType. For use in TDataFactory.
TDataTypeFactory TDataTypeFactory creates a DataType.
TDataTypeLiteralFactory TDataTypeLiteralFactory creates a DataType.
TDataTypeVariantConstructorTraits Constructor traits for a for variant inputs.
TDataTypeVariantFallbackHelper Helper for determine whether constructor accepts the variant type.
TDataTypeVariantParsing TDataTypeVariantParsing informs the TDataVariantFactoryInternal on which factory method to instantiate.
TDataValueReferenceFactory TDataValueReferenceFactory creates TDataValueReferences for the given DataType.
TDataValueReferenceLiteralFactory TDataValueReferenceLiteralFactory creates TDataValueReferences for the given DataType.
TDataVariantFactoryInternal Core factory type for creating objects related to Metasound DataTypes.
TDataWriteReferenceFactory TDataWriteReferenceFactory creates TDataWriteReferences for the given DataType.
TDataWriteReferenceLiteralFactory TDataWriteReferenceLiteralFactory creates TDataWriteReferences for the given DataType.
TDynamicDataReferencePolicy  
TElementType TElementType determines the element type of a container.
TEnvironmentVariableTypeInfo Struct TEnvironmentVariableTypeInfo
TEqualVertexName Functor for finding vertices with equal names
TExecutableDataType As a general rule, ExecutableDataTypes should be avoided whenever possible as they incur an undesired cost and are generally not typically necessary.
TExplicitArgsConstructorForwarding Denotes that parameter pack arguments must be used in the constructor of the Metasound Data Type.
TExplicitConstructorForwarding Denotes that both FOperatorSettings and parameter pack arguments must be used in the constructor of the Metasound Data Type.
TFacadeOperatorClass TFacadeOperatorClass encapsulates an operator type and checks that the required static functions exist to build the facade operator class.
TFactoryFacade TFactoryFacace is a factory for data types which uses the class template type to determine which flavor of DataReference to create.
TGetReferenceDataTypeT TGetReferencDataTypeT is a template trait which determines the underlying type stored in a data reference
TGetVertexAccess Helper for getting a EVertexAccessType from a TData*Reference object.
THasOperatorDataTypeNameMember Helper template for determining whether a static OperatorDataTypeName exists on the node configuration class declaration.
TIsArrayType Determines whether a DataType is an array type.
TIsParsable Determines whether a DataType supports a constructor which accepts and FOperatorSettings with ArgTypes and/or just ArgTypes.
TIsVariable Template to determine if data type is a variable.
TLiteralDefaultValueFromDecayed  
TLiteralTraits Determines whether a DataType supports construction using the given literal.
TLiteralTypeInfo Provides literal type information for a given type.
TNumOfTypeInPack Constexpr count of the number of a instances of type T in a parameter pack
TPolymorphicTraits  
TPolyRegistrar  
TPostExecutableDataType  
TPostExecuteFunctionAdapter Helper to determine whether an PostExecute(...) function exists.
TResetFunctionAdapter Helper to determine whether an Reset(...) function exists.
TSpecializationHelper Helper class to ensure that DECLARE_METASOUND_ENVIRONMENT_VARIABLE is used.
TTriggerDeprecatedBindAPIWarning  
TTypePromoter Promote which type to use for fallback.
TVariable A MetaSound Variable contains a data reference's prior and current value.

Interfaces

Name Remarks
IAudioDataType This empty base class is used so that we can specialize various nodes (Send, Receive, etc.) for subclasses of IAudioDatatype.
IDataReference A Data Reference Interface.
IGraph Interface for graph of nodes.
IMetasoundEnvironmentVariable Interface for a metasound environment variable which supports a name, a runtime type ID, and a clone method.
IMetasoundGraphCoreModule  
INode INodeInterface for all nodes that can create operators.
INodeBase INodeBase
IOperator IOperator
IOperatorBuilder IOperatorBuilder
IOperatorBuildError IOperatorBuildError
IOperatorData Base class for node configurations.
IOperatorFactory IOperatorFactory

Typedefs

Name Type Remarks Include Path
FAudioBufferReadRef ::Metasound::TDataReadReference< FAudioBuffer >   MetasoundAudioBuffer.h
FAudioBufferTypeInfo ::Metasound::TDataReferenceTypeInfo< FAudioBuffer >   MetasoundAudioBuffer.h
FAudioBufferWriteRef ::Metasound::TDataWriteReference< FAudioBuffer >   MetasoundAudioBuffer.h
FBuildErrorArray TArray< TUniquePtr< IOperatorBuildError > > Array of build errors. MetasoundBuilderInterface.h
FDataReferenceID const void * Unique ID type which corresponds to the underlying object referred to by a data reference. MetasoundDataReference.h
FInputDataDestinationCollection TMap< FNodeDataVertexKey, FInputDataDestination > FInputDataDestinationCollection contains multiple FInputDataDestinations mapped by FNodeDataVertexKeys. MetasoundNodeInterface.h
FMetasoundDataTypeId void const *const   MetasoundDataReference.h
FMetasoundEnvironmentVariableTypeId void const *const   MetasoundEnvironment.h
FNodeDataVertexKey TTuple< const INode *, FVertexName > Key type for an FOutputDataSource or FInputDataDestination. MetasoundNodeInterface.h
FOnInputVertexUpdated TFunction< void(const FVertexName &, const FInputVertexInterfaceData &)>   MetasoundDynamicOperatorTransactor.h
FOnOutputVertexUpdated TFunction< void(const FVertexName &, const FOutputVertexInterfaceData &)>   MetasoundDynamicOperatorTransactor.h
FOperatorFactorySharedRef TSharedRef< IOperatorFactory, ESPMode::ThreadSafe > Shared ref type of operator factory. MetasoundNodeInterface.h
FOutputDataSourceCollection TMap< FNodeDataVertexKey, FOutputDataSource > FOutputDataSourceCollection contains multiple FOutputDataSources mapped by FNodeDataVertexKeys. MetasoundNodeInterface.h
FReferenceCreationFunction TOptional< FAnyDataReference >(*)(const FOperatorSettings &InSettings, FName DataType, const FLiteral &InLiteral, EDataReferenceAccessType InAccessType)   MetasoundDynamicOperatorTransactor.h
FSampleRate int32   MetasoundOperatorSettings.h
FVertexName FName Name of a given vertex. Only unique for a given node interface. MetasoundVertex.h
ProxyDataPtrType_DEPRECATED TUniquePtr< Audio::IProxyData > Deprecated in 5.2. Use TSharedPtr instead of TUniquePtr. MetasoundDataFactory.h
TGetReferenceDataType typename TGetReferenceDataTypeT< T >::Type TGetReferencDataType is the underlying type stored in a data reference MetasoundVertexData.h
TSortedVertexNameMap TSortedMap< FVertexName, ValueType, FDefaultAllocator, FNameFastLess > Convenience for using a TSortedMap with FVertexName Key type. MetasoundVertexData.h
TVariableAccessorNode TNodeFacade< MetasoundVariableNodesPrivate::TVariableAccessorOperator< DataType > > FGetVariable node provides delay free, cpu free access to a set variable. MetasoundVariableNodes.h
TVariableDeferredAccessorNode TNodeFacade< MetasoundVariableNodesPrivate::TVariableDeferredAccessorOperator< DataType > > TVariableDeferredAccessorNode provides access to the prior executions variable value. MetasoundVariableNodes.h
TVariableMutatorNode TNodeFacade< MetasoundVariableNodesPrivate::TVariableMutatorOperator< DataType > > TVariableMutatorNode allows variable values to be set. MetasoundVariableNodes.h

Enums

Public

Name Remarks
Metasound::EDataReferenceAccessType EDataReferenceAccessType describes the underlying data reference access type for a data reference contained in a FAnyDataReference.
Metasound::EDataRefShouldConstruct This enum is used as a token to explicitly delineate when we should create a new object for the reference, or use a different constructor.
Metasound::ELiteralType ELiteralType describes the format of the values held in the literal.
Metasound::ENodeClassAccessFlags Copyright Epic Games, Inc. All Rights Reserved.
Metasound::EOperatorBuilderNodePruning EOperatorBuildNodePruning expresses the desired pruning behavior during the node pruning step.
Metasound::EVertexAccessType Describe how the vertex will access connected data.

Constants

Name Type Remarks Include Path
Metasound::VariableNames::InputDataDisplayName const FText   MetasoundVariableNodes.h
Metasound::VariableNames::InputDataMetadata const FDataVertexMetadata   MetasoundVariableNodes.h
Metasound::VariableNames::InputDataName const FLazyName   MetasoundVariableNodes.h
Metasound::VariableNames::InputDataTooltip const FText   MetasoundVariableNodes.h
Metasound::VariableNames::InputVariableDisplayName const FText   MetasoundVariableNodes.h
Metasound::VariableNames::InputVariableMetadata const FDataVertexMetadata   MetasoundVariableNodes.h
Metasound::VariableNames::InputVariableName const FLazyName   MetasoundVariableNodes.h
Metasound::VariableNames::InputVariableTooltip const FText   MetasoundVariableNodes.h
Metasound::VariableNames::OutputDataDisplayName const FText   MetasoundVariableNodes.h
Metasound::VariableNames::OutputDataMetadata const FDataVertexMetadata   MetasoundVariableNodes.h
Metasound::VariableNames::OutputDataName const FLazyName   MetasoundVariableNodes.h
Metasound::VariableNames::OutputDataTooltip const FText   MetasoundVariableNodes.h
Metasound::VariableNames::OutputVariableDisplayName const FText   MetasoundVariableNodes.h
Metasound::VariableNames::OutputVariableMetadata const FDataVertexMetadata   MetasoundVariableNodes.h
Metasound::VariableNames::OutputVariableName const FLazyName   MetasoundVariableNodes.h
Metasound::VariableNames::OutputVariableTooltip const FText   MetasoundVariableNodes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ORDINAL_NONE int32   MetasoundDynamicOperatorTransactor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Convert a EDataReferenceAccessType to FString. MetasoundDataReference.h  

FString LexToString ( const Metasound::FLiteral& InLiteral
)

   MetasoundLiteral.h  
Convert EVertexAccessType to string MetasoundVertex.h  

void Metasound::AddBuildError ( FBuildErrorArray& OutErrors,
ArgTypes&&... Args
)

 Convenience template for adding build errors. MetasoundBuilderInterface.h  
Casts an environment variable to the derived type. MetasoundEnvironment.h  
Casts an environment variable to the derived type. MetasoundEnvironment.h  

std::enable_if_t< std::conjunction_v< std::is_base_of< TOperatorData< std::decay_t< DesiredOperatorDataType > >, DesiredOperatorDataType >, std::is_base_of< IOperatorData, ProvidedOperatorDataType > >, DesiredOperatorDataType * > Metasound::CastOperatorData ( ProvidedOperatorDataType* InOperatorData
)

 Returns a non-null pointer to a downcast node configuration object if the provided node configuration is non-null and of the same derived type. MetasoundOperatorData.h  

FDataReferenceID Metasound::GetDataReferenceID ( const IDataReference& InDataReference
)

 Return the ID of the data reference. MetasoundDataReference.h  

const FText & Metasound::GetMetasoundDataTypeDisplayText()

 Return the display text for a registered data type. MetasoundDataTypeGetTraits.h  

const void *const Metasound::GetMetasoundDataTypeId ()

 Return the data type ID for a registered data type. MetasoundDataTypeGetTraits.h  

const FName & Metasound::GetMetasoundDataTypeName()

 Return the data type FName for a registered data type. MetasoundDataTypeGetTraits.h  

const FString & Metasound::GetMetasoundDataTypeString()

 Return the data type string for a registered data type. MetasoundDataTypeGetTraits.h  

FMetasoundEnvironmentVariableTypeId Metasound::GetMetasoundEnvironmentVariableTypeId()

 Return the type ID for a environment variable type. MetasoundEnvironment.h  

FName Metasound::GetStaticOperatorDataTypeName()

 Returns the type name of the node configuration object. MetasoundOperatorData.h  

bool Metasound::IsChildOf ( const FName InBaseType
)

   MetasoundDataReference.h  

bool Metasound::IsDataReferenceOfType ( const IDataReference& InReference
)

 Polymorphic overload. MetasoundDataReference.h  

bool Metasound::IsDataReferenceOfType ( const IDataReference& InReference
)

 Non-polymorphic fallback. MetasoundDataReference.h  

bool Metasound::IsEnvironmentVariableOfType ( const IMetasoundEnvironmentVariable& InVar
)

 Returns true if the environment variable contains the same type as the `VarType_ MetasoundEnvironment.h  

bool Metasound::IsOperatorDataOfType ( const IOperatorData& InNodeConfig
)

 Returns true if the provided node configuration is of the type T. MetasoundOperatorData.h  

FNodeDataVertexKey Metasound::MakeDestinationDataVertexKey ( const FInputDataDestination& InDestination
)

   MetasoundNodeInterface.h  

TSharedRef< FactoryType, ESPMode::ThreadSafe > Metasound::MakeOperatorFactoryRef ( ArgTypes&&... Args
)

 Convenience function for making operator factory references MetasoundNodeInterface.h  

FNodeDataVertexKey Metasound::MakeSourceDataVertexKey ( const FOutputDataSource& InSource
)

 Make a FNodeDataVertexKey from an FOutputDataSource. MetasoundNodeInterface.h  

TSharedRef< Base, ESPMode::NotThreadSafe > Metasound::MetasoundDataReferencePrivate::MakeRefOf ( ArgTypes&&... args
)

   MetasoundDataReference.h  
Default template for converting a template parameter to a literal argument type. MetasoundLiteral.h  
  MetasoundLiteral.h  
Cast a TDataReadReference to a TDataValueReference. MetasoundDataReference.h  
Cast a TDataWriteReference to a TDataValueReference. MetasoundDataReference.h  

const FNodeClassName & Metasound::VariableNames::GetVariableAccessorNodeClassName()

 Class name for variable accessor node MetasoundVariableNodes.h  

const FNodeClassName & Metasound::VariableNames::GetVariableDeferredAccessorNodeClassName()

 Class name for variable deferred accessor node. MetasoundVariableNodes.h  

const FNodeClassName & Metasound::VariableNames::GetVariableMutatorNodeClassName()

 Class name for variable mutator node. MetasoundVariableNodes.h  

const FNodeClassName & Metasound::VariableNames::GetVariableNodeClassName()

 Class name for variable node. MetasoundVariableNodes.h  

TDataWriteReference< DataType > Metasound::WriteCast ( const TDataReadReference< DataType >& InReadableRef
)

 Cast a TDataReadReference to a TDataWriteReference. MetasoundDataReference.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page