1. Epic GamesDeveloper
  3. FShaderParametersMetadata

FShaderParametersMetadata

A uniform buffer struct.

API > API/Runtime > API/Runtime/RenderCore

References

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

Syntax

class FShaderParametersMetadata

Remarks

A uniform buffer struct.

Constructors

  Type Name Description
Public function  

FShaderParametersMetadata ( EUseCase UseCase,
EUniformBufferBindingFlags InBindingFlags,
const TCHAR* InLayoutName,
const TCHAR* InStructTypeName,
const TCHAR* InShaderVariableName,
const TCHAR* InStaticSlotName,
const ANSICHAR* InFileName,
const int32 InFileLine,
uint32 InSize,
const TArray< FMember >& InMembers,
bool bForceCompleteInitialization,
FRHIUniformBufferLayoutInitializer* OutLayoutInitializer,
uint32 InUsageFlags
)

 Initialization constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AddResourceTableEntries ( FShaderResourceTableMap& ResourceTableMap,
TMap< FString, FUniformBufferEntry >& UniformBufferMap
)

  
Public function Const void

FindMemberFromOffset ( uint16 MemberOffset,
const FShaderParametersMetadata** OutContainingStruct,
const FShaderParametersMetadata::FMember** OutMember,
int32* ArrayElementId,
FString* NamePrefix
)

 Find a member for a given offset.
Public function Const EUniformBufferBindingFlags  
Public function Const const int32 Returns the C++ line number where the parameter structure is declared.
Public function Const const ANSICHAR * Returns the C++ file name where the parameter structure is declared.
Public function Const FString

GetFullMemberCodeName ( uint16 MemberOffset
)

 Returns the full C++ member name from it's byte offset in the structure.
Public function Const const FRHIUniformBufferLayout &  
Public function Const uint32 Returns a hash about the entire layout of the structure.
Public function Const const FRHIUniformBufferLayout *  
Public function Const const TArray< FMember > &  
Public function Static TMap< FHashedName, FShaderParametersMetadata * > & Speed up finding the uniform buffer by its name
Public function Const void

GetNestedStructs ( TArray< const FShaderParametersMetadata* >& OutNestedStructs
)

  
Public function Const EUniformBufferBindingFlags  
Public function Const const FHashedName &  
Public function Const const TCHAR *  
Public function Const uint32

GetSize ()

  
Public function Const const TCHAR *  
Public function Static TLinkedList< FShaderParametersMetadata * > *&  
Public function Const const TCHAR *  
Public function Const const FString &  
Public function Const FThreadSafeSharedStringPtr  
Public function Const const FString &  
Public function Const const FString &  
Public function Const uint32  
Public function Const uint32  
Public function Const EUseCase  
Public function Const bool  
Public function Static void Initialize all the global shader parameter structs.
Public function Const bool  
Public function Const bool  
Public function Const void

IterateStructureMetadataDependencies ( TParameterFunction Lambda
)

 Iterate recursively over all FShaderParametersMetadata.

Classes

  Type Name Description
Public class FMember A member of a shader parameter structure.  

Enums

  Type Name Description
Public enum EUsageFlags Additional flags that can be used to determine usage  
Public enum 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.

Deprecated Functions

  Type Name Description
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

AddResourceTableEntries ( TMap< FString, FResourceTableEntry >& ResourceTableMap,
TMap< FString, FUniformBufferEntry >& UniformBufferMap
)

 Resource table entries are now stored in FShaderResourceTableMap, rather than a TMap.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page