Navigation
API > API/Plugins > API/Plugins/PCG
A proxy for a data collection residing in a GPU buffer along with functionality to retrieve the data on the CPU. Holds onto GPU memory.
| Name | FPCGProxyForGPUDataCollection |
| Type | struct |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Compute/Data/PCGProxyForGPUData.h |
| Include Path | #include "Compute/Data/PCGProxyForGPUData.h" |
Syntax
struct FPCGProxyForGPUDataCollection : public TSharedFromThis< FPCGProxyForGPUDataCollection >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FPCGProxyForGPUDataCollection
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPCGProxyForGPUDataCollection
(
TRefCountPtr< FRDGPooledBuffer > InBuffer, |
Compute/Data/PCGProxyForGPUData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bReadbackDataArrived | bool | Compute/Data/PCGProxyForGPUData.h | ||
| bReadbackDataProcessed | std::atomic< bool > | Compute/Data/PCGProxyForGPUData.h | ||
| Buffer | TRefCountPtr< FRDGPooledBuffer > | Persistent GPU buffer that can be read back. Buffer will be freed when this ref count is 0. | Compute/Data/PCGProxyForGPUData.h | |
| BufferSizeBytes | uint32 | Compute/Data/PCGProxyForGPUData.h | ||
| Description | TSharedPtr< const FPCGDataCollectionDesc > | Compute/Data/PCGProxyForGPUData.h | ||
| RawReadbackData | TArray< uint8 > | Compute/Data/PCGProxyForGPUData.h | ||
| ReadbackData | TArray< const FPCGTaggedData > | Read back data. Populated once upon first readback request. | Compute/Data/PCGProxyForGPUData.h | |
| ReadbackDataRefs | TArray< TStrongObjectPtr< const UPCGData > > | Compute/Data/PCGProxyForGPUData.h | ||
| ReadbackLock | UE::FSpinLock | Compute/Data/PCGProxyForGPUData.h | ||
| ReadbackRequest | TSharedPtr< FRHIGPUBufferReadback > | Compute/Data/PCGProxyForGPUData.h | ||
| StringTable | TArray< FString > | Used to comprehend string IDs in buffer. | Compute/Data/PCGProxyForGPUData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TRefCountPtr< FRDGPooledBuffer > & GetBuffer() |
Compute/Data/PCGProxyForGPUData.h | ||
uint32 GetBufferSizeBytes() |
Compute/Data/PCGProxyForGPUData.h | ||
bool GetCPUData
(
FPCGContext* InContext, |
Populates a CPU data object representing the GPU data for the given index, performing a readback from GPU->CPU if required. | Compute/Data/PCGProxyForGPUData.h | |
TSharedPtr< const FPCGDataCollectionDesc > GetDescription() |
Compute/Data/PCGProxyForGPUData.h | ||
| Compute/Data/PCGProxyForGPUData.h |