FShaderParametersMetadata

A uniform buffer struct.

Choose your operating system:

Windows

macOS

Linux

References

Module	RenderCore
Header	/Engine/Source/Runtime/RenderCore/Public/ShaderParameterMetadata.h
Include	#include "ShaderParameterMetadata.h"

Syntax

class FShaderParametersMetadata

Remarks

A uniform buffer struct.

Constructors

	Name	Description
	FShaderParametersMetadata ( EUseCase UseCase, EUniformBufferBindingFlags InBindin..., const TCHAR* InLayoutName, const TCHAR* InStructTypeName, const TCHAR* InShaderVariableN..., const TCHAR* InStaticSlotName, const ANSICHAR* InFileName, const int32 InFileLine, uint32 InSize, const TArray< FMember >& InMembers, bool bForceCompleteInitialization, FRHIUniformBufferLayoutInitializer ... )	Initialization constructor.

Destructors

	Name	Description
	~FShaderParametersMetadata()

Functions

	Name	Description
void	AddResourceTableEntries ( TMap< FString, FResourceTableEntry ..., TMap< FString, FUniformBufferEntry ... )
void	FindMemberFromOffset ( uint16 MemberOffset, const FShaderParametersMetadata..., const FShaderParametersMetadata::FM..., int32* ArrayElementId, FString* NamePrefix )	Find a member for a given offset.
EUniformBuff...	GetBindingFlags()
const int32	GetFileLine()	Returns the C++ line number where the parameter structure is declared.
const ANSICH...	GetFileName()	Returns the C++ file name where the parameter structure is declared.
FString	GetFullMemberCodeName ( uint16 MemberOffset )	Returns the full C++ member name from it's byte offset in the structure.
const FRHIUn...	GetLayout()
uint32	GetLayoutHash()	Returns a hash about the entire layout of the structure.
const FRHIUn...	GetLayoutPtr()
const TArray...	GetMembers()
TMap< FHashe...	GetNameStructMap()	Speed up finding the uniform buffer by its name
void	GetNestedStructs ( TArray< const FShaderParametersMeta... )
EUniformBuff...	GetPreferredBindingFlag()
const FHashe...	GetShaderVariableHashedName()
const TCHAR ...	GetShaderVariableName()
uint32	GetSize()
const TCHAR ...	GetStaticSlotName()
TLinkedList<...	GetStructList()
const TCHAR ...	GetStructTypeName()
EUseCase	GetUseCase()
bool	HasStaticSlot()
void	InitializeAllUniformBufferStructs()	Initialize all the global shader parameter structs.
bool	IsLayoutInitialized()
void	IterateShaderParameterMembers ( TParameterFunction Lambda )	Iterate recursively over all shader parameter members.
void	IterateStructureMetadataDependencies ( TParameterFunction Lambda )	Iterate recursively over all FShaderParametersMetadata.

Classes

	Name	Description
	FMember	A member of a shader parameter structure.

Enums

	Name	Description
	EUseCase	The use case of the uniform buffer structures.

Constants

Name	Description
kRootCBufferBindingIndex	Shader binding name of the uniform buffer that contains the root shader parameters.
kRootUniformBufferBindingName	Shader binding name of the uniform buffer that contains the root shader parameters.