Navigation
API > API/Plugins > API/Plugins/PCG
A proxy for data residing on the GPU with functionality to read the data back to the CPU.
| Name | UPCGProxyForGPUData |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Compute/Data/PCGProxyForGPUData.h |
| Include Path | #include "Compute/Data/PCGProxyForGPUData.h" |
Syntax
UCLASS (MinimalAPI, ClassGroup=(Procedural), DisplayName="GPU Proxy")
class UPCGProxyForGPUData : public UPCGData
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGProxyForGPUData
Structs
| Name | Remarks |
|---|---|
| FReadbackResult |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeInfo | FPCGDataTypeInfoProxyForGPU | Compute/Data/PCGProxyForGPUData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataCollectionOnGPU | TSharedPtr< FPCGProxyForGPUDataCollection > | Compute/Data/PCGProxyForGPUData.h | ||
| DataIndexInCollection | int32 | Compute/Data/PCGProxyForGPUData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FReadbackResult GetCPUData
(
FPCGContext* InContext |
Populates a CPU data object representing the GPU data, performing a readback from GPU->CPU if required. | Compute/Data/PCGProxyForGPUData.h | |
int GetDataIndexInCollection() |
Compute/Data/PCGProxyForGPUData.h | ||
bool GetDescription
(
FPCGDataDesc& OutDescription |
Returns a description of this data. Does not trigger a GPU->CPU readback. | Compute/Data/PCGProxyForGPUData.h | |
FIntVector4 GetElementCount() |
Returns the element count for this data. Does not trigger a GPU->CPU readback. | Compute/Data/PCGProxyForGPUData.h | |
TSharedPtr< const FPCGProxyForGPUDataCollection > GetGPUInfo() |
Compute/Data/PCGProxyForGPUData.h | ||
TSharedPtr< const FPCGProxyForGPUDataCollection > GetInputDataCollectionInfo() |
Returns the GPU info. Returns null if the buffer has been discarded. | Compute/Data/PCGProxyForGPUData.h | |
void Initialize
(
TSharedPtr< FPCGProxyForGPUDataCollection > InDataCollection, |
Compute/Data/PCGProxyForGPUData.h |
Overridden from UPCGData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToCrc
(
FArchiveCrc32& Ar, |
Adds this data to Crc. | Compute/Data/PCGProxyForGPUData.h | |
virtual bool CanBeSerialized() |
Whether this data can be serialized. | Compute/Data/PCGProxyForGPUData.h | |
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSEPCGDataType GetDataType() |
@todo_pcg To be deprecated when we switch to the new type | Compute/Data/PCGProxyForGPUData.h | |
virtual const FPCGDataTypeBaseId & GetDataTypeId() |
Compute/Data/PCGProxyForGPUData.h | ||
virtual EPCGDataType GetUnderlyingDataType () |
If this data is a proxy, returns the underlying data type, otherwise returns this data type. | Compute/Data/PCGProxyForGPUData.h | |
virtual FPCGDataTypeBaseId GetUnderlyingDataTypeId() |
Compute/Data/PCGProxyForGPUData.h | ||
virtual bool HoldsTransientResources () |
Whether this data is holding onto one or more transient resources. | Compute/Data/PCGProxyForGPUData.h | |
virtual bool IsCacheable() |
Whether the data can be placed in the graph cache. | Compute/Data/PCGProxyForGPUData.h | |
virtual void ReleaseTransientResources
(
const TCHAR* InReason |
Compute/Data/PCGProxyForGPUData.h |