1. Epic GamesDeveloper
  3. FShaderValueType

FShaderValueType

API > API/Plugins > API/Plugins/ComputeFramework

   
Name FShaderValueType
Type struct
Header File /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/Public/ComputeFramework/ShaderParamTypeDefinition.h
Include Path #include "ComputeFramework/ShaderParamTypeDefinition.h"

Syntax

USTRUCT ()  
struct FShaderValueType

Structs

Name Remarks
FStructElement A simple container representing a single, named element in a shader value struct.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsDynamicArray bool   ComputeFramework/ShaderParamTypeDefinition.h  
DimensionType EShaderFundamentalDimensionType   ComputeFramework/ShaderParamTypeDefinition.h  
FShaderValueType union FShaderValueType   ComputeFramework/ShaderParamTypeDefinition.h  
MatrixColumnCount uint8   ComputeFramework/ShaderParamTypeDefinition.h  
MatrixRowCount uint8   ComputeFramework/ShaderParamTypeDefinition.h  
Name FName   ComputeFramework/ShaderParamTypeDefinition.h  
StructElements TArray< FStructElement >   ComputeFramework/ShaderParamTypeDefinition.h  
Type EShaderFundamentalType   ComputeFramework/ShaderParamTypeDefinition.h  
VectorElemCount uint8   ComputeFramework/ShaderParamTypeDefinition.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< FShaderValueTypeHandle > GetMemberStructTypes()

 Returns the all the struct types used in this type if the type is a struct. ComputeFramework/ShaderParamTypeDefinition.h  

int32 GetResourceElementSize()

 Returns the size in bytes required to hold one element of this type using HLSL sizing (which may be different from packed sizing in C++). ComputeFramework/ShaderParamTypeDefinition.h  

FString GetTypeDeclaration ( const TMap< FName, FName >& InNamesToReplace,
bool bCommentPaddings
) const

 Returns the type declaration if this type is a struct, or the empty string if not. ComputeFramework/ShaderParamTypeDefinition.h  

FString GetZeroValueAsString()

 Returns a zero value for the type as a string, suitable for use as a constant in HLSL code. ComputeFramework/ShaderParamTypeDefinition.h  

FString ToString ( const FName& InStructTypeNameOverride
) const

 Returns the type name as a string (e.g. 'vector2', 'matrix2x3' or 'struct_name') for use in variable declarations. ComputeFramework/ShaderParamTypeDefinition.h  

Static

Name Remarks Include Path Unreal Specifiers

static FShaderValueTypeHandle FromString ( const FString& InTypeDecl
)

 Parses the given string section and tries to convert to a shader value type. ComputeFramework/ShaderParamTypeDefinition.h  
Returns a scalar value type. ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle Get ( EShaderFundamentalType InType,
int32 InElemCount
)

 Returns a vector value type. ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle Get ( FName InName,
std::initializer_list< FStructElement > InStructElements
)

 Constructor for struct types ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle Get ( FName InName,
const TArray< FStructElement >& InStructElements
)

 Constructor for struct types ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle Get ( EShaderFundamentalType InType,
int32 InRowCount,
int32 InColumnCount
)

 Constructor for vector values. InElemCount can be any value between 1-4 ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle GetOrCreate ( FShaderValueType&& InValueType
)

   ComputeFramework/ShaderParamTypeDefinition.h  

static FShaderValueTypeHandle MakeDynamicArrayType ( const FShaderValueTypeHandle& InElementType
)

 Construct an array type from an existing type ComputeFramework/ShaderParamTypeDefinition.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FShaderValueType& InOtherType
) const

 Returns true if this type and the other type are not equal. ComputeFramework/ShaderParamTypeDefinition.h  

bool operator== ( const FShaderValueType& InOtherType
) const

 Returns true if this type and the other type are exactly equal. ComputeFramework/ShaderParamTypeDefinition.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page