FShaderParametersMetadata

A uniform buffer struct.

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

Public function

FShaderParametersMetadata

(
    EUseCase UseCase,
    const TCHAR* InLayoutName,
    const TCHAR* InStructTypeName,
    const TCHAR* InShaderVariableN...,
    const TCHAR* InStaticSlotName,
    uint32 InSize,
    const TArray< FMember >& InMembers
)

Initialization constructor.

Destructors

Name Description

Public function Virtual

~FShaderParametersMetadata()

Functions

Name Description

Public function Const

void

 

AddResourceTableEntries

(
    TMap< FString, FResourceTableEntry ...,
    TMap< FString, uint32 >& ResourceT...,
    TMap< FString, FString >& Resource...
)

Public function Const

void

 

FindMemberFromOffset

(
    uint16 MemberOffset,
    const FShaderParametersMetadata...,
    const FShaderParametersMetadata::FM...,
    int32* ArrayElementId,
    FString* NamePrefix
)

Find a member for a given offset.

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 FRHIUn...

 

GetLayout()

Public function Const

uint32

 

GetLayoutHash()

Returns a hash about the entire layout of the structure.

Public function Const

const TArray...

 

GetMembers()

Public function Static

TMap< FHashe...

 

GetNameStructMap()

Speed up finding the uniform buffer by its name

Public function Const

void

 

GetNestedStructs

(
    TArray< const FShaderParametersMeta...
)

Public function Const

const FHashe...

 

GetShaderVariableHashedName()

Public function Const

const TCHAR ...

 

GetShaderVariableName()

Public function Const

uint32

 

GetSize()

Public function Const

const TCHAR ...

 

GetStaticSlotName()

Public function Static

TLinkedList<...

 

GetStructList()

Public function Const

const TCHAR ...

 

GetStructTypeName()

Public function Const

EUseCase

 

GetUseCase()

Public function Const

bool

 

HasStaticSlot()

Public function Static

void

 

InitializeAllUniformBufferStructs()

Initialize all the global shader parameter structs.

Classes

Name

Description

Public class

FMember

A member of a shader parameter structure.

Enums

Name

Description

Public enum

EUseCase

The use case of the uniform buffer structures.

Constants

Name

Description

kRootUniformBufferBindingName

Shader binding name of the uniform buffer that contains the root shader parameters.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss