FDistanceFieldAsyncQueue

Class that manages asynchronous building of mesh distance fields.

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FDistanceFieldAsyncQueue

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/DistanceFieldAtlas.h

Include

#include "DistanceFieldAtlas.h"

Syntax

class FDistanceFieldAsyncQueue : public FGCObject

Remarks

Class that manages asynchronous building of mesh distance fields.

Constructors

Name Description

Public function

FDistanceFieldAsyncQueue()

Destructors

Name Description

Public function Virtual

~FDistanceFieldAsyncQueue()

Functions

Name Description

Public function

void

 

AddTask

(
    FAsyncDistanceFieldTask* Task
)

Adds a new build task. (Thread-Safe)

Public function

void

 

BlockUntilAllBuildsComplete()

Blocks the main thread until all async builds complete.

Public function

void

 

BlockUntilBuildComplete

(
    UStaticMesh* StaticMesh,
    bool bWarnIfBlocked
)

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

Public function Const

int32

 

GetNumOutstandingTasks()

Public function

void

 

ProcessAsyncTasks()

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

Public function

void

 

Shutdown()

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

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Exposes UObject references used by the async build.

Public function Virtual Const

FString

 

GetReferencerName()

Returns name of class for reference tracking

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss