MetasoundGraphCore

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public class

FBuildErrorBase

FBuildErrorBase

Public struct

FBuildGraphParams

Public struct

FCreateOperatorParams

FCreateOperatorParams holds the parameters provided to operator factories during the creation of an IOperator

Public class

FDanglingVertexError

FDanglingVertexError

Public struct

FDataEdge

FDataEdge

Public class

FDataReferenceCollection

Public struct

FDataVertexMetadata

Vertex metadata.

Public struct

FDataVertexModel

FDataVertexModel

Public struct

FDirectedGraphAlgo

Public class

FDuplicateInputError

FDuplicateInputError

Public class

FEnvironmentVertex

FEnvironmentVertex represents an input vertex to an interface.

Public struct

FEnvironmentVertexModel

FEnvironmentVertexModel

Public class

FExecuter

FExecuter

Public class

FGraph

FGraph contains the edges between nodes as well as input and output vertices.

Public class

FGraphCycleError

FGraphCycleError

Public class

FGraphLinter

FGraphLinter

Public class

FGraphOperator

Public struct

FInputDataDestination

FInputDataSource describes the destination of data which produced external to the graph and read internal to the graph.

Public class

FInputDataVertex

FInputDataVertex represents an input vertex to an interface.

Public struct

FInputDataVertexModel

FInputDataVertexModel

Public class

FInternalError

FInternalError

Public class

FInvalidConnectionDataTypeError

FInvalidConnectionDataTypeError

Public struct

FLiteral

FLiteral represents a constant value in a Metasound graph and is primarily used to invoke the correct constructor of a Metasound data type.

Public class

FMetasoundEnvironment

FMetasoundEnvironment contains a set of TMetasoundEnvironmentVariables requiring that each environment variable has a unique name.

Public class

FMissingInputDataReferenceError

FMissingInputDataReferenceError

Public class

FMissingOutputDataReferenceError

FMissingOutputDataReferenceError

Public class

FMissingVertexError

FMissingVertexError

Public class

FNode

Public struct

FNodeClassMetadata

Provides metadata for a given node.

Public class

FNodeClassName

Name of a node class.

Public struct

FNodeDisplayStyle

Node style data

Public class

FNodeFacade

FNodeFacade implements a significant amount of boilerplate code required to build a MetasoundINode.

Public class

FNodeFactoryRegister

Public struct

FNodeInitData

This struct is used to pass in any arguments required for constructing a single node instance.

Public class

FNodePrunedError

FNodePrunedError

Public class

FNoOpOperator

Public class

FOperatorBuilder

FOperatorBuilder builds an IOperator from an IGraph.

Public struct

FOperatorBuilderSettings

FOperatorBuilderSettings

Public class

FOperatorSettings

FOperatorSettings

Public struct

FOutputDataSource

FOutputDataSource describes the source of data which is produced within a graph and exposed external to the graph.

Public class

FOutputDataVertex

FOutputDataVertex represents an input vertex to an interface.

Public struct

FOutputDataVertexModel

FOutputDataVertexModel

Public struct

FStronglyConnectedComponent

A strongly connected component containing Metasound INodes and FDataEdges.

Public class

FVertexInterface

FVertexInterface provides access to a collection of input and output vertex interfaces.

Public class

IDataReference

A Data Reference Interface.

Public class

IGraph

Interface for graph of nodes.

Public class

IMetasoundEnvironmentVariable

Interface for a metasound environment variable which supports a name, a runtime type ID, and a clone method.

Public class

IMetasoundGraphCoreModule

Public class

INode

INode

Interface for all nodes that can create operators.

Public class

INodeBase

INodeBase

Public class

IOperator

IOperator

Public class

IOperatorBuilder

IOperatorBuilder

Public class

IOperatorBuildError

IOperatorBuildError

Public class

IOperatorFactory

IOperatorFactory

Public struct

TAnyConstructorForwarding

Denotes that parameter pack arguments and/or FOperatorSettings is optional when constructing the Metasound Data Type.

Public struct

TBaseVertexModel

TBaseVertexModel provides basic functionality of vertex models.

Public struct

TDataFactory

A base factory type for creating objects related to Metasound DataTypes.

Public struct

TDataFactoryInternal

Core factory type for creating objects related to metasound data types.

Public struct

TDataLiteralFactory

A base factory type for creating objects related to Metasound DataTypes.

Public class

TDataReadReference

Forward declare.

Public struct

TDataReadReferenceFactory

TDataReadReferenceFactory creates TDataReadReferences for the given DataType.

