1. Epic GamesDeveloper
  3. FRHIBufferInitializer

FRHIBufferInitializer

Structure used to allow optimal buffer initialization at creation time.

API > API/Runtime > API/Runtime/RHI

Structure used to allow optimal buffer initialization at creation time. Should only ever be obtained by calling RHICreateBufferInitializer(). NO COPIES ALLOWED

   
Name FRHIBufferInitializer
Type struct
Header File /Engine/Source/Runtime/RHI/Public/RHIBufferInitializer.h
Include Path #include "RHIBufferInitializer.h"

Syntax

struct FRHIBufferInitializer

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  RHIBufferInitializer.h  
  RHIBufferInitializer.h  
Allow copies only for RHI derived types. RHIBufferInitializer.h  

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

 Should only be called by RHI derived types. RHIBufferInitializer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FRHIBufferInitializer()

   RHIBufferInitializer.h  

Typedefs

Name Type Remarks Include Path
FFinalizeCallback TUniqueFunction< FBufferRHIRef(FRHICommandListBase &)>   RHIBufferInitializer.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void FillWithValue ( uint8 Value
)

   RHIBufferInitializer.h  

FBufferRHIRef Finalize()

   RHIBufferInitializer.h  

size_t GetWritableDataSize()

   RHIBufferInitializer.h  

TArrayView< TElement > GetWriteView()

   RHIBufferInitializer.h  

void WriteData ( const void* Source,
size_t Size
)

   RHIBufferInitializer.h  

void WriteDataOffset ( uint64 Offset,
const void* Source,
size_t Size
)

   RHIBufferInitializer.h  

void WriteDataParallel ( const void* Source,
size_t Size
)

   RHIBufferInitializer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RemovePendingBufferUpload()

 Remove the buffer from the command list. Has to be in cpp file to prevent circular header dependency. RHIBufferInitializer.h  

void Reset()

   RHIBufferInitializer.h  

Operators

Name Remarks Include Path Unreal Specifiers
  RHIBufferInitializer.h  
  RHIBufferInitializer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page