Navigation
API > API/Runtime > API/Runtime/RHI
FRHIGPUMemoryReadback: Represents a memory readback request scheduled with CopyToStagingBuffer Wraps a staging buffer with a FRHIGPUFence for synchronization.
| Name | FRHIGPUMemoryReadback |
| Type | class |
| Header File | /Engine/Source/Runtime/RHI/Public/RHIGPUReadback.h |
| Include Path | #include "RHIGPUReadback.h" |
Syntax
class FRHIGPUMemoryReadback
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRHIGPUMemoryReadback
(
FName RequestName |
RHIGPUReadback.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRHIGPUMemoryReadback() |
RHIGPUReadback.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EnqueueCopy
(
FRHICommandList& RHICmdList, |
Copy the current state of the resource to the readback data. | RHIGPUReadback.h | |
void EnqueueCopy
(
FRHICommandList& RHICmdList, |
RHIGPUReadback.h | ||
virtual void EnqueueCopy
(
FRHICommandList& RHICmdList, |
RHIGPUReadback.h | ||
const FRHIGPUMask & GetLastCopyGPUMask() |
RHIGPUReadback.h | ||
FName GetName() |
RHIGPUReadback.h | ||
bool IsReady () |
Indicates if the data is in place and ready to be read. | RHIGPUReadback.h | |
bool IsReady
(
FRHIGPUMask GPUMask |
Indicates if the data is in place and ready to be read on a subset of GPUs. | RHIGPUReadback.h | |
void * Lock
(
uint32 NumBytes |
Returns the CPU accessible pointer that backs this staging buffer. | RHIGPUReadback.h | |
void Unlock() |
Signals that the host is finished reading from the backing buffer. | RHIGPUReadback.h | |
void Wait
(
FRHICommandListImmediate& RHICmdList, |
RHIGPUReadback.h |