Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGDataBinding |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Compute/PCGDataBinding.h |
| Include Path | #include "Compute/PCGDataBinding.h" |
Syntax
UCLASS (MinimalAPI, Transient, Category=PCG)
class UPCGDataBinding : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGDataBinding
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGraphAttributeIndexAndSourceBuffer | TPair< int32, TRefCountPtr< FRDGPooledBuffer > > | Compute/PCGDataBinding.h | |
| FSourceBufferAndAttributeIndex | TPair< TSharedPtr< const FPCGProxyForGPUDataCollection >, int32 > | Compute/PCGDataBinding.h | |
| FSourceBufferAndStringKey | TPair< TRefCountPtr< FRDGPooledBuffer >, int32 > | Compute/PCGDataBinding.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttributeTable | FPCGKernelAttributeTable | All attributes present in graph at execution time. | Compute/PCGDataBinding.h | |
| bIsDataDescriptionCachePrimed | std::atomic< bool > | Compute/PCGDataBinding.h | ||
| bTablesInitialized | std::atomic< bool > | Compute/PCGDataBinding.h | ||
| CompletedMeshSpawners | TArray< TObjectPtr< const UComputeKernel > > | Compute/PCGDataBinding.h | ||
| ContextHandle | TWeakPtr< FPCGContextHandle > | Compute/PCGDataBinding.h | ||
| DataDescriptionCache | TMap< int32, TSharedPtr< const FPCGDataCollectionDesc > > | Cache of data descriptions to amortize cost of computing them at runtime. | Compute/PCGDataBinding.h | |
| DataToDebug | TArray< FPCGDataToDebug > | Compute/PCGDataBinding.h | ||
| DataToInspect | TArray< FPCGDataToDebug > | Compute/PCGDataBinding.h | ||
| Graph | TObjectPtr< const UPCGComputeGraph > | Compute/PCGDataBinding.h | ||
| GraphAttributeToSourceBufferAttributeIndex | TMap< FGraphAttributeIndexAndSourceBuffer, int32 > | Map from this-graph attribute index and upstream source buffer to upstream attribute index. | Compute/PCGDataBinding.h | |
| GraphToSourceBufferStringKey | TMap< FSourceBufferAndStringKey, int32 > | Map from string key value in source buffer to the key value usable in this graph. | Compute/PCGDataBinding.h | |
| InputDataCollection | FPCGDataCollection | Data arriving on compute graph element. | Compute/PCGDataBinding.h | |
| KernelParamsCache | FPCGKernelParamsCache | Cache of overridden settings/values per-kernel, built during compute graph execution. | Compute/PCGDataBinding.h | |
| MeshSpawnersToPrimitives | TMap< TObjectPtr< const UComputeKernel >, FPCGSpawnerPrimitives > | Compute/PCGDataBinding.h | ||
| OutputDataCollection | FPCGDataCollection | Compute graph element output data. | Compute/PCGDataBinding.h | |
| SourceBufferAttributeToGraphAttributeIndex | TMap< FSourceBufferAndAttributeIndex, int32 > | Map from source buffer and source buffer attribute index to this-graph attribute index. | Compute/PCGDataBinding.h | |
| SourceBufferToGraphStringKey | TMap< FSourceBufferAndStringKey, int32 > | Map from string key value in graph to the key value for this string in the source buffer. | Compute/PCGDataBinding.h | |
| StringTable | TArray< FString > | Compute/PCGDataBinding.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddCompletedMeshSpawnerKernel
(
TObjectPtr< const UComputeKernel > InCompletedMeshSpawnerKernel |
Compute/PCGDataBinding.h | ||
void AddMeshSpawnerPrimitives
(
TObjectPtr< const UComputeKernel > InMeshSpawnerKernel, |
Compute/PCGDataBinding.h | ||
void AddMeshSpawnerPrimitives
(
TObjectPtr< const UComputeKernel > InMeshSpawnerKernel, |
Compute/PCGDataBinding.h | ||
TSharedPtr< const FPCGDataCollectionDesc > ComputeKernelBindingDataDesc
(
int32 InGraphBindingIndex |
Compute/PCGDataBinding.h | ||
TSharedPtr< const FPCGDataCollectionDesc > ComputeKernelPinDataDesc
(
const FPCGKernelPin& InKernelPin |
Computes a description of data for a single pin in the compute graph and caches it. | Compute/PCGDataBinding.h | |
void DebugLogDataDescriptions() |
Compute/PCGDataBinding.h | ||
FPCGSpawnerPrimitives * FindMeshSpawnerPrimitives
(
TObjectPtr< const UComputeKernel > InMeshSpawnerKernel |
Compute/PCGDataBinding.h | ||
FPCGSpawnerPrimitives & FindOrAddMeshSpawnerPrimitives
(
TObjectPtr< const UComputeKernel > InMeshSpawnerKernel |
Compute/PCGDataBinding.h | ||
int32 GetAttributeId
(
const FPCGKernelAttributeKey& InAttribute |
Compute/PCGDataBinding.h | ||
int32 GetAttributeId
(
FPCGAttributeIdentifier InIdentifier, |
Compute/PCGDataBinding.h | ||
int32 GetAttributeTableSize() |
Compute/PCGDataBinding.h | ||
const FPCGKernelParams * GetCachedKernelParams
(
const UPCGComputeKernel* InKernel |
Look up the cached parameter struct for a kernel. | Compute/PCGDataBinding.h | |
const FPCGKernelParams * GetCachedKernelParams
(
int32 InKernelIndex |
Compute/PCGDataBinding.h | ||
TSharedPtr< const FPCGDataCollectionDesc > GetCachedKernelPinDataDesc
(
int32 InGraphBindingIndex |
Compute/PCGDataBinding.h | ||
TSharedPtr< const FPCGDataCollectionDesc > GetCachedKernelPinDataDesc
(
const UPCGComputeKernel* InKernel, |
Get description of data produced by a pin. | Compute/PCGDataBinding.h | |
const UPCGComputeGraph * GetComputeGraph() |
Compute/PCGDataBinding.h | ||
TWeakPtr< FPCGContextHandle > GetContextHandle() |
Compute/PCGDataBinding.h | ||
TArray< FPCGDataToDebug > & GetDataToDebugMutable() |
Compute/PCGDataBinding.h | ||
TArray< FPCGDataToDebug > & GetDataToInspectMutable() |
Compute/PCGDataBinding.h | ||
IPCGGraphExecutionSource * GetExecutionSource() |
Compute/PCGDataBinding.h | ||
int32 GetFirstInputDataIndex
(
const UPCGComputeKernel* InKernel, |
Helper to get index in input data collection of the first data item for the given kernel and input pin label. | Compute/PCGDataBinding.h | |
const TMap< FGraphAttributeIndexAndSourceBuffer, int32 > & GetGraphAttributeToSourceBufferAttributeIndex() |
Get map from this-graph attribute index and upstream source buffer to upstream attribute index. | Compute/PCGDataBinding.h | |
const TMap< FSourceBufferAndStringKey, int32 > & GetGraphToSourceBufferStringKey() |
Map from string key value in source buffer to the key value usable in this graph. | Compute/PCGDataBinding.h | |
const FPCGDataCollection & GetInputDataCollection() |
Compute/PCGDataBinding.h | ||
FPCGDataCollection & GetInputDataCollectionMutable() |
Compute/PCGDataBinding.h | ||
const FPCGDataCollection & GetOutputDataCollection() |
Compute/PCGDataBinding.h | ||
TArray< int32 > GetPinInputDataIndices
(
const UPCGComputeKernel* InKernel, |
Returns indices of data in the input data collection arriving on the given kernel pin. | Compute/PCGDataBinding.h | |
const TMap< FSourceBufferAndAttributeIndex, int32 > & GetSourceBufferAttributeToGraphAttributeIndex() |
Get map from source buffer and source buffer attribute index to this-graph attribute index. | Compute/PCGDataBinding.h | |
const TMap< FSourceBufferAndStringKey, int32 > & GetSourceBufferToGraphStringKey() |
Map from string key value in graph to the key value for this string in the source buffer. | Compute/PCGDataBinding.h | |
| Get the set of all unique strings entering the compute graph. | Compute/PCGDataBinding.h | ||
void Initialize
(
const UPCGComputeGraph* InComputeGraph, |
Pre-initialization, set up pointers and store input data. | Compute/PCGDataBinding.h | |
bool InitializeKernelParams
(
FPCGContext* InContext |
Initialize the kernel params cache. | Compute/PCGDataBinding.h | |
void InitializeTables
(
FPCGContext* InContext |
Initialization look up tables from input data. | Compute/PCGDataBinding.h | |
bool IsDataDescriptionCachePrimed() |
Compute/PCGDataBinding.h | ||
bool IsMeshSpawnerKernelComplete
(
TObjectPtr< const UComputeKernel > InMeshSpawnerKernel |
Compute/PCGDataBinding.h | ||
void PrimeDataDescriptionCache() |
Computes a description of data for every pin in the compute graph and caches it. | Compute/PCGDataBinding.h | |
bool ReadbackInputDataToCPU
(
int32 InInputDataIndex |
If there is a GPU proxy at the given index of the input data collection, triggers a readback and replaces the data item with CPU data if readback succeeds. | Compute/PCGDataBinding.h | |
void ReceiveDataFromGPU_GameThread
(
UPCGData* InData, |
Compute/PCGDataBinding.h | ||
void ReceiveDataFromGPU_GameThread
(
UPCGData* InData, |
Compute/PCGDataBinding.h | ||
void ReleaseTransientResources() |
Clear state and release any handles to resources such as GPU buffers. | Compute/PCGDataBinding.h |