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

#include <RHIResources.h>

+ Inheritance diagram for FRHIUniformBufferLayout:

Public Member Functions

 FRHIUniformBufferLayout ()=delete
 
RHI_API FRHIUniformBufferLayout (const FRHIUniformBufferLayoutInitializer &Initializer)
 
const FString & GetDebugName () const
 
uint32 GetHash () const
 
bool HasRenderTargets () const
 
bool HasExternalOutputs () const
 
bool HasStaticSlot () const
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 

Public Attributes

const FString Name
 
const TArray< FRHIUniformBufferResource > Resources
 
const TArray< FRHIUniformBufferResource > GraphResources
 
const TArray< FRHIUniformBufferResource > GraphTextures
 
const TArray< FRHIUniformBufferResource > GraphBuffers
 
const TArray< FRHIUniformBufferResource > GraphUniformBuffers
 
const TArray< FRHIUniformBufferResource > UniformBuffers
 
const uint32 Hash
 
const uint32 ConstantBufferSize
 
const uint16 RenderTargetsOffset
 
const FUniformBufferStaticSlot StaticSlot
 
const EUniformBufferBindingFlags BindingFlags
 
const ERHIUniformBufferFlags Flags
 

Friends

bool operator== (const FRHIUniformBufferLayout &A, const FRHIUniformBufferLayout &B)
 

Additional Inherited Members

- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 

Detailed Description

The layout of a uniform buffer in memory.

Constructor & Destructor Documentation

◆ FRHIUniformBufferLayout() [1/2]

FRHIUniformBufferLayout::FRHIUniformBufferLayout ( )
delete

◆ FRHIUniformBufferLayout() [2/2]

FRHIUniformBufferLayout::FRHIUniformBufferLayout ( const FRHIUniformBufferLayoutInitializer &  Initializer)
explicit

Member Function Documentation

◆ GetDebugName()

const FString & FRHIUniformBufferLayout::GetDebugName ( ) const
inline

◆ GetHash()

uint32 FRHIUniformBufferLayout::GetHash ( ) const
inline

◆ HasExternalOutputs()

bool FRHIUniformBufferLayout::HasExternalOutputs ( ) const
inline

◆ HasRenderTargets()

bool FRHIUniformBufferLayout::HasRenderTargets ( ) const
inline

◆ HasStaticSlot()

bool FRHIUniformBufferLayout::HasStaticSlot ( ) const
inline

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const FRHIUniformBufferLayout &  A,
const FRHIUniformBufferLayout &  B 
)
friend

Compare two uniform buffer layouts.

Member Data Documentation

◆ BindingFlags

const EUniformBufferBindingFlags FRHIUniformBufferLayout::BindingFlags

The binding flags describing how this resource can be bound to the RHI.

◆ ConstantBufferSize

const uint32 FRHIUniformBufferLayout::ConstantBufferSize

The size of the constant buffer in bytes.

◆ Flags

const ERHIUniformBufferFlags FRHIUniformBufferLayout::Flags

Flags to signal different Uniform Buffer states.

◆ GraphBuffers

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::GraphBuffers

The list of all RDG buffer references inlined into the shader parameter structure.

◆ GraphResources

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::GraphResources

The list of all RDG resource references inlined into the shader parameter structure.

◆ GraphTextures

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::GraphTextures

The list of all RDG texture references inlined into the shader parameter structure.

◆ GraphUniformBuffers

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::GraphUniformBuffers

The list of all RDG uniform buffer references inlined into the shader parameter structure.

◆ Hash

const uint32 FRHIUniformBufferLayout::Hash

◆ Name

const FString FRHIUniformBufferLayout::Name

◆ RenderTargetsOffset

const uint16 FRHIUniformBufferLayout::RenderTargetsOffset

The render target binding slots offset, if it exists.

◆ Resources

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::Resources

The list of all resource inlined into the shader parameter structure.

◆ StaticSlot

const FUniformBufferStaticSlot FRHIUniformBufferLayout::StaticSlot

The static slot (if applicable).

◆ UniformBuffers

const TArray<FRHIUniformBufferResource> FRHIUniformBufferLayout::UniformBuffers

The list of all non-RDG uniform buffer references inlined into the shader parameter structure.

The documentation for this struct was generated from the following files: