#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "HAL/PlatformTLS.h"
#include "Logging/LogMacros.h"
#include "Misc/Build.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/OutputDevice.h"
#include "ProfilingDebugging/CpuProfilerTrace.h"
#include "Templates/Atomic.h"
#include "UObject/NameTypes.h"
#include <atomic>

Classes
struct	FScopedBootTiming

struct	FEngineTrackedActivityScope

struct	FCoreTexts

struct	FUELibraryOverrideSettings

struct	UE::Private::FScopeDisableRunningCookCommandlet

class	FIsDuplicatingClassForReinstancing

class	FTaskTagScope

struct	FScopedLoadingState

Namespaces
namespace	UE

namespace	UE::Private

namespace	UE::CoreUObject

namespace	UE::CoreUObject::Private

namespace	UE::Core

Enumerations
enum class	ELoaderType : uint8 { NotInitialized , LegacyLoader , EditorPackageLoader , ZenLoader }

enum class	ETaskTag : int32 { ENone = 0 << 0 , EStaticInit = 1 << 0 , EGameThread = 1 << 1 , ESlateThread = 1 << 2 , UE_DEPRECATED =(5.0, "AudioThread was removed and ETaskTag::EAudioThread is not used anymore. Please remove it.") = 1 << 3 , ERenderingThread = 1 << 4 , ERhiThread = 1 << 5 , EAsyncLoadingThread = 1 << 6 , EEventThread = 1 << 7 , ENamedThreadBits = (EEventThread << 1) - 1 , EParallelThread = 1 << 30 , EWorkerThread = 1 << 29 \| EParallelThread , EParallelRenderingThread = ERenderingThread \| EParallelThread , EParallelGameThread = EGameThread \| EParallelThread , EParallelRhiThread = ERhiThread \| EParallelThread , EParallelLoadingThread = EAsyncLoadingThread \| EParallelThread }

Functions
CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogHAL, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogSerialization, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogUnrealMath, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogUnrealMatrix, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogContentComparisonCommandlet, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogNetPackageMap, Warning, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogNetSerialization, Warning, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogMemory, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogProfilingDebugging, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogCore, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogOutputDevice, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogSHA, Warning, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogStats, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogStreaming, Display, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogInit, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogExit, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogExec, Warning, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogScript, Warning, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogLocalization, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogLongPackageNames, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogProcess, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogLoad, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogVirtualization, Log, All)

CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogTemp, Log, All)

CORE_API FOutputDeviceRedirector *	GetGlobalLogSingleton ()

CORE_API void	BootTimingPoint (const ANSICHAR *Message)

CORE_API void	DumpBootTiming ()

FORCEINLINE bool	IsRunningCommandlet ()

FORCEINLINE bool	IsRunningCookCommandlet ()

FORCEINLINE bool	IsRunningDLCCookCommandlet ()

FORCEINLINE UClass *	GetRunningCommandletClass ()

CORE_API FString	GetCommandletNameFromCmdline ()

FORCEINLINE bool	IsAllowCommandletRendering ()

FORCEINLINE bool	IsAllowCommandletAudio ()

int32	UE::GetMultiprocessId ()

void	UE::Private::SetMultiprocessId (int32 MultiprocessId)

CORE_API	TSAN_ATOMIC (bool) GIsCriticalError

CORE_API bool	IsEngineStartupModuleLoadingComplete ()

CORE_API void	SetEngineStartupModuleLoadingComplete ()

	UE_DEPRECATED (4.24, "Please use IsEngineExitRequested()/RequestEngineExit(const FString&)") extern CORE_API bool GIsRequestingExit

CORE_API void	BeginExitIfRequested ()

FORCEINLINE bool	IsEngineExitRequested ()

CORE_API void	RequestEngineExit (const TCHAR *ReasonString)

CORE_API void	RequestEngineExit (const FString &ReasonString)

CORE_API const TCHAR *	LexToString (ELoaderType Type)

bool	UE::GetIsEditorLoadingPackage ()

void	UE::SetIsEditorLoadingPackage (bool InValue)

int32	UE::GetPlayInEditorID ()

void	UE::SetPlayInEditorID (int32 InPlayInEditorID)

	UE_DEPRECATED (4.25, "This variable is no longer set. Use !GEditor->GetPlayInEditorSessionInfo()->OriginalRequestParams.HasPlayWorldPlacement() instead.") extern CORE_API bool GIsPIEUsingPlayerStart

CORE_API	TSAN_ATOMIC (ELogTimes::Type) GPrintLogTimes

	ENUM_CLASS_FLAGS (ETaskTag)

class UE_DEPRECATED(5.6, "Use FTaskTagScope instead which is now always optional by default.") FOptionalTaskTagScope CORE_API void	EnsureRetrievingVTablePtrDuringCtor (const TCHAR *CtorSignature)

CORE_API bool	IsInGameThread ()

CORE_API bool	IsInParallelGameThread ()

CORE_API bool	IsInParallelLoadingThread ()

CORE_API bool	IsInWorkerThread ()

CORE_API bool	IsAudioThreadRunning ()

CORE_API bool	IsInAudioThread ()

CORE_API bool	IsInSlateThread ()

CORE_API bool	IsInRenderingThread ()

CORE_API bool	IsInParallelRenderingThread ()

CORE_API bool	IsInAnyRenderingThread ()

CORE_API bool	IsInActualRenderingThread ()

CORE_API bool	IsInActualLoadingThread ()

CORE_API bool	IsRHIThreadRunning ()

CORE_API bool	IsInRHIThread ()

CORE_API bool	IsInParallelRHIThread ()

CORE_API void	NotifyLoadingStateChanged (bool bState, const TCHAR *Message)

bool CORE_API	GetEmitDrawEvents ()

void CORE_API	SetEmitDrawEvents (bool EmitDrawEvents)

bool CORE_API	IsRunningCookOnTheFly ()

bool	UE::IsUsingZenPakFileStreaming ()

CORE_API FORCENOINLINE bool	IsThisNotNull (const void This, const ANSICHAR Function)

bool	UE::IsGCLocked ()

void	UE::Private::SetIsGCLockedFunction (bool(*InIsGCLockedFuncPtr)())

Variables
CORE_API FConfigCacheIni *	GConfig

CORE_API ITransaction *	GUndo

CORE_API FOutputDeviceConsole *	GLogConsole

CORE_API class FOutputDeviceError *	GError

CORE_API class FFeedbackContext *	GWarn

CORE_API TCHAR	GErrorHist [16384]

CORE_API TCHAR	GErrorExceptionDescription [4096]

CORE_API const FText	GTrue

CORE_API const FText	GFalse

CORE_API const FText	GYes

CORE_API const FText	GNo

CORE_API const FText	GNone

CORE_API bool	GIsGameAgnosticExe

CORE_API bool	GForceLoadEditorOnly
	IS_MONOLITHIC \|\| !UE_EDITOR.

CORE_API bool	GVerifyObjectReferencesOnly

CORE_API bool	GFastPathUniqueNameGeneration

CORE_API bool	GAllowActorScriptExecutionInEditor

CORE_API bool	GCompilingBlueprint

CORE_API bool	GIsGCingAfterBlueprintCompile

CORE_API bool	GIsReconstructingBlueprintInstances

CORE_API std::atomic< bool >	GIsReinstancing

CORE_API void(*	GFlushStreamingFunc )(void)

CORE_API FUELibraryOverrideSettings	GUELibraryOverrideSettings

CORE_API bool	GIsRunningUnattendedScript

CORE_API bool	GEdSelectionLock

CORE_API bool	GIsClient

CORE_API bool	GIsServer

CORE_API FIsDuplicatingClassForReinstancing	GIsDuplicatingClassForReinstancing

CORE_API bool	GIsBuildMachine

CORE_API bool	GIsSilent

CORE_API bool	GIsSlowTask

CORE_API bool	GSlowTaskOccurred

CORE_API bool	GIsGuarded

CORE_API bool	GAreScreenMessagesEnabled

CORE_API bool	GScreenMessagesRestoreState

CORE_API int32	GIsDumpingMovie

CORE_API bool	GIsHighResScreenshot

CORE_API uint32	GScreenshotResolutionX

CORE_API uint32	GScreenshotResolutionY

CORE_API uint64	GMakeCacheIDIndex

CORE_API FString	GEngineIni

CORE_API FString	GEditorLayoutIni

CORE_API FString	GEditorKeyBindingsIni

CORE_API FString	GEditorSettingsIni

CORE_API FString	GEditorIni

CORE_API FString	GEditorPerProjectIni

CORE_API FString	GCompatIni

CORE_API FString	GLightmassIni

CORE_API FString	GScalabilityIni

CORE_API FString	GHardwareIni

CORE_API FString	GInputIni

CORE_API FString	GGameIni

CORE_API FString	GGameUserSettingsIni

CORE_API FString	GRuntimeOptionsIni

CORE_API FString	GInstallBundleIni

CORE_API FString	GDeviceProfilesIni

CORE_API FString	GGameplayTagsIni

CORE_API float	GNearClippingPlane

CORE_API float	GNearClippingPlane_RenderThread

CORE_API bool	GExitPurge

CORE_API TCHAR	GInternalProjectName [64]

CORE_API const TCHAR *	GForeignEngineDir

CORE_API FExec *	GDebugToolExec

CORE_API bool(*	IsAsyncLoading )()

CORE_API void(*	SuspendAsyncLoading )()

CORE_API void(*	ResumeAsyncLoading )()

CORE_API bool(*	IsAsyncLoadingSuspended )()

CORE_API bool(*	IsAsyncLoadingMultithreaded )()

CORE_API ELoaderType(*	GetLoaderType )()

CORE_API void(*	SuspendTextureStreamingRenderTasks )()

CORE_API void(*	ResumeTextureStreamingRenderTasks )()

CORE_API bool	GIsCookerLoadingPackage

CORE_API bool	GIsPlayInEditorWorld

CORE_API bool	GPlatformNeedsPowerOfTwoTextures

CORE_API double	GStartTime

CORE_API FString	GSystemStartTime

CORE_API bool	GIsInitialLoad

CORE_API bool	GEventDrivenLoaderEnabled

CORE_API bool	GIsRetrievingVTablePtr

CORE_API uint64	GFrameCounter

CORE_API uint64	GFrameCounterRenderThread

CORE_API uint64	GLastGCFrame

CORE_API uint64	GInputTime

CORE_API uint32	GFrameNumber

CORE_API uint32	GFrameNumberRenderThread

CORE_API bool	GIsFirstInstance

CORE_API float	GHitchThresholdMS

CORE_API int32	GSavingCompressionChunkSize

CORE_API uint32	GGameThreadId

CORE_API uint32	GRenderThreadId

CORE_API uint32	GSlateLoadingThreadId

CORE_API bool	GIsGameThreadIdInitialized

CORE_API FLazyName	GCurrentTraceName

CORE_API int32	GCycleStatsShouldEmitNamedEvents

CORE_API bool	GShouldEmitVerboseNamedEvents

CORE_API bool	GIsDemoMode

CORE_API FLazyName	GLongCorePackageName

CORE_API FLazyName	GLongCoreUObjectPackageName

CORE_API bool	GIsAutomationTesting

CORE_API bool	GPumpingMessagesOutsideOfMainLoop

CORE_API bool	GPumpingMessages

CORE_API bool	GEnableVREditorHacks

CORE_API bool	GIgnoreDebugger

CORE_API bool(*	IsInAsyncLoadingThread )()

CORE_API FRunnableThread *	GRenderingThread

CORE_API bool	GIsRunningRHIInSeparateThread_InternalUseOnly

CORE_API bool	GIsRunningRHIInDedicatedThread_InternalUseOnly

CORE_API bool	GIsRunningRHIInTaskThread_InternalUseOnly

CORE_API FChunkedFixedUObjectArray *	GCoreObjectArrayForDebugVisualizers

CORE_API UE::CoreUObject::Private::FStoredObjectPathDebug *	GCoreComplexObjectPathDebug

CORE_API UE::CoreUObject::Private::FObjectHandlePackageDebugData *	GCoreObjectHandlePackageDebug

CORE_API UE::Core::FVisualizerDebuggingState *	GCoreDebuggingState

Macro Definition Documentation

◆ DECLARE_LOG_CATEGORY_EXTERN_HELPER

#define DECLARE_LOG_CATEGORY_EXTERN_HELPER	(	A,
		B,
		C
	)	DECLARE_LOG_CATEGORY_EXTERN(A,B,C)

◆ GFirstFrameIntraFrameDebugging

#define GFirstFrameIntraFrameDebugging false

◆ GIntraFrameDebuggingGameThread

#define GIntraFrameDebuggingGameThread false

Examples: /work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GIsEditor

#define GIsEditor false

◆ GLog

#define GLog GetGlobalLogSingleton()

◆ SCOPED_BOOT_TIMING

#define SCOPED_BOOT_TIMING ( x ) TRACE_CPUPROFILER_EVENT_SCOPE_STR(x); FScopedBootTiming ANONYMOUS_VARIABLE(BootTiming_)(x);

◆ UE_SCOPED_ENGINE_ACTIVITY

#define UE_SCOPED_ENGINE_ACTIVITY	(	Fmt,
		...
	)	FEngineTrackedActivityScope ANONYMOUS_VARIABLE(EngineActivity_)(Fmt, ## __VA_ARGS__);

◆ UE_SET_REQUEST_EXIT_ON_TICK_ONLY

#define UE_SET_REQUEST_EXIT_ON_TICK_ONLY 0

Set this to true to only allow setting RequestingExit at the start of the Engine tick This will remove the chance for undefined behaviour when setting RequestExit

This needs to proved out on all platforms/use cases before this can moved to default

Enumeration Type Documentation

◆ ELoaderType

enum class ELoaderType : uint8

strong

Enumerator
NotInitialized
LegacyLoader
EditorPackageLoader
ZenLoader

◆ ETaskTag

enum class ETaskTag : int32

strong

Enumerator
ENone
EStaticInit
EGameThread
ESlateThread
UE_DEPRECATED
ERenderingThread
ERhiThread
EAsyncLoadingThread
EEventThread
ENamedThreadBits
EParallelThread
EWorkerThread
EParallelRenderingThread
EParallelGameThread
EParallelRhiThread
EParallelLoadingThread

Function Documentation

◆ BeginExitIfRequested()

CORE_API void BeginExitIfRequested ( )

extern

This will check if a RequestExit has come in, if it has will set GIsRequestingExit.

◆ BootTimingPoint()

CORE_API void BootTimingPoint ( const ANSICHAR * Message )

◆ DECLARE_LOG_CATEGORY_EXTERN() [1/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogContentComparisonCommandlet	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [2/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogCore	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [3/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogExec	,
		Warning	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [4/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogExit	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [5/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogHAL	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [6/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogInit	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [7/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogLoad	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [8/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogLocalization	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [9/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogLongPackageNames	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [10/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogMemory	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [11/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogNetPackageMap	,
		Warning	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [12/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogNetSerialization	,
		Warning	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [13/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogOutputDevice	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [14/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogProcess	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [15/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogProfilingDebugging	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [16/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogScript	,
		Warning	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [17/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogSerialization	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [18/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogSHA	,
		Warning	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [19/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogStats	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [20/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogStreaming	,
		Display	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [21/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogTemp	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [22/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogUnrealMath	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [23/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogUnrealMatrix	,
		Log	,
		All
	)

◆ DECLARE_LOG_CATEGORY_EXTERN() [24/24]

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogVirtualization	,
		Log	,
		All
	)

◆ DumpBootTiming()

CORE_API void DumpBootTiming ( )

◆ EnsureRetrievingVTablePtrDuringCtor()

class UE_DEPRECATED(5.6, "Use FTaskTagScope instead which is now always optional by default.") FOptionalTaskTagScope CORE_API void EnsureRetrievingVTablePtrDuringCtor ( const TCHAR * CtorSignature )

This class can be used to Tag an execution context but only in case it has not already been tagged It is usually used for the IsInRendering/GamethreadFunctions.

Parameters

CtorSignature	InTag the Tag to use Ensures that current thread is during retrieval of vtable ptr of some UClass.
CtorSignature	The signature of the ctor currently running to construct proper error message.

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( ETaskTag )

◆ GetCommandletNameFromCmdline()

CORE_API FString GetCommandletNameFromCmdline ( )

Returns the name of the commandlet that was set on the command line by the arg '-Run=<CommandletName>'.

This should be used by code that needs to know the commandlet name early on during engine startup, before the commandlet has been initialized. If possible, code should prefer calling GetRunningCommandletClass()->GetName() instead.

Returns: The name of the commandlet that will end up running. If there is no commandlet then an empty string will be returned.

◆ GetEmitDrawEvents()

bool CORE_API GetEmitDrawEvents ( )

◆ GetGlobalLogSingleton()

CORE_API FOutputDeviceRedirector * GetGlobalLogSingleton ( )

◆ GetRunningCommandletClass()

FORCEINLINE UClass * GetRunningCommandletClass ( )

Returns the UClass of the currently running commandlet.

◆ IsAllowCommandletAudio()

FORCEINLINE bool IsAllowCommandletAudio ( )

◆ IsAllowCommandletRendering()

FORCEINLINE bool IsAllowCommandletRendering ( )

Check to see if we should initialise RHI and set up scene for rendering even when running a commandlet.

◆ IsAudioThreadRunning()

CORE_API bool IsAudioThreadRunning ( )

extern

◆ IsEngineExitRequested()

FORCEINLINE bool IsEngineExitRequested ( )

◆ IsEngineStartupModuleLoadingComplete()

CORE_API bool IsEngineStartupModuleLoadingComplete ( )

extern

Returns true after all initial modules have finished all of their loading phases during Engine startup: Corresponds to the event FCoreDelegates::OnAllModuleLoadingPhasesComplete

◆ IsInActualLoadingThread()

CORE_API bool IsInActualLoadingThread ( )

extern

Returns: True only if called from the async loading thread if it's enabled.

◆ IsInActualRenderingThread()

CORE_API bool IsInActualRenderingThread ( )

extern

Returns: True if called from the rendering thread.

◆ IsInAnyRenderingThread()

CORE_API bool IsInAnyRenderingThread ( )

extern

Returns: True if called from any of the rendering thread. Can be called from any thread without asserting.

◆ IsInAudioThread()

CORE_API bool IsInAudioThread ( )

extern

Returns: True if called from the audio thread, and not merely a thread calling audio functions.

◆ IsInGameThread()

CORE_API bool IsInGameThread ( )

extern

Returns: True if called from the game thread.

◆ IsInParallelGameThread()

CORE_API bool IsInParallelGameThread ( )

extern

Returns: True if called from the game thread in a parallel for.

◆ IsInParallelLoadingThread()

CORE_API bool IsInParallelLoadingThread ( )

extern

Returns: True if called from a parallel loading thread task.

◆ IsInParallelRenderingThread()

CORE_API bool IsInParallelRenderingThread ( )

extern

Returns: True if called from the rendering thread, or if called from ANY thread that isn't the game thread, except that during single threaded rendering the game thread is ok too.

◆ IsInParallelRHIThread()

CORE_API bool IsInParallelRHIThread ( )

extern

Returns: True if called from a thread tagged as an RHI task.

◆ IsInRenderingThread()

CORE_API bool IsInRenderingThread ( )

extern

Returns: True if called from the rendering thread, or if called from ANY thread during single threaded rendering

◆ IsInRHIThread()

CORE_API bool IsInRHIThread ( )

extern

Returns: True if called from the RHI thread, or if called from ANY thread during single threaded rendering

◆ IsInSlateThread()

CORE_API bool IsInSlateThread ( )

extern

Returns: True if called from the slate thread, and not merely a thread calling slate functions.

◆ IsInWorkerThread()

CORE_API bool IsInWorkerThread ( )

extern

Returns: True if called from a worker thread.

◆ IsRHIThreadRunning()

CORE_API bool IsRHIThreadRunning ( )

extern

Returns: True if RHI thread is running

◆ IsRunningCommandlet()

FORCEINLINE bool IsRunningCommandlet ( )

Check to see if this executable is running a commandlet (custom command-line processing code in an editor-like environment)

◆ IsRunningCookCommandlet()

FORCEINLINE bool IsRunningCookCommandlet ( )

Check to see if this executable is running the cookcommandlet

◆ IsRunningCookOnTheFly()

bool CORE_API IsRunningCookOnTheFly ( )

Returns: True if running cook-on-the-fly.

◆ IsRunningDLCCookCommandlet()

FORCEINLINE bool IsRunningDLCCookCommandlet ( )

Check to see if this executable is running the cookcommandlet

◆ IsThisNotNull()

CORE_API FORCENOINLINE bool IsThisNotNull	(	const void *	This,
		const ANSICHAR *	Function
	)

◆ LexToString()

CORE_API const TCHAR * LexToString ( ELoaderType Type )

◆ NotifyLoadingStateChanged()

CORE_API void NotifyLoadingStateChanged	(	bool	bState,
		const TCHAR *	Message
	)

Boot loading timers

◆ RequestEngineExit() [1/2]

CORE_API void RequestEngineExit ( const FString & ReasonString )

◆ RequestEngineExit() [2/2]

CORE_API void RequestEngineExit ( const TCHAR * ReasonString )

◆ SetEmitDrawEvents()

void CORE_API SetEmitDrawEvents ( bool EmitDrawEvents )

◆ SetEngineStartupModuleLoadingComplete()

CORE_API void SetEngineStartupModuleLoadingComplete ( )

extern

◆ TSAN_ATOMIC() [1/2]

CORE_API TSAN_ATOMIC ( bool )

extern

How to print the category in log output.

How to print the verbosity in log output.

◆ TSAN_ATOMIC() [2/2]

CORE_API TSAN_ATOMIC ( ELogTimes::Type )

extern

How to print the time in log output.

◆ UE_DEPRECATED() [1/2]

UE_DEPRECATED	(	4.	24,
		"Please use IsEngineExitRequested()/RequestEngineExit(const FString&)"
	)

◆ UE_DEPRECATED() [2/2]

UE_DEPRECATED	(	4.	25,
		"This variable is no longer set. Use !GEditor->GetPlayInEditorSessionInfo()->OriginalRequestParams.HasPlayWorldPlacement() instead."
	)

Whether or not PIE was attempting to play from PlayerStart

Variable Documentation

◆ GAllowActorScriptExecutionInEditor

CORE_API bool GAllowActorScriptExecutionInEditor

extern

allow AActor object to execute script in the editor from specific entry points, such as when running a construction script

◆ GAreScreenMessagesEnabled

CORE_API bool GAreScreenMessagesEnabled

extern

Global value indicating on-screen warnings/message should be displayed. Disabled via console command "DISABLEALLSCREENMESSAGES" Enabled via console command "ENABLEALLSCREENMESSAGES" Toggled via console command "TOGGLEALLSCREENMESSAGES"

Archive for serializing arbitrary data to and from memory

◆ GCompatIni

CORE_API FString GCompatIni

extern

◆ GCompilingBlueprint

CORE_API bool GCompilingBlueprint

extern

Forces use of template names for newly instanced components in a CDO.

Forces use of template names for newly instanced components in a CDO

◆ GConfig

CORE_API FConfigCacheIni* GConfig

extern

◆ GCoreComplexObjectPathDebug

CORE_API UE::CoreUObject::Private::FStoredObjectPathDebug* GCoreComplexObjectPathDebug

extern

◆ GCoreDebuggingState

CORE_API UE::Core::FVisualizerDebuggingState* GCoreDebuggingState

extern

◆ GCoreObjectArrayForDebugVisualizers

CORE_API FChunkedFixedUObjectArray* GCoreObjectArrayForDebugVisualizers

extern

◆ GCoreObjectHandlePackageDebug

CORE_API UE::CoreUObject::Private::FObjectHandlePackageDebugData* GCoreObjectHandlePackageDebug

extern

◆ GCurrentTraceName

CORE_API FLazyName GCurrentTraceName

extern

Determines what kind of trace should occur, NAME_None for none.

◆ GCycleStatsShouldEmitNamedEvents

CORE_API int32 GCycleStatsShouldEmitNamedEvents

extern

Whether stats should emit named events for e.g. PIX.

◆ GDebugToolExec

CORE_API FExec* GDebugToolExec

extern

Exec handler for game debugging tool, allowing commands like "editactor"

Exec handler for game debugging tool, allowing commands like "editactor", ...

◆ GDeviceProfilesIni

CORE_API FString GDeviceProfilesIni

extern

◆ GEditorIni

CORE_API FString GEditorIni

extern

Editor per-project ini files - stored per project.

Editor ini file locations - stored per engine version (shared across all projects). Migrated between versions on first run.

◆ GEditorKeyBindingsIni

CORE_API FString GEditorKeyBindingsIni

extern

◆ GEditorLayoutIni

CORE_API FString GEditorLayoutIni

extern

Editor ini file locations - stored per engine version (shared across all projects). Migrated between versions on first run.

◆ GEditorPerProjectIni

CORE_API FString GEditorPerProjectIni

extern

Editor per-project ini files - stored per project.

◆ GEditorSettingsIni

CORE_API FString GEditorSettingsIni

extern

◆ GEdSelectionLock

CORE_API bool GEdSelectionLock

extern

◆ GEnableVREditorHacks

CORE_API bool GEnableVREditorHacks

extern

Enables various editor and HMD hacks that allow the experimental VR editor feature to work, perhaps at the expense of other systems

◆ GEngineIni

CORE_API FString GEngineIni

extern

◆ GError

CORE_API class FOutputDeviceError* GError

extern

Critical errors.

◆ GErrorExceptionDescription

CORE_API TCHAR GErrorExceptionDescription[4096]

extern

For building exception description text dump in guard/unguard mechanism.

◆ GErrorHist

CORE_API TCHAR GErrorHist[16384]

extern

For building call stack text dump in guard/unguard mechanism.

◆ GetLoaderType

CORE_API ELoaderType(* GetLoaderType) () ( )

extern

Returns the type of the currently active loader, if any.

◆ GEventDrivenLoaderEnabled

CORE_API bool GEventDrivenLoaderEnabled

extern

◆ GExitPurge

CORE_API bool GExitPurge

extern

◆ GFalse

CORE_API const FText GFalse

extern

◆ GFastPathUniqueNameGeneration

CORE_API bool GFastPathUniqueNameGeneration

extern

when constructing objects, use the fast path on consoles...

◆ GFlushStreamingFunc

CORE_API void(* GFlushStreamingFunc) (void) ( void )

extern

Helper function to flush resource streaming.

◆ GForceLoadEditorOnly

CORE_API bool GForceLoadEditorOnly

extern

IS_MONOLITHIC || !UE_EDITOR.

When saving out of the game, this override allows the game to load editor only properties.

When saving out of the game, this override allows the game to load editor only properties

◆ GForeignEngineDir

CORE_API const TCHAR* GForeignEngineDir

extern

◆ GFrameCounter

CORE_API uint64 GFrameCounter

extern

Steadily increasing frame counter.

◆ GFrameCounterRenderThread

CORE_API uint64 GFrameCounterRenderThread

extern

◆ GFrameNumber

CORE_API uint32 GFrameNumber

extern

Incremented once per frame before the scene is being rendered. In split screen mode this is incremented once for all views (not for each view).

◆ GFrameNumberRenderThread

CORE_API uint32 GFrameNumberRenderThread

extern

NEED TO RENAME, for RT version of GFrameTime use View.ViewFamily->FrameNumber or pass down from RT from GFrameTime).

◆ GGameIni

CORE_API FString GGameIni

extern

◆ GGameplayTagsIni

CORE_API FString GGameplayTagsIni

extern

◆ GGameThreadId

CORE_API uint32 GGameThreadId

extern

Thread ID of the main/game thread

◆ GGameUserSettingsIni

CORE_API FString GGameUserSettingsIni

extern

◆ GHardwareIni

CORE_API FString GHardwareIni

extern

◆ GHitchThresholdMS

CORE_API float GHitchThresholdMS

extern

Threshold for a frame to be considered a hitch (in milliseconds).

◆ GIgnoreDebugger

CORE_API bool GIgnoreDebugger

extern

Whether we should ignore the attached debugger.

◆ GInputIni

CORE_API FString GInputIni

extern

◆ GInputTime

CORE_API uint64 GInputTime

extern

The time input was sampled, in cycles.

◆ GInstallBundleIni

CORE_API FString GInstallBundleIni

extern

◆ GInternalProjectName

CORE_API TCHAR GInternalProjectName[64]

extern

Game name, used for base game directory and ini among other things

◆ GIsAutomationTesting

CORE_API bool GIsAutomationTesting

extern

Whether or not a unit test is currently being run.

Whether or not a unit test is currently being run

◆ GIsBuildMachine

CORE_API bool GIsBuildMachine

extern

These are set when the engine first starts up. This specifies whether the engine was launched as a build machine process.

This specifies whether the engine was launched as a build machine process

◆ GIsClient

CORE_API bool GIsClient

extern

◆ GIsCookerLoadingPackage

CORE_API bool GIsCookerLoadingPackage

extern

Whether the cooker is currently loading a package or not

◆ GIsDemoMode

CORE_API bool GIsDemoMode

extern

Disables some warnings and minor features that would interrupt a demo presentation

◆ GIsDumpingMovie

CORE_API int32 GIsDumpingMovie

extern

◆ GIsDuplicatingClassForReinstancing

CORE_API FIsDuplicatingClassForReinstancing GIsDuplicatingClassForReinstancing

extern

◆ GIsFirstInstance

CORE_API bool GIsFirstInstance

extern

Whether we are the first instance of the game running.

◆ GIsGameAgnosticExe

CORE_API bool GIsGameAgnosticExe

extern

If true, this executable is able to run all games (which are loaded as DLL's).

If true, this executable is able to run all games (which are loaded as DLL's)

◆ GIsGameThreadIdInitialized

CORE_API bool GIsGameThreadIdInitialized

extern

Has GGameThreadId been set yet?

◆ GIsGCingAfterBlueprintCompile

CORE_API bool GIsGCingAfterBlueprintCompile

extern

True if we're garbage collecting after a blueprint compilation

◆ GIsGuarded

CORE_API bool GIsGuarded

extern

◆ GIsHighResScreenshot

CORE_API bool GIsHighResScreenshot

extern

◆ GIsInitialLoad

CORE_API bool GIsInitialLoad

extern

Whether we are still in the initial loading process.

Whether we are still in the initial loading proces.

◆ GIsPlayInEditorWorld

CORE_API bool GIsPlayInEditorWorld

extern

Whether GWorld should point to the play in editor world.

Warning: There are times when GIsPlayInEditorWorld == true and GWorld == nullptr! Notably during LoadMap during PIE, which can happen when PIE initiates a Browse to another level.

◆ GIsReconstructingBlueprintInstances

CORE_API bool GIsReconstructingBlueprintInstances

extern

True if we're reconstructing blueprint instances. Should never be true on cooked builds

◆ GIsReinstancing

CORE_API std::atomic<bool> GIsReinstancing

extern

True if actors and objects are being re-instanced.

◆ GIsRetrievingVTablePtr

CORE_API bool GIsRetrievingVTablePtr

extern

true when we are retrieving VTablePtr from UClass

◆ GIsRunningRHIInDedicatedThread_InternalUseOnly

CORE_API bool GIsRunningRHIInDedicatedThread_InternalUseOnly

extern

◆ GIsRunningRHIInSeparateThread_InternalUseOnly

CORE_API bool GIsRunningRHIInSeparateThread_InternalUseOnly

extern

◆ GIsRunningRHIInTaskThread_InternalUseOnly

CORE_API bool GIsRunningRHIInTaskThread_InternalUseOnly

extern

◆ GIsRunningUnattendedScript

CORE_API bool GIsRunningUnattendedScript

extern

If true, we are running an editor script that should not prompt any dialog modal. The default value of any model will be used. This is used when running an editor utility blueprint or script like Python and we don't want an OK dialog to pop while the script is running. Could be set for commandlet with -RUNNINGUNATTENDEDSCRIPT

◆ GIsServer

CORE_API bool GIsServer

extern

◆ GIsSilent

CORE_API bool GIsSilent

extern

This determines if we should output any log text. If Yes then no log text should be emitted.

◆ GIsSlowTask

CORE_API bool GIsSlowTask

extern

◆ GLastGCFrame

CORE_API uint64 GLastGCFrame

extern

GFrameCounter the last time GC was run.

◆ GLightmassIni

CORE_API FString GLightmassIni

extern

◆ GLogConsole

CORE_API FOutputDeviceConsole* GLogConsole

extern

◆ GLongCorePackageName

CORE_API FLazyName GLongCorePackageName

extern

Name of the core package.

◆ GLongCoreUObjectPackageName

CORE_API FLazyName GLongCoreUObjectPackageName

extern

◆ GMakeCacheIDIndex

CORE_API uint64 GMakeCacheIDIndex

extern

◆ GNearClippingPlane

CORE_API float GNearClippingPlane

extern

◆ GNearClippingPlane_RenderThread

CORE_API float GNearClippingPlane_RenderThread

extern

◆ GNo

CORE_API const FText GNo

extern

◆ GNone

CORE_API const FText GNone

extern

◆ GPlatformNeedsPowerOfTwoTextures

CORE_API bool GPlatformNeedsPowerOfTwoTextures

extern

true if the runtime needs textures to be powers of two

◆ GPumpingMessages

CORE_API bool GPumpingMessages

extern

Whether or not messages are being pumped

◆ GPumpingMessagesOutsideOfMainLoop

CORE_API bool GPumpingMessagesOutsideOfMainLoop

extern

Whether or not messages are being pumped outside of main loop

Whether or not messages are being pumped outside of the main loop

◆ GRenderingThread

CORE_API FRunnableThread* GRenderingThread

extern

Thread used for rendering

◆ GRenderThreadId

CORE_API uint32 GRenderThreadId

extern

Thread ID of the render thread, if any

◆ GRuntimeOptionsIni

CORE_API FString GRuntimeOptionsIni

extern

◆ GSavingCompressionChunkSize

CORE_API int32 GSavingCompressionChunkSize

extern

Size to break up data into when saving compressed data

◆ GScalabilityIni

CORE_API FString GScalabilityIni

extern

◆ GScreenMessagesRestoreState

CORE_API bool GScreenMessagesRestoreState

extern

◆ GScreenshotResolutionX

CORE_API uint32 GScreenshotResolutionX

extern

◆ GScreenshotResolutionY

CORE_API uint32 GScreenshotResolutionY

extern

◆ GShouldEmitVerboseNamedEvents

CORE_API bool GShouldEmitVerboseNamedEvents

extern

Whether verbose stats should be also generate external profiler named events. Thread sleep/wait stats or extremely high frequency cycle counting stats are disabled by default. Has no effect if GCycleStatsShouldEmitNamedEvents is 0.

◆ GSlateLoadingThreadId

CORE_API uint32 GSlateLoadingThreadId

extern

Thread ID of the slate thread, if any

◆ GSlowTaskOccurred

CORE_API bool GSlowTaskOccurred

extern

◆ GStartTime

CORE_API double GStartTime

extern

Time at which FPlatformTime::Seconds() was first initialized (very early on)

Time at which FPlatformTime::Seconds() was first initialized (before main)

◆ GSystemStartTime

CORE_API FString GSystemStartTime

extern

System time at engine init.

◆ GTrue

CORE_API const FText GTrue

extern

◆ GUELibraryOverrideSettings

CORE_API FUELibraryOverrideSettings GUELibraryOverrideSettings

extern

Settings for when using UE as a library

◆ GUndo

CORE_API ITransaction* GUndo

extern

◆ GVerifyObjectReferencesOnly

CORE_API bool GVerifyObjectReferencesOnly

extern

Disable loading of objects not contained within script files; used during script compilation

◆ GWarn

CORE_API class FFeedbackContext* GWarn

extern

◆ GYes

CORE_API const FText GYes

extern

◆ IsAsyncLoading

CORE_API bool(* IsAsyncLoading) () ( )

extern

Whether we're currently in the async loading code path or not

◆ IsAsyncLoadingMultithreaded

CORE_API bool(* IsAsyncLoadingMultithreaded) () ( )

extern

Returns true if async loading is using the async loading thread

◆ IsAsyncLoadingSuspended

CORE_API bool(* IsAsyncLoadingSuspended) () ( )

extern

Suspends async package loading.

◆ IsInAsyncLoadingThread

CORE_API bool(* IsInAsyncLoadingThread) () ( )

extern

Returns: True if called from the async loading thread if it's enabled, otherwise if called from game thread while is async loading code.

◆ ResumeAsyncLoading

CORE_API void(* ResumeAsyncLoading) () ( )

extern

Resumes async package loading.

◆ ResumeTextureStreamingRenderTasks

CORE_API void(* ResumeTextureStreamingRenderTasks) () ( )

extern

Resume texture updates caused by completed async IOs.

◆ SuspendAsyncLoading

CORE_API void(* SuspendAsyncLoading) () ( )

extern

Suspends async package loading.

◆ SuspendTextureStreamingRenderTasks

CORE_API void(* SuspendTextureStreamingRenderTasks) () ( )

extern

Suspends texture updates caused by completed async IOs.

Macros
#define	DECLARE_LOG_CATEGORY_EXTERN_HELPER(A, B, C) DECLARE_LOG_CATEGORY_EXTERN(A,B,C)

#define	SCOPED_BOOT_TIMING(x) TRACE_CPUPROFILER_EVENT_SCOPE_STR(x); FScopedBootTiming ANONYMOUS_VARIABLE(BootTiming_)(x);

#define	UE_SCOPED_ENGINE_ACTIVITY(Fmt, ...) FEngineTrackedActivityScope ANONYMOUS_VARIABLE(EngineActivity_)(Fmt, ## __VA_ARGS__);

#define	GLog GetGlobalLogSingleton()

#define	GIsEditor false

#define	GIntraFrameDebuggingGameThread false

#define	GFirstFrameIntraFrameDebugging false

#define	UE_SET_REQUEST_EXIT_ON_TICK_ONLY 0

Classes

Namespaces

Macros

Enumerations

Functions

Variables

Macro Definition Documentation

◆ DECLARE_LOG_CATEGORY_EXTERN_HELPER

◆ GFirstFrameIntraFrameDebugging

◆ GIntraFrameDebuggingGameThread

◆ GIsEditor

◆ GLog

◆ SCOPED_BOOT_TIMING

◆ UE_SCOPED_ENGINE_ACTIVITY

◆ UE_SET_REQUEST_EXIT_ON_TICK_ONLY

Enumeration Type Documentation

◆ ELoaderType

◆ ETaskTag

Function Documentation

◆ BeginExitIfRequested()

◆ BootTimingPoint()

◆ DECLARE_LOG_CATEGORY_EXTERN() [1/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [2/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [3/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [4/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [5/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [6/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [7/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [8/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [9/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [10/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [11/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [12/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [13/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [14/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [15/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [16/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [17/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [18/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [19/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [20/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [21/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [22/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [23/24]

◆ DECLARE_LOG_CATEGORY_EXTERN() [24/24]

◆ DumpBootTiming()

◆ EnsureRetrievingVTablePtrDuringCtor()

◆ ENUM_CLASS_FLAGS()

◆ GetCommandletNameFromCmdline()

◆ GetEmitDrawEvents()

◆ GetGlobalLogSingleton()

◆ GetRunningCommandletClass()

◆ IsAllowCommandletAudio()

◆ IsAllowCommandletRendering()

◆ IsAudioThreadRunning()

◆ IsEngineExitRequested()

◆ IsEngineStartupModuleLoadingComplete()

◆ IsInActualLoadingThread()

◆ IsInActualRenderingThread()

◆ IsInAnyRenderingThread()

◆ IsInAudioThread()

◆ IsInGameThread()

◆ IsInParallelGameThread()

◆ IsInParallelLoadingThread()

◆ IsInParallelRenderingThread()

◆ IsInParallelRHIThread()

◆ IsInRenderingThread()

◆ IsInRHIThread()

◆ IsInSlateThread()

◆ IsInWorkerThread()

◆ IsRHIThreadRunning()

◆ IsRunningCommandlet()

◆ IsRunningCookCommandlet()

◆ IsRunningCookOnTheFly()

◆ IsRunningDLCCookCommandlet()

◆ IsThisNotNull()

◆ LexToString()

◆ NotifyLoadingStateChanged()

◆ RequestEngineExit() [1/2]

◆ RequestEngineExit() [2/2]