Public struct

TDataReadReferenceLiteralFactory

TDataReadReferenceLiteralFactory creates TDataReadReferences for the given DataType.

Public class

TDataReference

Template class for a paramter reference.

Public struct

TDataReferenceTypeInfo

Info for templated data reference types help perform runtime type verification.

Public struct

TDataTypeConstructorTraits

Description of available constructors for a registered Metasound Data Type.

Public struct

TDataTypeCreator

Create a DataType. For use in TDataFactory.

Public struct

TDataTypeFactory

TDataTypeFactory creates a DataType.

Public struct

TDataTypeLiteralFactory

TDataTypeLiteralFactory creates a DataType.

Public struct

TDataTypeVariantConstructorTraits

Constructor traits for a for variant inputs.

Public struct

TDataTypeVariantFallbackHelper

Helper for determine whether constructor accepts the variant type.

Public struct

TDataTypeVariantParsing

TDataTypeVariantParsing informs the TDataVariantFactoryInternal on which factory method to instantiate.

Public struct

TDataVariantFactoryInternal

Core factory type for creating objects related to Metasound DataTypes.

Public class

TDataWriteReference

TDataWriteReference provides write access to a shared parameter reference.

Public struct

TDataWriteReferenceFactory

TDataWriteReferenceFactory creates TDataWriteReferences for the given DataType.

Public struct

TDataWriteReferenceLiteralFactory

TDataWriteReferenceLiteralFactory creates TDataWriteReferences for the given DataType.

Public struct

TElementType

TElementType determines the element type of a container.

Public struct

TEnvironmentVariableTypeInfo

Struct TEnvironmentVariableTypeInfo

Public struct

TEnvironmentVertexModel

TEnvironmentVertexModel creates a simple, unchanging, environment vertex.

Public struct

TExecutableDataType

As a general rule, ExecutableDataTypes should be avoided whenever possible as they incur an undesired cost and are generally not typically necessary.

Public class

TExecutableOperator

Convenience class for supporting the IOperator interface's GetExecuteFunction virtual member function.

Public struct

TExplicitArgsConstructorForwarding

Denotes that parameter pack arguments must be used in the constructor of the Metasound Data Type.

Public struct

TExplicitConstructorForwarding

Denotes that both FOperatorSettings and parameter pack arguments must be used in the constructor of the Metasound Data Type.

Public struct

TFacadeOperatorClass

TFacadeOperatorClass encapsulates an operator type and checks that the required static functions exist to build the facade operator class.

Public struct

TInputDataVertexModel

TOuputDataVertexModel creates a simple, unchanging, input vertex.

Public class

TIsFactoryMethodDeclared

Helper template to determine whether a static class function is declared for a given template class.

Public class

TIsNodeInfoDeclared

Helper template to determine whether a static class function is declared for a given template class.

Public struct

TIsParsable

Determines whether a DataType supports a constructor which accepts and FOperatorSettings with ArgTypes and/or just ArgTypes.

Public struct

TIsVariable

Template to determine if data type is a variable.

Public struct

TLiteralDefaultValueFromDecayed

Public class

TLiteralNode

TLiteralNode represents a variable within a metasound graph.

Public class

TLiteralOperator

Public class

TLiteralOperatorLiteralFactory

TLiteralOperatorLiteralFactory creates an input by passing it a literal.

Public struct

TLiteralTraits

Determines whether a DataType supports construction using the given literal.

Public struct

TLiteralTypeInfo

Provides literal type information for a given type.

Public class

TMetasoundEnvironmentVariable

Public struct

TOutputDataVertexModel

TOuputDataVertexModel creates a simple, unchanging, output vertex.

Public struct

TSpecializationHelper

Helper class to ensure that DECLARE_METASOUND_ENVIRONMENT_VARIABLE is used.

Public struct

TSpecializationHelper

Helper class to enforce specialization of TDataReferenceTypeInfo

Public struct

TTypePromoter

Promote which type to use for fallback.

Public struct

TVariable

A MetaSound Variable contains a data reference's prior and current value.

Public class

TVariableAccessorNode

FGetVariable node provides delay free, cpu free access to a set variable.

Public class

TVariableDeferredAccessorNode

TVariableDeferredAccessorNode provides access to the prior executions variable value.

Public class

TVariableMutatorNode

TVariableMutatorNode allows variable values to be set.

Public class

TVariableNode

Variable nodes initialize variable values.

Public class

TVertexInterfaceGroup

TVertexInterfaceGroups encapsulates multiple related data vertices.

Typedefs

Name

Description

FBuildErrorArray

Array of build errors.

FEnvironmentVertexInterface

FEnvironmentVertexInterface is a TVertexInterfaceGroup which holds FEnvironmentVertexes.

FInputDataDestinationCollection

FInputDataDestinationCollection contains multiple FInputDataDestinations mapped by FNodeDataVertexKeys.

FInputVertexInterface

FInputVertexInterface is a TVertexInterfaceGroup which holds FInputDataVertexes.

FMetasoundDataTypeId

FMetasoundEnvironmentVariableTypeId

FNodeDataVertexKey

Key type for an FOutputDataSource or FInputDataDestination.

FOperatorFactorySharedRef

Shared ref type of operator factory.

FOutputDataSourceCollection

FOutputDataSourceCollection contains multiple FOutputDataSources mapped by FNodeDataVertexKeys.

FOutputVertexInterface

FOutputVertexInterface is a TVertexInterfaceGroup which holds FOutputDataVertexes.

FSampleRate

FVertexName

Name of a given vertex. Only unique for a given node interface.

Enums

Name

Description

Public enum

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.

Public enum

Metasound::ELiteralType

ELiteralType describes the format of the values held in the literal.

Public enum

Metasound::EOperatorBuilderNodePruning

EOperatorBuildNodePruning expresses the desired pruning behavior during the node pruning step.

Functions

Name Description

Public function

FString

 

LexToString

(
    const Metasound::FLiteral& InLiter...
)

Public function

void

 

Metasound::AddBuildError

(
    FBuildErrorArray& OutErrors,
    ArgTypes&&... Args
)

Convenience template for adding build errors.

Public function

const TMetas...

 

Metasound::CastMetasoundEnvironmentVariableChecked

(
    const IMetasoundEnvironmentVariable...
)

Casts an environment variable to the derived type.

Public function

TMetasoundEn...

 

Metasound::CastMetasoundEnvironmentVariableChecked

(
    IMetasoundEnvironmentVariable& InV...
)

Casts an environment variable to the derived type.

Public function

const FText ...

 

Metasound::GetMetasoundDataTypeDisplayText()

Return the display text for a registered data type.

Public function

const void &...

 

Metasound::GetMetasoundDataTypeId()

Return the data type ID for a registered data type.

Public function

const FName ...

 

Metasound::GetMetasoundDataTypeName()

Return the data type FName for a registered data type.

Public function

const FStrin...

 

Metasound::GetMetasoundDataTypeString()

Return the data type string for a registered data type.

Public function

FMetasoundEn...

 

Metasound::GetMetasoundEnvironmentVariableTypeId()

Return the type ID for a environment variable type.

Public function

bool

 

Metasound::IsDataReferenceOfType

(
    const IDataReference& InReference
)

Test if an IDataReference contains the same data type as the template parameter.

Public function

bool

 

Metasound::IsEnvironmentVariableOfType

(
    const IMetasoundEnvironmentVariable...
)

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

Public function

FNodeDataVer...

 

Metasound::MakeDestinationDataVertexKey

(
    const FInputDataDestination& InDes...
)

Public function

TSharedRef< ...

 

Metasound::MakeOperatorFactoryRef

(
    ArgTypes&&... Args
)

Convenience function for making operator factory references

Public function

FNodeDataVer...

 

Metasound::MakeSourceDataVertexKey

(
    const FOutputDataSource& InSource
)

Make a FNodeDataVertexKey from an FOutputDataSource.

Public function

ELiteralType

 

Metasound::MetasoundLiteralIntrinsics::GetLiteralArgTypeFromDecayed()

Default template for converting a template parameter to a literal argument type.

Public function

ELiteralType

 

Metasound::MetasoundLiteralIntrinsics::GetLiteralArgTypeFromDecayed()

Public function

const FNodeC...

 

Metasound::VariableNames::GetVariableAccessorNodeClassName()

Class name for variable accessor node

Public function

const FNodeC...

 

Metasound::VariableNames::GetVariableDeferredAccessorNodeClassName()

Class name for variable deferred accessor node.

Public function

const FNodeC...

 

Metasound::VariableNames::GetVariableMutatorNodeClassName()

Class name for variable mutator node.

Public function

const FNodeC...

 

Metasound::VariableNames::GetVariableNodeClassName()

Class name for variable node.

Public function

TDataWriteRe...

 

Metasound::WriteCast

(
    const TDataReadReference< DataType ...
)

Cast a TDataReadReference to a TDataWriteReference.