UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Friends | List of all members
FShaderParametersMetadata::FMember Class Reference

#include <ShaderParameterMetadata.h>

Public Member Functions

 FMember (const TCHAR *InName, const TCHAR *InShaderType, int32 InFileLine, uint32 InOffset, EUniformBufferBaseType InBaseType, EShaderPrecisionModifier::Type InPrecision, uint32 InNumRows, uint32 InNumColumns, uint32 InNumElements, const FShaderParametersMetadata *InStruct)
 
const TCHAR * GetName () const
 
const TCHAR * GetShaderType () const
 
int32 GetFileLine () const
 
uint32 GetOffset () const
 
EUniformBufferBaseType GetBaseType () const
 
EShaderPrecisionModifier::Type GetPrecision () const
 
uint32 GetNumRows () const
 
uint32 GetNumColumns () const
 
uint32 GetNumElements () const
 
const FShaderParametersMetadata * GetStructMetadata () const
 
bool IsVariableNativeType () const
 
uint32 GetMemberSize () const
 
RENDERCORE_API void GenerateShaderParameterType (FString &Result, bool bSupportsPrecisionModifier) const
 
RENDERCORE_API void GenerateShaderParameterType (FString &Result, EShaderPlatform ShaderPlatform) const
 

Static Public Member Functions

static RENDERCORE_API void GenerateShaderParameterType (FString &Result, bool bSupportsPrecisionModifier, EUniformBufferBaseType BaseType, EShaderPrecisionModifier::Type PrecisionModifier, uint32 NumRows, uint32 NumColumns)
 

Friends

class FShaderParametersMetadata
 

Detailed Description

A member of a shader parameter structure.

Constructor & Destructor Documentation

◆ FMember()

FShaderParametersMetadata::FMember::FMember ( const TCHAR *  InName,
const TCHAR *  InShaderType,
int32  InFileLine,
uint32  InOffset,
EUniformBufferBaseType  InBaseType,
EShaderPrecisionModifier::Type  InPrecision,
uint32  InNumRows,
uint32  InNumColumns,
uint32  InNumElements,
const FShaderParametersMetadata *  InStruct 
)
inline

Initialization constructor.

Member Function Documentation

◆ GenerateShaderParameterType() [1/3]

void FShaderParametersMetadata::FMember::GenerateShaderParameterType ( FString &  Result,
bool  bSupportsPrecisionModifier 
) const

◆ GenerateShaderParameterType() [2/3]

void FShaderParametersMetadata::FMember::GenerateShaderParameterType ( FString &  Result,
bool  bSupportsPrecisionModifier,
EUniformBufferBaseType  BaseType,
EShaderPrecisionModifier::Type  PrecisionModifier,
uint32  NumRows,
uint32  NumColumns 
)
static

◆ GenerateShaderParameterType() [3/3]

void FShaderParametersMetadata::FMember::GenerateShaderParameterType ( FString &  Result,
EShaderPlatform  ShaderPlatform 
) const

◆ GetBaseType()

EUniformBufferBaseType FShaderParametersMetadata::FMember::GetBaseType ( ) const
inline

Returns the type of the elements, int, UAV...

◆ GetFileLine()

int32 FShaderParametersMetadata::FMember::GetFileLine ( ) const
inline

Returns the C++ line number where the parameter is declared.

◆ GetMemberSize()

uint32 FShaderParametersMetadata::FMember::GetMemberSize ( ) const
inline

Returns the size of the member.

If this an array, the alignment of the element are changed.

◆ GetName()

const TCHAR * FShaderParametersMetadata::FMember::GetName ( ) const
inline

Returns the string of the name of the element or name of the array of elements.

◆ GetNumColumns()

uint32 FShaderParametersMetadata::FMember::GetNumColumns ( ) const
inline

Returns the number of column in the element. For instance FMatrix would return 4, or FVector would return 3.

◆ GetNumElements()

uint32 FShaderParametersMetadata::FMember::GetNumElements ( ) const
inline

Returns the number of elements in array, or 0 if this is not an array.

◆ GetNumRows()

uint32 FShaderParametersMetadata::FMember::GetNumRows ( ) const
inline

Returns the number of row in the element. For instance FMatrix would return 4, or FVector would return 1.

◆ GetOffset()

uint32 FShaderParametersMetadata::FMember::GetOffset ( ) const
inline

Returns the offset of the element in the shader parameter struct in bytes.

◆ GetPrecision()

EShaderPrecisionModifier::Type FShaderParametersMetadata::FMember::GetPrecision ( ) const
inline

Floating point the element is being stored.

◆ GetShaderType()

const TCHAR * FShaderParametersMetadata::FMember::GetShaderType ( ) const
inline

Returns the string of the type.

◆ GetStructMetadata()

const FShaderParametersMetadata * FShaderParametersMetadata::FMember::GetStructMetadata ( ) const
inline

Returns the metadata of the struct.

◆ IsVariableNativeType()

bool FShaderParametersMetadata::FMember::IsVariableNativeType ( ) const
inline

Friends And Related Symbol Documentation

◆ FShaderParametersMetadata

friend class FShaderParametersMetadata
friend
The documentation for this class was generated from the following files: