UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRHIBufferInitializer Struct Reference

#include <RHIBufferInitializer.h>

+ Inheritance diagram for FRHIBufferInitializer:

Public Member Functions

 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 ()
 

Protected Types

using FFinalizeCallback = TUniqueFunction< FBufferRHIRef(FRHICommandListBase &)>
 

Protected Member Functions

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

FFinalizeCallback FinalizeCallback = nullptr
 
FRHICommandListBaseCommandList = nullptr
 
FRHIBufferBuffer = nullptr
 
voidWritableData = nullptr
 
uint64 WritableSize = 0
 

Member Typedef Documentation

◆ FFinalizeCallback

Constructor & Destructor Documentation

◆ FRHIBufferInitializer() [1/4]

FRHIBufferInitializer::FRHIBufferInitializer ( )
default

◆ FRHIBufferInitializer() [2/4]

FRHIBufferInitializer::FRHIBufferInitializer ( FRHIBufferInitializer &&  InOther)
inline

◆ ~FRHIBufferInitializer()

FRHIBufferInitializer::~FRHIBufferInitializer ( )
inline

◆ FRHIBufferInitializer() [3/4]

FRHIBufferInitializer::FRHIBufferInitializer ( FRHICommandListBase RHICmdList,
FRHIBuffer InBuffer,
void InWritableData,
uint64  InWritableSize,
FRHIBufferInitializer::FFinalizeCallback &&  InFinalizeCallback 
)
protected

◆ FRHIBufferInitializer() [4/4]

FRHIBufferInitializer::FRHIBufferInitializer ( const FRHIBufferInitializer )
protecteddelete

Member Function Documentation

◆ FillWithValue()

void FRHIBufferInitializer::FillWithValue ( uint8  Value)
inline

◆ Finalize()

FBufferRHIRef FRHIBufferInitializer::Finalize ( )

◆ GetWritableDataSize()

size_t FRHIBufferInitializer::GetWritableDataSize ( ) const
inline

◆ GetWriteView()

template<typename TElement >
TArrayView< TElement > FRHIBufferInitializer::GetWriteView ( )
inline

◆ operator=() [1/2]

FRHIBufferInitializer & FRHIBufferInitializer::operator= ( const FRHIBufferInitializer )
protecteddelete

◆ operator=() [2/2]

FRHIBufferInitializer & FRHIBufferInitializer::operator= ( FRHIBufferInitializer &&  )
protecteddelete

◆ RemovePendingBufferUpload()

void FRHIBufferInitializer::RemovePendingBufferUpload ( )
protected

◆ Reset()

void FRHIBufferInitializer::Reset ( )
inlineprotected

◆ WriteData()

void FRHIBufferInitializer::WriteData ( const void Source,
size_t  Size 
)
inline

◆ WriteDataOffset()

void FRHIBufferInitializer::WriteDataOffset ( uint64  Offset,
const void Source,
size_t  Size 
)
inline

◆ WriteDataParallel()

void FRHIBufferInitializer::WriteDataParallel ( const void Source,
size_t  Size 
)
inline

Member Data Documentation

◆ Buffer

FRHIBuffer* FRHIBufferInitializer::Buffer = nullptr
protected

◆ CommandList

FRHICommandListBase* FRHIBufferInitializer::CommandList = nullptr
protected

◆ FinalizeCallback

FFinalizeCallback FRHIBufferInitializer::FinalizeCallback = nullptr
protected

◆ WritableData

void* FRHIBufferInitializer::WritableData = nullptr
protected

◆ WritableSize

uint64 FRHIBufferInitializer::WritableSize = 0
protected

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