FPCGGraphExecutionInspection

API > API/Plugins > API/Plugins/PCG

   
Name FPCGGraphExecutionInspection
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/PCGGraphExecutionInspection.h
Include Path #include "PCGGraphExecutionInspection.h"

Syntax

class FPCGGraphExecutionInspection

Structs

Name Remarks
FNodeExecutedNotificationData Retrieves the executed nodes information

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ExecutedStacksGeneration uint64   PCGGraphExecutionInspection.h  
InspectionCache TMap< FPCGStack, TSharedPtr< FPCGDataCollection > >   PCGGraphExecutionInspection.h  
InspectionCacheLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
InspectionCounter int32   PCGGraphExecutionInspection.h  
NodeToStacksInWhichNodeExecuted TMap< TObjectKey< const UPCGNode >, TSet< FNodeExecutedNotificationData > > Map from nodes to all stacks for which a task for the node was executed. PCGGraphExecutionInspection.h  
NodeToStacksInWhichNodeExecutedLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
NodeToStacksThatProducedData TMap< TObjectKey< const UPCGNode >, TSet< FPCGStack > > Map from nodes to all stacks for which the node produced at least one data item. PCGGraphExecutionInspection.h  
NodeToStacksThatProducedDataLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
NodeToStacksTriggeringGPUReadbacks TMap< TObjectKey< const UPCGNode >, TSet< FPCGStack > >   PCGGraphExecutionInspection.h  
NodeToStacksTriggeringGPUTransfersLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
NodeToStacksTriggeringGPUUploads TMap< TObjectKey< const UPCGNode >, TSet< FPCGStack > > Map from nodes to all stacks for which GPU data transfers occurred. PCGGraphExecutionInspection.h  
NodeToStacksWithOverridesApplied TMap< TObjectKey< const UPCGNode >, TSet< FPCGStack > > Map from nodes to all stacks for which data overrides were applied. PCGGraphExecutionInspection.h  
NodeToStacksWithOverridesAppliedLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
NodeToStackToInactivePinMask TMap< TObjectKey< const UPCGNode >, TMap< const FPCGStack, uint64 > > Map from nodes to stacks to mask of output pins that were deactivated during execution. PCGGraphExecutionInspection.h  
NodeToStackToInactivePinMaskLock PCG::FSharedLock   PCGGraphExecutionInspection.h  
ResolvedDeltas TMap< FPCGSourceDataStorageKey, TArray< FPCGDeltaKey > > Resolved deltas tracked during ApplyDataOverrides. PCGGraphExecutionInspection.h  
ResolvedDeltasLock PCG::FSharedLock   PCGGraphExecutionInspection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

   PCGGraphExecutionInspection.h  

void ClearExecutedNodeData()

 Clears per-node execution data. Called by the profiling log after reading in non-editor builds. PCGGraphExecutionInspection.h  

void ClearInspectionData ( bool bClearPerNodeExecutionData
)

   PCGGraphExecutionInspection.h  

bool DidNodeTriggerCPUToGPUUpload ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

   PCGGraphExecutionInspection.h  

bool DidNodeTriggerGPUToCPUReadback ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

   PCGGraphExecutionInspection.h  

void DisableInspection()

   PCGGraphExecutionInspection.h  

void EnableInspection()

   PCGGraphExecutionInspection.h  

void ForEachExecutedNodeStack ( const UPCGNode* InNode,
TFunctionRef< void(const TSet< FNodeExecutedNotificationData >&)> Callback
) const

 Iterates executed node stacks set for a specific node. PCGGraphExecutionInspection.h  

void ForEachExecutedNodeStack ( TFunctionRef< bool(const UPCGNode*, const TSet< FNodeExecutedNotificationData >&)> Callback
) const

 Iterates executed node stacks. Callback returns false to stop iteration. PCGGraphExecutionInspection.h  
Returns all executed node stacks. Note that this is a heavy operation. PCGGraphExecutionInspection.h  
Returns all executed node stacks associated to the given node. PCGGraphExecutionInspection.h  

uint64 GetExecutedStacksGeneration()

 Monotonic counter bumped whenever the execution stacks map mutates. PCGGraphExecutionInspection.h  

const FPCGDataCollection * GetInspectionData ( const FPCGStack& InStack
) const

   PCGGraphExecutionInspection.h  
If found, the inspection data is returned as a garbage collection visible object (FGCObject). PCGGraphExecutionInspection.h  

uint64 GetNodeInactivePinMask ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Retrieve the inactive pin bitmask for the given node and stack in the last execution. PCGGraphExecutionInspection.h  

bool HasNodeProducedData ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Did the given node produce one or more data items in the given stack during the last execution. PCGGraphExecutionInspection.h  

bool InspectData ( const FPCGStack& InStack,
TFunctionRef< void(const FPCGDataCollection&)> InspectFunc
) const

 Data is only valid inside the function call. PCGGraphExecutionInspection.h  

bool IsDeltaResolved ( const FPCGSourceDataStorageKey& InStorageKey,
const FPCGDeltaKey& InDeltaKey
) const

 Returns true if the given delta resolved during the last execution. PCGGraphExecutionInspection.h  

bool IsInspecting()

   PCGGraphExecutionInspection.h  

bool NodeAppliedDataOverrides ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Returns true if the given node had data overrides applied during the last execution. PCGGraphExecutionInspection.h  

void NotifyCPUToGPUUpload ( const UPCGNode* InNode,
const FPCGStack* InStack
) const

   PCGGraphExecutionInspection.h  

void NotifyDataOverridesApplied ( const UPCGNode* InNode,
const FPCGStack* InStack
) const

 Called at execution time when data overrides have been applied to a node's data. PCGGraphExecutionInspection.h  

void NotifyDeltasResolved ( const FPCGSourceDataStorageKey& InStorageKey,
TArray< FPCGDeltaKey >&& InResolvedDeltas
) const

 Replaces the set of resolved deltas by storage key. PCGGraphExecutionInspection.h  

void NotifyGPUToCPUReadback ( const UPCGNode* InNode,
const FPCGStack* InStack
) const

   PCGGraphExecutionInspection.h  

void NotifyNodeDynamicInactivePins ( const UPCGNode* InNode,
const FPCGStack* InStack,
uint64 InactivePinBitmask
) const

 Whether the given node was culled by a dynamic branch in the given stack. PCGGraphExecutionInspection.h  

void NotifyNodeExecuted ( const UPCGNode* InNode,
const FPCGStack* InStack,
const PCGUtils::FCallTime* InTimer,
bool bNodeUsedCache
)

 Called at execution time each time a node has been executed. PCGGraphExecutionInspection.h  

void StoreInspectionData ( const FPCGStack* InStack,
const UPCGNode* InNode,
const PCGUtils::FCallTime* InTimer,
const FPCGDataCollection& InInputData,
const FPCGDataCollection& InOutputData,
bool bUsedCache
)

   PCGGraphExecutionInspection.h  

bool WasNodeExecuted ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Whether a task for the given node and stack was executed during the last execution. PCGGraphExecutionInspection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page