1. Epic GamesDeveloper
  3. FPCGAsyncState

FPCGAsyncState

Helper class to gather information about asynchronus execution. Will be held in the PCGContext.

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Helpers

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/Helpers/PCGAsyncState.h
Include #include "Helpers/PCGAsyncState.h"

Syntax

struct FPCGAsyncState

Remarks

Helper class to gather information about asynchronus execution. Will be held in the PCGContext.

Variables

  Type Name Description
Public variable int32 AsyncCurrentReadIndex  
Public variable int32 AsyncCurrentWriteIndex For async process, keep track of where the write processing is in output data.
Public variable bool bIsOutOfTickBudgetSet True if out of tick buddget was set
Public variable bool bIsRunningAsyncCall True if currently inside a PCGAsync scope - will prevent further async processing.
Public variable bool bIsRunningOnMainThread For multithreading, track if the current element is run on the main thread.
Public variable bool bIsRunningOutOfTick True if we can run out of tick
Public variable bool bStarted Keep information if the async has started or not.
Public variable TMap< int32, int32 > ChunkToNumElementsWrittenMap Map between the processed chunks but not yet processed and the number of elements written for that chunk.
Public variable int32 CurrentChunkToCollapse Keep track of the current chunk we need to collapse. Important to collapse in order.
Public variable PRAGMA_ENABLE_DEPRECATION_WARNINGS double EndTime For timeslicing, it will be set by the graph executor to know when we should stop.
Public variable int32 NumAvailableTasks How many tasks are available to run async.
Public variable TArray< TTuple< int32, int32 > > TasksChunksStartEnd List of the current chunk and last chunk a given task have to process.

Constructors

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS Deprecating a property requires to have deprecation warning disable for the default copy ctor...
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Reset ()

 To be called at the end of an async processing.
Public function Const bool Returns true if we reached end time.

Operators

  Type Name Description
Public function FPCGAsyncState &  
Public function FPCGAsyncState &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page