UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ParallelForImpl Namespace Reference

Functions

template<typename FunctionType , typename ContextType >
void CallBody (const FunctionType &Body, const TArrayView< ContextType > &Contexts, int32 TaskIndex, int32 Index)
 
template<typename FunctionType >
void CallBody (const FunctionType &Body, const TArrayView< TYPE_OF_NULLPTR > &, int32, int32 Index)
 
int32 GetNumberOfThreadTasks (int32 Num, int32 MinBatchSize, EParallelForFlags Flags)
 
template<typename BodyType , typename PreWorkType , typename ContextType >
void ParallelForInternal (const TCHAR *DebugName, int32 Num, int32 MinBatchSize, BodyType Body, PreWorkType CurrentThreadWorkToDoBeforeHelping, EParallelForFlags Flags, const TArrayView< ContextType > &Contexts)
 

Function Documentation

◆ CallBody() [1/2]

template<typename FunctionType , typename ContextType >
void ParallelForImpl::CallBody ( const FunctionType &  Body,
const TArrayView< ContextType > &  Contexts,
int32  TaskIndex,
int32  Index 
)
inline

◆ CallBody() [2/2]

template<typename FunctionType >
void ParallelForImpl::CallBody ( const FunctionType &  Body,
const TArrayView< TYPE_OF_NULLPTR > &  ,
int32  ,
int32  Index 
)
inline

◆ GetNumberOfThreadTasks()

int32 ParallelForImpl::GetNumberOfThreadTasks ( int32  Num,
int32  MinBatchSize,
EParallelForFlags  Flags 
)
inline

◆ ParallelForInternal()

template<typename BodyType , typename PreWorkType , typename ContextType >
void ParallelForImpl::ParallelForInternal ( const TCHAR DebugName,
int32  Num,
int32  MinBatchSize,
BodyType  Body,
PreWorkType  CurrentThreadWorkToDoBeforeHelping,
EParallelForFlags  Flags,
const TArrayView< ContextType > &  Contexts 
)
inline

General purpose parallel for that uses the taskgraph

Parameters
DebugName;Debugname and Profiling TraceTag
Num;number of calls of Body; Body(0), Body(1)....Body(Num - 1)
MinBatchSize;Minimum size a Batch should have
Body;Function to call from multiple threads
CurrentThreadWorkToDoBeforeHelping;The work is performed on the main thread before it starts helping with the ParallelFor proper
Flags;Used to customize the behavior of the ParallelFor if needed.
Contexts;Optional per thread contexts to accumulate data concurrently. Notes: Please add stats around to calls to parallel for and within your lambda as appropriate. Do not clog the task graph with long running tasks or tasks that block.