1. Epic GamesDeveloper
  3. FOptimusDataDomain

FOptimusDataDomain

A struct to specify the domain range of a resource buffer, as defined by compute kernels and data interfaces.

Unreal Engine C++ API Reference > Plugins > OptimusCore

References

   
Module OptimusCore
Header /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusDataDomain.h
Include #include "OptimusDataDomain.h"

Syntax

USTRUCT ()  
struct FOptimusDataDomain

Remarks

A struct to specify the domain range of a resource buffer, as defined by compute kernels and data interfaces. Data domains can be multi-dimensional, expression-based, or empty. Empty domains on pins imply a single value, like a parameter.

Domains come in two flavors, either as a pre-defined list with a multiplier, or as an arithmetic expression. For domains with a multiplier, the multiplier only applies to the innermost dimension (e.g. Vertex.Bone x 2, allows for two values per-bone, but not two values per-bone and per-vertex)

The expression can take any execution domain, or none (e.g. "Vertex * 2 + 1", "Triangle * 2 + Vertex * 6", "1024"). If an expression is used, the domain is one-dimensional. As of now, expression domain comparison is done on the string level, such that "Vertex * 2" and "2 * Vertex" are not marked as compatible domains.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta TArray< FName > DimensionNames The name of the context that this resource/kernel applies to.
Public variable UProperty Category, EditAnywhere, Meta FString Expression  
Public variable UProperty Category, EditAnywhere, Meta int32 Multiplier  
Public variable UProperty Category, EditAnywhere EOptimusDataDomainType Type  

Constructors

  Type Name Description
Public function    
Public function  

FOptimusDataDomain ( TArray< FName > InDimensionNames
)

  
Public function  

FOptimusDataDomain ( FString InExpression
)

  
Public function  

FOptimusDataDomain ( const FOptimusExecutionDomain& InExecutionDomain
)

  
Public function  

FOptimusDataDomain ( TArray< FName > InDimensionNames,
int32 InMultiplier
)

  

Functions

  Type Name Description
Public function Static bool

AreCompatible ( const FOptimusDataDomain& InOutput,
const FOptimusDataDomain& InInput,
FString* OutReason
)

  
Public function Const TOptional< FString >  
Public function void  
Public function Static FOptimusDataDomain

FromString ( const FString& InString
)

 Create a data domain object from a serializable string generated by the above function.
Public function Const FString  
Public function Const TSet< FName >  
Public function Const bool  
Public function Const bool Convenience function to check if this data domain is Multi-dimensional
Public function Const bool Convenience function to check if this data domain is One-dimensional
Public function Const bool Convenience function to check if this data domain is a singleton
Public function Const int  
Public function void

PostSerialize ( const FArchive& Ar
)

  
Public function Const FString Convert the data domain to a text serializable string

Operators

  Type Name Description
Public function Const bool

operator!= ( const FOptimusDataDomain& InOtherDomain
)

  
Public function Const bool

operator== ( const FOptimusDataDomain& InOtherDomain
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page