FDistanceFieldAsyncQueue

Class that manages asynchronous building of mesh distance fields.

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FDistanceFieldAsyncQueue

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.

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.

References

Module

Engine

Header

Runtime/Engine/Public/DistanceFieldAtlas.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback