FAtomThread Class Reference

#include <AtomThread.h>

Static Public Member Functions
static CRIWARECORE_API FString	GetCurrentAtomThreadStatId ()
static CRIWARECORE_API void	GetLongestTaskInfo (FString &OutLongestTask, double &OutLongestTaskTimeMs)
static CRIWARECORE_API bool	IsUsingThreadedAtom ()
static CRIWARECORE_API void	ProcessAllCommands ()
static CRIWARECORE_API void	ResetAtomThreadTimers ()
static CRIWARECORE_API void	ResumeAtomThread ()
static CRIWARECORE_API void	RunCommandOnAtomThread (TUniqueFunction< void()> InFunction, const TStatId InStatId=TStatId())
static CRIWARECORE_API void	RunCommandOnGameThread (TUniqueFunction< void()> InFunction, const TStatId InStatId=TStatId())
static CRIWARECORE_API void	SetUseThreadedAtom (bool bInUseThreadedAtom)
static CRIWARECORE_API void	StartAtomThread ()
static CRIWARECORE_API void	StopAtomThread ()
static CRIWARECORE_API void	SuspendAtomThread ()

Static Private Member Functions
static TUniqueFunction< void()>	GetCommandWrapper (TUniqueFunction< void()> InFunction, const TStatId InStatId)
static double	GetCurrentLongestTime ()
static void	SetCurrentAtomThreadStatId (TStatId InStatId)
static void	SetLongestTimeAndId (TStatId NewLongestId, double LongestTimeMsec)

Static Private Attributes
static bool	bUseThreadedAtom = false
static TStatId	CurrentAtomThreadStatId
static FCriticalSection	CurrentAtomThreadStatIdCS
static TStatId	LongestAtomThreadStatId
static double	LongestAtomThreadTimeMsec = 0.0
static FDelegateHandle	PostGC
static FDelegateHandle	PostGCDestroy
static FDelegateHandle	PreGC
static FDelegateHandle	PreGCDestroy
static TUniquePtr< UE::Tasks::FTaskEvent >	ResumeEvent
static int32	SuspendCount { 0 }

Member Function Documentation

GetCommandWrapper()

TUniqueFunction< void()> FAtomThread::GetCommandWrapper ( TUniqueFunction< void()> InFunction, const TStatId InStatId )

staticprivate

GetCurrentAtomThreadStatId()

FString FAtomThread::GetCurrentAtomThreadStatId ( )

static

Retrieves the current atom thread stat id. Useful for reporting when an atom thread command stalls or deadlocks.

GetCurrentLongestTime()

double FAtomThread::GetCurrentLongestTime ( )

inlinestaticprivate

GetLongestTaskInfo()

void FAtomThread::GetLongestTaskInfo ( FString & OutLongestTask, double & OutLongestTaskTimeMs )

static

IsUsingThreadedAtom()

bool FAtomThread::IsUsingThreadedAtom ( )

static

ProcessAllCommands()

void FAtomThread::ProcessAllCommands ( )

static

Processes all enqueued atom thread commands.

ResetAtomThreadTimers()

void FAtomThread::ResetAtomThreadTimers ( )

static

ResumeAtomThread()

void FAtomThread::ResumeAtomThread ( )

static

RunCommandOnAtomThread()

void FAtomThread::RunCommandOnAtomThread ( TUniqueFunction< void()> InFunction, const TStatId InStatId = TStatId() )

static

Execute a command on the atom thread. If it's safe the command will execute immediately.

RunCommandOnGameThread()

void FAtomThread::RunCommandOnGameThread ( TUniqueFunction< void()> InFunction, const TStatId InStatId = TStatId() )

static

Execute a (presumably atom) command on the game thread. If GIsAtomThreadRunning is false the command will execute immediately

SetCurrentAtomThreadStatId()

void FAtomThread::SetCurrentAtomThreadStatId ( TStatId InStatId )

staticprivate

Sets the current atom thread stat id.

SetLongestTimeAndId()

void FAtomThread::SetLongestTimeAndId ( TStatId NewLongestId, double LongestTimeMsec )

staticprivate

SetUseThreadedAtom()

void FAtomThread::SetUseThreadedAtom ( bool bInUseThreadedAtom )

static

StartAtomThread()

void FAtomThread::StartAtomThread ( )

static

Starts the atom thread.

StopAtomThread()

void FAtomThread::StopAtomThread ( )

static

Stops the atom thread.

SuspendAtomThread()

void FAtomThread::SuspendAtomThread ( )

static

Member Data Documentation

bUseThreadedAtom

bool FAtomThread::bUseThreadedAtom = false

staticprivate

Whether to run with an atom thread

CurrentAtomThreadStatId

TStatId FAtomThread::CurrentAtomThreadStatId

staticprivate

Stat id of the currently executing atom thread command.

CurrentAtomThreadStatIdCS

FCriticalSection FAtomThread::CurrentAtomThreadStatIdCS

staticprivate

LongestAtomThreadStatId

TStatId FAtomThread::LongestAtomThreadStatId

staticprivate

LongestAtomThreadTimeMsec

double FAtomThread::LongestAtomThreadTimeMsec = 0.0

staticprivate

PostGC

FDelegateHandle FAtomThread::PostGC

staticprivate

PostGCDestroy

FDelegateHandle FAtomThread::PostGCDestroy

staticprivate

PreGC

FDelegateHandle FAtomThread::PreGC

staticprivate

PreGCDestroy

FDelegateHandle FAtomThread::PreGCDestroy

staticprivate

ResumeEvent

TUniquePtr< UE::Tasks::FTaskEvent > FAtomThread::ResumeEvent

staticprivate

SuspendCount

int32 FAtomThread::SuspendCount { 0 }

staticprivate

---

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

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomThread.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomThread.cpp