UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TRHIBufferInitializer< ElementType > Struct Template Reference

#include <RHIBufferInitializer.h>

+ Inheritance diagram for TRHIBufferInitializer< ElementType >:

Public Member Functions

 TRHIBufferInitializer ()=delete
 
 TRHIBufferInitializer (TRHIBufferInitializer &&)=default
 
 TRHIBufferInitializer (const TRHIBufferInitializer &)=delete
 
 TRHIBufferInitializer (const FRHIBufferInitializer &InInitializer)=delete
 
 TRHIBufferInitializer (FRHIBufferInitializer &&InInitializer)
 
ElementType * GetWritableData ()
 
uint64 GetWritableElementCount () const
 
TArrayView< ElementType > GetWriteView ()
 
void WriteArray (size_t ElementOffset, TConstArrayView< ElementType > InData)
 
void WriteArray (TConstArrayView< ElementType > InData)
 
template<size_t TCount>
void WriteArray (const ElementType(&InData)[TCount])
 
void WriteValue (const ElementType &InElement)
 
void WriteValueAtIndex (uint32 Index, const ElementType &InElement)
 
ElementType & operator[] (int32 Index)
 
- Public Member Functions inherited from FRHIBufferInitializer
 FRHIBufferInitializer ()=default
 
 FRHIBufferInitializer (FRHIBufferInitializer &&InOther)
 
 ~FRHIBufferInitializer ()
 
void WriteDataOffset (uint64 Offset, const void *Source, size_t Size)
 
void WriteData (const void *Source, size_t Size)
 
void WriteDataParallel (const void *Source, size_t Size)
 
void FillWithValue (uint8 Value)
 
size_t GetWritableDataSize () const
 
template<typename TElement >
TArrayView< TElementGetWriteView ()
 
RHI_API FBufferRHIRef Finalize ()
 

Additional Inherited Members

- Protected Types inherited from FRHIBufferInitializer
using FFinalizeCallback = TUniqueFunction< FBufferRHIRef(FRHICommandListBase &)>
 
- Protected Member Functions inherited from FRHIBufferInitializer
RHI_API FRHIBufferInitializer (FRHICommandListBase &RHICmdList, FRHIBuffer *InBuffer, void *InWritableData, uint64 InWritableSize, FFinalizeCallback &&InFinalizeCallback)
 
RHI_API void RemovePendingBufferUpload ()
 
 FRHIBufferInitializer (const FRHIBufferInitializer &)=delete
 
FRHIBufferInitializeroperator= (const FRHIBufferInitializer &)=delete
 
FRHIBufferInitializeroperator= (FRHIBufferInitializer &&)=delete
 
void Reset ()
 
- Protected Attributes inherited from FRHIBufferInitializer
FFinalizeCallback FinalizeCallback = nullptr
 
FRHICommandListBaseCommandList = nullptr
 
FRHIBufferBuffer = nullptr
 
voidWritableData = nullptr
 
uint64 WritableSize = 0
 

Constructor & Destructor Documentation

◆ TRHIBufferInitializer() [1/5]

template<typename ElementType >
TRHIBufferInitializer< ElementType >::TRHIBufferInitializer ( )
delete

◆ TRHIBufferInitializer() [2/5]

template<typename ElementType >
TRHIBufferInitializer< ElementType >::TRHIBufferInitializer ( TRHIBufferInitializer< ElementType > &&  )
default

◆ TRHIBufferInitializer() [3/5]

template<typename ElementType >
TRHIBufferInitializer< ElementType >::TRHIBufferInitializer ( const TRHIBufferInitializer< ElementType > &  )
delete

◆ TRHIBufferInitializer() [4/5]

template<typename ElementType >
TRHIBufferInitializer< ElementType >::TRHIBufferInitializer ( const FRHIBufferInitializer InInitializer)
delete

◆ TRHIBufferInitializer() [5/5]

template<typename ElementType >
TRHIBufferInitializer< ElementType >::TRHIBufferInitializer ( FRHIBufferInitializer &&  InInitializer)
inline

Member Function Documentation

◆ GetWritableData()

template<typename ElementType >
ElementType * TRHIBufferInitializer< ElementType >::GetWritableData ( )
inline

◆ GetWritableElementCount()

template<typename ElementType >
uint64 TRHIBufferInitializer< ElementType >::GetWritableElementCount ( ) const
inline

◆ GetWriteView()

template<typename ElementType >
TArrayView< ElementType > TRHIBufferInitializer< ElementType >::GetWriteView ( )
inline

◆ operator[]()

template<typename ElementType >
ElementType & TRHIBufferInitializer< ElementType >::operator[] ( int32  Index)
inline

◆ WriteArray() [1/3]

template<typename ElementType >
template<size_t TCount>
void TRHIBufferInitializer< ElementType >::WriteArray ( const ElementType(&)  InData[TCount])
inline

◆ WriteArray() [2/3]

template<typename ElementType >
void TRHIBufferInitializer< ElementType >::WriteArray ( size_t  ElementOffset,
TConstArrayView< ElementType >  InData 
)
inline

◆ WriteArray() [3/3]

template<typename ElementType >
void TRHIBufferInitializer< ElementType >::WriteArray ( TConstArrayView< ElementType >  InData)
inline

◆ WriteValue()

template<typename ElementType >
void TRHIBufferInitializer< ElementType >::WriteValue ( const ElementType &  InElement)
inline

◆ WriteValueAtIndex()

template<typename ElementType >
void TRHIBufferInitializer< ElementType >::WriteValueAtIndex ( uint32  Index,
const ElementType &  InElement 
)
inline

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