Navigation
API > API/Runtime > API/Runtime/Engine
Class that manages asynchronous building of mesh distance fields.
| Name | FDistanceFieldAsyncQueue |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/DistanceFieldAtlas.h |
| Include Path | #include "DistanceFieldAtlas.h" |
Syntax
class FDistanceFieldAsyncQueue : private IAssetCompilingManager
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDistanceFieldAsyncQueue() |
DistanceFieldAtlas.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDistanceFieldAsyncQueue() |
DistanceFieldAtlas.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CompletedTasks | TSet< FAsyncDistanceFieldTask * > | Tasks that have completed processing. | DistanceFieldAtlas.h | |
| CriticalSection | FCriticalSection | DistanceFieldAtlas.h | ||
| FAsyncDistanceFieldTaskWorker | friend | DistanceFieldAtlas.h | ||
| MeshUtilities | std::atomic< class IMeshUtilities * > | DistanceFieldAtlas.h | ||
| Notification | TUniquePtr< FAsyncCompilationNotification > | DistanceFieldAtlas.h | ||
| PendingTasks | TSet< FAsyncDistanceFieldTask * > | Tasks that are waiting on static mesh compilation to proceed | DistanceFieldAtlas.h | |
| PostReachabilityAnalysisHandle | FDelegateHandle | DistanceFieldAtlas.h | ||
| ReferencedTasks | TSet< FAsyncDistanceFieldTask * > | Game-thread managed list of tasks in the async system. | DistanceFieldAtlas.h | |
| ThreadPool | TUniquePtr< FQueuedThreadPool > | DistanceFieldAtlas.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTask
(
FAsyncDistanceFieldTask* Task |
Adds a new build task. (Thread-Safe) | DistanceFieldAtlas.h | |
void BlockUntilAllBuildsComplete() |
Blocks the main thread until all async builds complete. | DistanceFieldAtlas.h | |
void BlockUntilBuildComplete
(
UStaticMesh* StaticMesh, |
Blocks the main thread until the async build of the specified mesh is complete. | DistanceFieldAtlas.h | |
void CancelAllOutstandingBuilds() |
Blocks the main thread until the async build are either canceled or completed. | DistanceFieldAtlas.h | |
void CancelBuild
(
UStaticMesh* StaticMesh |
Cancel the build on this specific static mesh or block until it is completed if already started. | DistanceFieldAtlas.h | |
void CancelBuilds
(
const TSet< UStaticMesh* >& InStaticMeshes |
Cancel the build on these meshes or block until they are completed if already started. | DistanceFieldAtlas.h | |
int32 GetNumOutstandingTasks() |
DistanceFieldAtlas.h |
Overridden from IAssetCompilingManager
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ProcessAsyncTasks
(
bool bLimitExecutionTime |
Called once per frame, fetches completed tasks and applies them to the scene. | DistanceFieldAtlas.h | |
virtual void Shutdown() |
Blocks until it is safe to shut down (worker threads are idle). | DistanceFieldAtlas.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetStaticAssetTypeName() |
Get the name of the asset type this compiler handles | DistanceFieldAtlas.h |