UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDistanceFieldAsyncQueue Class Reference

#include <DistanceFieldAtlas.h>

+ Inheritance diagram for FDistanceFieldAsyncQueue:

Public Member Functions

ENGINE_API FDistanceFieldAsyncQueue ()
 
virtual ENGINE_API ~FDistanceFieldAsyncQueue ()
 
ENGINE_API void AddTask (FAsyncDistanceFieldTask *Task)
 
ENGINE_API void CancelBuild (UStaticMesh *StaticMesh)
 
ENGINE_API void CancelBuilds (const TSet< UStaticMesh * > &InStaticMeshes)
 
ENGINE_API void CancelAllOutstandingBuilds ()
 
ENGINE_API void BlockUntilBuildComplete (UStaticMesh *StaticMesh, bool bWarnIfBlocked)
 
ENGINE_API void BlockUntilAllBuildsComplete ()
 
ENGINE_API void ProcessAsyncTasks (bool bLimitExecutionTime=false) override
 
ENGINE_API void Shutdown () override
 
int32 GetNumOutstandingTasks () const
 

Static Public Member Functions

static ENGINE_API FName GetStaticAssetTypeName ()
 

Detailed Description

Class that manages asynchronous building of mesh distance fields.

Constructor & Destructor Documentation

◆ FDistanceFieldAsyncQueue()

FDistanceFieldAsyncQueue::FDistanceFieldAsyncQueue ( )

◆ ~FDistanceFieldAsyncQueue()

FDistanceFieldAsyncQueue::~FDistanceFieldAsyncQueue ( )
virtual

Member Function Documentation

◆ AddTask()

void FDistanceFieldAsyncQueue::AddTask ( FAsyncDistanceFieldTask Task)

Adds a new build task. (Thread-Safe)

◆ BlockUntilAllBuildsComplete()

void FDistanceFieldAsyncQueue::BlockUntilAllBuildsComplete ( )

Blocks the main thread until all async builds complete.

◆ BlockUntilBuildComplete()

void FDistanceFieldAsyncQueue::BlockUntilBuildComplete ( UStaticMesh StaticMesh,
bool  bWarnIfBlocked 
)

Blocks the main thread until the async build of the specified mesh is complete.

◆ CancelAllOutstandingBuilds()

void FDistanceFieldAsyncQueue::CancelAllOutstandingBuilds ( )

Blocks the main thread until the async build are either canceled or completed.

◆ CancelBuild()

void FDistanceFieldAsyncQueue::CancelBuild ( UStaticMesh StaticMesh)

Cancel the build on this specific static mesh or block until it is completed if already started.

◆ CancelBuilds()

void FDistanceFieldAsyncQueue::CancelBuilds ( const TSet< UStaticMesh * > &  InStaticMeshes)

Cancel the build on these meshes or block until they are completed if already started.

◆ GetNumOutstandingTasks()

int32 FDistanceFieldAsyncQueue::GetNumOutstandingTasks ( ) const
inline

◆ GetStaticAssetTypeName()

FName FDistanceFieldAsyncQueue::GetStaticAssetTypeName ( )
static

Get the name of the asset type this compiler handles

◆ ProcessAsyncTasks()

void FDistanceFieldAsyncQueue::ProcessAsyncTasks ( bool  bLimitExecutionTime = false)
overridevirtual

Called once per frame, fetches completed tasks and applies them to the scene.

Implements IAssetCompilingManager.

◆ Shutdown()

void FDistanceFieldAsyncQueue::Shutdown ( )
overridevirtual

Blocks until it is safe to shut down (worker threads are idle).

Implements IAssetCompilingManager.


The documentation for this class was generated from the following files: