1. Epic GamesDeveloper
  3. FShaderValueType

FShaderValueType

API > API/Plugins > API/Plugins/ComputeFramework > API/Plugins/ComputeFramework/ComputeFramework

References

   
Module ComputeFramework
Header /Engine/Plugins/Runtime/ComputeFramework/Source/ComputeFramework/Public/ComputeFramework/ShaderParamTypeDefinition.h
Include #include "ComputeFramework/ShaderParamTypeDefinition.h"

Syntax

USTRUCT&40;&41;  
struct FShaderValueType

Variables

  Type Name Description
Public variable union FShaderValueType::@13239 @13240  
Public variable UProperty bool bIsDynamicArray  
Public variable UProperty EShaderFundamentalDimensionType DimensionType  
Public variable uint8 MatrixColumnCount  
Public variable uint8 MatrixRowCount  
Public variable UProperty FName Name  
Public variable TArray< FStructElement > StructElements  
Public variable UProperty EShaderFundamentalType Type  
Public variable uint8 VectorElemCount  

Functions

  Type Name Description
Public function Static FShaderValueTypeHandle

FromString ( const FString& InTypeDecl
)

 Parses the given string section and tries to convert to a shader value type.
Public function Static FShaderValueTypeHandle Returns a scalar value type.
Public function Static FShaderValueTypeHandle

Get ( EShaderFundamentalType InType,
int32 InElemCount
)

 Returns a vector value type.
Public function Static FShaderValueTypeHandle

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

 Constructor for struct types
Public function Static FShaderValueTypeHandle

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

 Constructor for struct types
Public function Static FShaderValueTypeHandle

Get ( EShaderFundamentalType InType,
int32 InRowCount,
int32 InColumnCount
)

 Constructor for vector values. InElemCount can be any value between 1-4
Public function Const TArray< FShaderValueTypeHandle > Returns the all the struct types used in this type if the type is a struct.
Public function Const int32 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++).
Public function Const FString

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

 Returns the type declaration if this type is a struct, or the empty string if not.
Public function Const FString Returns a zero value for the type as a string, suitable for use as a constant in HLSL code.
Public function Static FShaderValueTypeHandle

MakeDynamicArrayType ( const FShaderValueTypeHandle& InElementType
)

 Construct an array type from an existing type
Public function Const FString

ToString ( const FName& InStructTypeNameOverride
)

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

Operators

  Type Name Description
Public function Const bool

operator!= ( const FShaderValueType& InOtherType
)

 Returns true if this type and the other type are not equal.
Public function Const bool

operator== ( const FShaderValueType& InOtherType
)

 Returns true if this type and the other type are exactly equal.

Classes

  Type Name Description
Public struct FStructElement A simple container representing a single, named element in a shader value struct.  
Public struct FValue    
Public struct FValueView    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page