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
FRDGParameterStruct Class Reference

#include <RenderGraphParameter.h>

+ Inheritance diagram for FRDGParameterStruct:

Public Member Functions

template<typename ParameterStructType >
 FRDGParameterStruct (const ParameterStructType *Parameters, const FShaderParametersMetadata *InParameterMetadata)
 
 FRDGParameterStruct (const void *InContents, const FRHIUniformBufferLayout *InLayout)
 
const uint8 * GetContents () const
 
const FRHIUniformBufferLayout & GetLayout () const
 
const FRHIUniformBufferLayout * GetLayoutPtr () const
 
const FShaderParametersMetadata * GetMetadata () const
 
bool HasRenderTargets () const
 
bool HasExternalOutputs () const
 
bool HasStaticSlot () const
 
uint32 GetBufferParameterCount () const
 
uint32 GetTextureParameterCount () const
 
uint32 GetUniformBufferParameterCount () const
 
const FRenderTargetBindingSlots & GetRenderTargets () const
 
template<typename FunctionType >
void Enumerate (FunctionType Function) const
 
template<typename FunctionType >
void EnumerateTextures (FunctionType Function) const
 
template<typename FunctionType >
void EnumerateBuffers (FunctionType Function) const
 
template<typename FunctionType >
void EnumerateUniformBuffers (FunctionType Function) const
 
RENDERCORE_API FUniformBufferStaticBindings GetStaticUniformBuffers () const
 
RENDERCORE_API FRHIRenderPassInfo GetRenderPassInfo () const
 

Static Public Member Functions

static void ClearUniformBuffers (void *Contents, const FRHIUniformBufferLayout *Layout)
 

Friends

class FRDGPass
 

Detailed Description

Wraps a pass parameter struct payload and provides helpers for traversing members.

Constructor & Destructor Documentation

◆ FRDGParameterStruct() [1/2]

template<typename ParameterStructType >
FRDGParameterStruct::FRDGParameterStruct ( const ParameterStructType *  Parameters,
const FShaderParametersMetadata *  InParameterMetadata 
)
inlineexplicit

◆ FRDGParameterStruct() [2/2]

FRDGParameterStruct::FRDGParameterStruct ( const void *  InContents,
const FRHIUniformBufferLayout *  InLayout 
)
inlineexplicit

Member Function Documentation

◆ ClearUniformBuffers()

void FRDGParameterStruct::ClearUniformBuffers ( void *  Contents,
const FRHIUniformBufferLayout *  Layout 
)
inlinestatic

Clears out all uniform buffer references in the parameter struct.

◆ Enumerate()

template<typename FunctionType >
void FRDGParameterStruct::Enumerate ( FunctionType  Function) const

Enumerates all graph parameters on the layout. Graph uniform buffers are traversed recursively but are also included in the enumeration. Expected function signature: void(FRDGParameter).

◆ EnumerateBuffers()

template<typename FunctionType >
void FRDGParameterStruct::EnumerateBuffers ( FunctionType  Function) const

Same as Enumerate, but only buffer parameters are included.

◆ EnumerateTextures()

template<typename FunctionType >
void FRDGParameterStruct::EnumerateTextures ( FunctionType  Function) const

Same as Enumerate, but only texture parameters are included.

◆ EnumerateUniformBuffers()

template<typename FunctionType >
void FRDGParameterStruct::EnumerateUniformBuffers ( FunctionType  Function) const

Enumerates all non-null uniform buffers. Expected function signature: void(FRDGUniformBufferBinding).

◆ GetBufferParameterCount()

uint32 FRDGParameterStruct::GetBufferParameterCount ( ) const
inline

Returns the number of buffer parameters present on the layout.

◆ GetContents()

const uint8 * FRDGParameterStruct::GetContents ( ) const
inline

Returns the contents of the struct.

◆ GetLayout()

const FRHIUniformBufferLayout & FRDGParameterStruct::GetLayout ( ) const
inline

Returns the layout associated with this struct.

◆ GetLayoutPtr()

const FRHIUniformBufferLayout * FRDGParameterStruct::GetLayoutPtr ( ) const
inline

◆ GetMetadata()

const FShaderParametersMetadata * FRDGParameterStruct::GetMetadata ( ) const
inline

◆ GetRenderPassInfo()

FRHIRenderPassInfo FRDGParameterStruct::GetRenderPassInfo ( ) const

Returns the render pass info generated from the render target binding slots.

◆ GetRenderTargets()

const FRenderTargetBindingSlots & FRDGParameterStruct::GetRenderTargets ( ) const
inline

Returns the render target binding slots. Asserts if they don't exist.

◆ GetStaticUniformBuffers()

FUniformBufferStaticBindings FRDGParameterStruct::GetStaticUniformBuffers ( ) const

Returns a set of static uniform buffer bindings for the parameter struct.

◆ GetTextureParameterCount()

uint32 FRDGParameterStruct::GetTextureParameterCount ( ) const
inline

Returns the number of texture parameters present on the layout.

◆ GetUniformBufferParameterCount()

uint32 FRDGParameterStruct::GetUniformBufferParameterCount ( ) const
inline

Returns the number of RDG uniform buffers present in the layout.

◆ HasExternalOutputs()

bool FRDGParameterStruct::HasExternalOutputs ( ) const
inline

◆ HasRenderTargets()

bool FRDGParameterStruct::HasRenderTargets ( ) const
inline

Helpful forwards from the layout.

◆ HasStaticSlot()

bool FRDGParameterStruct::HasStaticSlot ( ) const
inline

Friends And Related Symbol Documentation

◆ FRDGPass

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