Navigation
API > API/Plugins > API/Plugins/PCG
Description
A Helper for generic parallel loops, with support for timeslicing. This version only uses indexes allowing more flexible usage to process any data format.
This version also does not support removing elements and is expects a 1:1 mapping. This just removes some lambdas required to support that use case.
Work will be separated in chunks, that will be processed in parallel. Main thread will then collapse incoming data from async tasks. Will use AsyncState.ShouldStop() to stop execution if timeslicing is enabled. Important info:
- We will finish to process and collapse data for all data already in process, even if we need to stop. To mitigate this, try to use small chunk sizes.
- To avoid infinite loops (when we should stop even before starting working), we will at least process 1 chunk of data per thread.
- To have async tasks, you need to have at least 3 available threads (main thread + 2 futures). Otherwise, we will only process on the main thread, without collapse.
| Name | FPCGAsync::AsyncProcessingOneToOneEx |
| Type | function |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Helpers/PCGAsync.h |
| Include Path | #include "Helpers/PCGAsync.h" |
namespace FPCGAsync
{
template<typename InitializeFunc, typename ProcessElementFunc>
bool FPCGAsync::AsyncProcessingOneToOneEx
(
FPCGAsyncState * AsyncState,
int32 NumIterations,
InitializeFunc && Initialize,
ProcessElementFunc && ProcessElement,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
const bool bAllowChunkSizeOverride
)
}
true if the processing is done, false otherwise. Use this to know if you need to reschedule the task.
Parameters
| Name | Remarks |
|---|---|
| AsyncState | The context containing the information about how many tasks we can launch, async read/write index for the current job and a function to know if we need to stop processing. |
| NumIterations | The number of calls that will be done to the provided function, also an upper bound on the number of data generated. |
| Initialize | Signature: void(). A function that will be called once on the first timeslice, where you can reserve data. |
| ProcessElement | Signature: bool(int32 ReadIndex, int32 WriteIndex). A function that processes |
| bEnableTimeSlicing | If false, we will not stop until all the processing is done. |
| ChunkSize | Size of the chunks to cut the input data with |
| bAllowChunkSizeOverride | If true, ChunkSize can be overridden by 'pcg.AsyncOverrideChunkSize' CVar |