Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Plugins > ComputeFramework > ComputeFramework > FShaderValueType

Light Theme

Dark Theme

FShaderValueType

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

USTRUCT()
struct FShaderValueType

Variables

		Name	Description
	union FShaderVa...	@10325
	EShaderFundamen...	DimensionType
	uint8	MatrixColumnCount
	uint8	MatrixRowCount
	FName	Name
	TArray< FStruct...	StructElements
	EShaderFundamen...	Type
	uint8	VectorElemCount

Functions

		Name	Description
	FShaderValue...	FromString ( const FString& InTypeDecl )	Parses the given string section and tries to convert to a shader value type.
	FShaderValue...	Get ( EShaderFundamentalType InType )	Returns a scalar value type.
	FShaderValue...	Get ( EShaderFundamentalType InType, int32 InElemCount )	Returns a vector value type.
	FShaderValue...	Get ( FName InName, std::initializer_list< FStructEleme... )	Constructor for struct types
	FShaderValue...	Get ( EShaderFundamentalType InType, int32 InRowCount, int32 InColumnCount )	Constructor for vector values. InElemCount can be any value between 1-4
	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++).
	FString	GetTypeDeclaration()	Returns the type declaration if this type is a struct, or the empty string if not.
	FString	GetZeroValueAsString()	Returns a zero value for the type as a string, suitable for use as a constant in HLSL code.
	FString	ToString()	Returns the type name as a string (e.g. 'vector2', 'matrix2x3' or 'struct_name') for use in variable declarations.

Operators

		Name	Description
	bool	operator!= ( const FShaderValueType& InOtherTyp... )	Returns true if this type and the other type are not equal.
	bool	operator== ( const FShaderValueType& InOtherTyp... )	Returns true if this type and the other type are exactly equal.

Classes

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