Navigation
API > API/Runtime > API/Runtime/RHI
Inheritance Hierarchy
- FRHIGPUMemoryReadback
- FRHIGPUBufferReadback
- FRHIGPUTextureReadback
References
| Module | RHI |
| Header | /Engine/Source/Runtime/RHI/Public/RHIGPUReadback.h |
| Include | #include "RHIGPUReadback.h" |
Syntax
class FRHIGPUMemoryReadback
Remarks
FRHIGPUMemoryReadback: Represents a memory readback request scheduled with CopyToStagingBuffer Wraps a staging buffer with a FRHIGPUFence for synchronization.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FGPUFenceRHIRef | Fence | |
 |
FRHIGPUMask | LastCopyGPUMask | |
 |
uint32 | LastLockGPUIndex | We need to separately track which GPU buffer was last locked. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FRHIGPUMemoryReadback
(
FName RequestName |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | EnqueueCopy
(
FRHICommandList& RHICmdList, |
Copy the current state of the resource to the readback data. |
 |
void | EnqueueCopy
(
FRHICommandList& RHICmdList, |
|
  |
void | EnqueueCopy
(
FRHICommandList& RHICmdList, |
|
  |
const FRHIGPUMask & | ||
  |
FName | GetName () |
|
 |
bool | IsReady () |
Indicates if the data is in place and ready to be read. |
 |
bool | IsReady
(
FRHIGPUMask GPUMask |
Indicates if the data is in place and ready to be read on a subset of GPUs. |
 |
void * | Lock
(
uint32 NumBytes |
Returns the CPU accessible pointer that backs this staging buffer. |
 |
void | Unlock () |
Signals that the host is finished reading from the backing buffer. |