Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGComputeDataProvider |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Compute/DataInterfaces/PCGComputeDataInterface.h |
| Include Path | #include "Compute/DataInterfaces/PCGComputeDataInterface.h" |
Syntax
UCLASS (MinimalAPI, Abstract, ClassGroup=(Procedural))
class UPCGComputeDataProvider : public UComputeDataProvider
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UComputeDataProvider → UPCGComputeDataProvider
Derived Classes
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bProducedByCPU | bool | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| DownstreamInputPinLabelAliases | TArray< FName > | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| GenerationCounter | std::atomic< uint64 > | Bumped each time the data provider is initialized or reset, so that async callbacks can detect if they originated from a previous usage of the data provider and no-op. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
| GraphBindingIndex | int32 | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| OutputPinLabel | FName | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| OutputPinLabelAlias | FName | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| ProducerKernel | TObjectPtr< const UPCGComputeKernel > | Compute/DataInterfaces/PCGComputeDataInterface.h | ||
| ProducerSettings | TSoftObjectPtr< const UPCGSettings > | Settings of node that produces this data, normally the upstream node. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
| ResolvedProducerSettings | TObjectPtr< const UPCGSettings > | Compute/DataInterfaces/PCGComputeDataInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Compute/DataInterfaces/PCGComputeDataInterface.h | |||
int64 GetGenerationCounter() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
int32 GetGraphBindingIndex() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
FName GetOutputPinLabel() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
FName GetOutputPinLabelAlias() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
TObjectPtr< const UPCGComputeKernel > GetProducerKernel() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
const UPCGSettings * GetProducerSettings() |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
bool IsProducedByCPU() |
Set whether data originates from the CPU and should be uploaded to the GPU. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
virtual bool PerformPreExecuteReadbacks_GameThread
(
UPCGDataBinding* InBinding |
Called before PrepareForExecute to allow data providers to do any readbacks and finalize data descriptions. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
virtual bool PostExecute
(
UPCGDataBinding* InBinding |
Return true when all done. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
virtual bool PrepareForExecute_GameThread
(
UPCGDataBinding* InBinding |
Called prior to GetRenderProxy and execution. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
virtual void ReleaseTransientResources
(
const TCHAR* InReason |
Release any handles to transient resources like GPU buffers. | Compute/DataInterfaces/PCGComputeDataInterface.h | |
void SetProducerSettings
(
const UPCGSettings* InSettings |
Compute/DataInterfaces/PCGComputeDataInterface.h |
Overridden from UComputeDataProvider
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
const UComputeDataInterface* InDataInterface, |
Compute/DataInterfaces/PCGComputeDataInterface.h | ||
virtual void Reset() |
Compute/DataInterfaces/PCGComputeDataInterface.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void NotifyProducerUploadedData
(
UPCGDataBinding* InBinding |
Compute/DataInterfaces/PCGComputeDataInterface.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
Compute/DataInterfaces/PCGComputeDataInterface.h |