UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FRHIBatchedShaderParameters Struct Reference

#include <RHIShaderParameters.h>

Public Member Functions

 FRHIBatchedShaderParameters (FRHIBatchedShaderParametersAllocator &InAllocator)
 
bool HasParameters () const
 
void Finish ()
 
void Reset ()
 
template<typename... ArgsType>
void AddResourceParameter (ArgsType &&...Args)
 
template<typename... ArgsType>
void AddBindlessParameter (ArgsType &&...Args)
 
void SetShaderParameter (uint32 BufferIndex, uint32 BaseIndex, uint32 NumBytes, const void *NewValue)
 
void SetShaderUniformBuffer (uint32 Index, FRHIUniformBuffer *UniformBuffer)
 
void SetShaderTexture (uint32 Index, FRHITexture *Texture)
 
void SetShaderResourceViewParameter (uint32 Index, FRHIShaderResourceView *SRV)
 
void SetShaderSampler (uint32 Index, FRHISamplerState *State)
 
void SetUAVParameter (uint32 Index, FRHIUnorderedAccessView *UAV)
 
void SetResourceCollection (uint32 Index, FRHIResourceCollection *ResourceCollection)
 
void SetBindlessTexture (uint32 Index, FRHITexture *Texture)
 
void SetBindlessResourceView (uint32 Index, FRHIShaderResourceView *SRV)
 
void SetBindlessSampler (uint32 Index, FRHISamplerState *State)
 
void SetBindlessUAV (uint32 Index, FRHIUnorderedAccessView *UAV)
 
void SetBindlessResourceCollection (uint32 Index, FRHIResourceCollection *ResourceCollection)
 

Public Attributes

FRHIBatchedShaderParametersAllocator & Allocator
 
TArrayView< uint8 > ParametersData
 
TArrayView< FRHIShaderParameter > Parameters
 
TArrayView< FRHIShaderParameterResource > ResourceParameters
 
TArrayView< FRHIShaderParameterResource > BindlessParameters
 

Detailed Description

Collection of parameters to set in the RHI. These parameters aren't bound to any specific shader until SetBatchedShaderParameters is called.

Constructor & Destructor Documentation

◆ FRHIBatchedShaderParameters()

FRHIBatchedShaderParameters::FRHIBatchedShaderParameters ( FRHIBatchedShaderParametersAllocator &  InAllocator)
inline

Member Function Documentation

◆ AddBindlessParameter()

template<typename... ArgsType>
void FRHIBatchedShaderParameters::AddBindlessParameter ( ArgsType &&...  Args)
inline

◆ AddResourceParameter()

template<typename... ArgsType>
void FRHIBatchedShaderParameters::AddResourceParameter ( ArgsType &&...  Args)
inline

◆ Finish()

void FRHIBatchedShaderParameters::Finish ( )
inline

◆ HasParameters()

bool FRHIBatchedShaderParameters::HasParameters ( ) const
inline

◆ Reset()

void FRHIBatchedShaderParameters::Reset ( )
inline

◆ SetBindlessResourceCollection()

void FRHIBatchedShaderParameters::SetBindlessResourceCollection ( uint32  Index,
FRHIResourceCollection *  ResourceCollection 
)
inline

◆ SetBindlessResourceView()

void FRHIBatchedShaderParameters::SetBindlessResourceView ( uint32  Index,
FRHIShaderResourceView *  SRV 
)
inline

◆ SetBindlessSampler()

void FRHIBatchedShaderParameters::SetBindlessSampler ( uint32  Index,
FRHISamplerState *  State 
)
inline

◆ SetBindlessTexture()

void FRHIBatchedShaderParameters::SetBindlessTexture ( uint32  Index,
FRHITexture *  Texture 
)
inline

◆ SetBindlessUAV()

void FRHIBatchedShaderParameters::SetBindlessUAV ( uint32  Index,
FRHIUnorderedAccessView *  UAV 
)
inline

◆ SetResourceCollection()

void FRHIBatchedShaderParameters::SetResourceCollection ( uint32  Index,
FRHIResourceCollection *  ResourceCollection 
)
inline

◆ SetShaderParameter()

void FRHIBatchedShaderParameters::SetShaderParameter ( uint32  BufferIndex,
uint32  BaseIndex,
uint32  NumBytes,
const void *  NewValue 
)
inline

◆ SetShaderResourceViewParameter()

void FRHIBatchedShaderParameters::SetShaderResourceViewParameter ( uint32  Index,
FRHIShaderResourceView *  SRV 
)
inline

◆ SetShaderSampler()

void FRHIBatchedShaderParameters::SetShaderSampler ( uint32  Index,
FRHISamplerState *  State 
)
inline

◆ SetShaderTexture()

void FRHIBatchedShaderParameters::SetShaderTexture ( uint32  Index,
FRHITexture *  Texture 
)
inline

◆ SetShaderUniformBuffer()

void FRHIBatchedShaderParameters::SetShaderUniformBuffer ( uint32  Index,
FRHIUniformBuffer *  UniformBuffer 
)
inline

◆ SetUAVParameter()

void FRHIBatchedShaderParameters::SetUAVParameter ( uint32  Index,
FRHIUnorderedAccessView *  UAV 
)
inline

Member Data Documentation

◆ Allocator

FRHIBatchedShaderParametersAllocator& FRHIBatchedShaderParameters::Allocator

◆ BindlessParameters

TArrayView<FRHIShaderParameterResource> FRHIBatchedShaderParameters::BindlessParameters

◆ Parameters

TArrayView<FRHIShaderParameter> FRHIBatchedShaderParameters::Parameters

◆ ParametersData

TArrayView<uint8> FRHIBatchedShaderParameters::ParametersData

◆ ResourceParameters

TArrayView<FRHIShaderParameterResource> FRHIBatchedShaderParameters::ResourceParameters
The documentation for this struct was generated from the following file: