1. Epic GamesDeveloper
  3. Core

Core

API > API/Runtime

Filters

Classes

  Type Name Description
Public struct FCoreTexts    
Public struct FEngineTrackedActivityScope    
Public class FIsDuplicatingClassForReinstancing    
Public class FOptionalTaskTagScope 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.  
Public struct FPixelFormatInfo Information about a pixel format.  
Public class FPlayInEditorID    
Public struct FScopedBootTiming    
Public struct FScopedLoadingState    
Public class FTaskTagScope This class can be used to Tag an execution context aka Thead or Job and allows us to later querry the state when we are in the callstack It is usually used for the IsInRendering/GamethreadFunctions.  
Public struct FUELibraryOverrideSettings The settings used by the UE-as-a-library feature.  

Enums

  Type Name Description
Public enum ELoaderType    
Public enum EPixelFormat    
Public enum EPixelFormatCapabilities    
Public enum EPixelFormatChannelFlags Defines which channel is valid for each pixel format.  
Public enum ETaskTag    

Functions

  Type Name Description
Public function void This will check if a RequestExit has come in, if it has will set GIsRequestingExit.
Public function void

BootTimingPoint ( const ANSICHAR* Message
)

  
Public function void  
Public function void

EnsureRetrievingVTablePtrDuringCtor ( const TCHAR* CtorSignature
)

 Ensures that current thread is during retrieval of vtable ptr of some UClass.
Public function bool  
Public function FOutputDeviceRedirector *  
Public function EPixelFormat

GetPixelFormatFromString ( const TCHAR* InPixelFormatStr
)

 String to enum (not case sensitive) Note this is not the FPixelFormatInfo::Name
Public function const TCHAR * Enum to string Note this is not the FPixelFormatInfo::Name
Public function UClass * Returns running commandlet name
Public function bool  
Public function bool Check to see if we should initialise RHI and set up scene for rendering even when running a commandlet.
Public function bool  
Public function bool  
Public function Static bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool Returns true after all initial modules have finished all of their loading phases during Engine startup: Corresponds to the event FCoreDelegates::OnAllModuleLoadingPhasesComplete
Public function Static bool IsFloatFormat does not include all floating point formats; see also IsHDR.
Public function bool

IsHDR ( EPixelFormat PixelFormat
)

 Unclear what IsHDR is supposed to mean see also IsFloatFormat
Public function bool Unlike IsInRenderingThread, this will always return false if we are running single threaded. It only returns true if this is actually a separate rendering thread. Mostly useful for checks.
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool

IsInteger ( EPixelFormat PixelFormat
)

  
Public function bool  
Public function bool Check to see if this executable is running a commandlet (custom command-line processing code in an editor-like environment)
Public function bool Check to see if this executable is running the cookcommandlet
Public function bool  
Public function bool Check to see if this executable is running the cookcommandlet
Public function bool  
Public function const TCHAR *  
Public function void

NotifyLoadingStateChanged ( bool bState,
const TCHAR* Message
)

 Boot loading timers
Public function bool  
Public function bool  
Public function bool  
Public function EPixelFormatCapabilities  
Public function EPixelFormatChannelFlags  
Public function ETaskTag

operator& ( ETaskTag Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatChannelFlags &  
Public function ETaskTag &

operator&= ( ETaskTag& Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatCapabilities &  
Public function ETaskTag

operator^ ( ETaskTag Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatChannelFlags  
Public function EPixelFormatCapabilities  
Public function ETaskTag &

operator^= ( ETaskTag& Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatChannelFlags &  
Public function EPixelFormatCapabilities &  
Public function ETaskTag

operator| ( ETaskTag Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatChannelFlags  
Public function EPixelFormatCapabilities  
Public function EPixelFormatCapabilities &  
Public function ETaskTag &

operator|= ( ETaskTag& Lhs,
ETaskTag Rhs
)

  
Public function EPixelFormatChannelFlags &  
Public function EPixelFormatCapabilities  
Public function EPixelFormatChannelFlags  
Public function ETaskTag  
Public function void

RequestEngineExit ( const FString& ReasonString
)

  
Public function void

RequestEngineExit ( const TCHAR* ReasonString
)

 Request that the engine exit as soon as it can safely do so The ReasonString is not optional and should be a useful description of why the engine exit is requested
Public function bool  
Public function void

SetEmitDrawEvents ( bool EmitDrawEvents
)

  
Public function void  
Public function bool  

Variables

  Type Name Description
Public variable bool GAllowActorScriptExecutionInEditor Allow AActor object to execute script in the editor from specific entry points, such as when running a construction script
Public variable bool GAreScreenMessagesEnabled Global value indicating on-screen warnings/message should be displayed.
Public variable FString GCompatIni  
Public variable bool GCompilingBlueprint Forces use of template names for newly instanced components in a CDO.
Public variable FConfigCacheIni * GConfig  
Public variable UE::CoreUObject::Private::FStoredObjectPathDebug * GCoreComplexObjectPathDebug  
Public variable FChunkedFixedUObjectArray * GCoreObjectArrayForDebugVisualizers  
Public variable UE::CoreUObject::Private::FObjectHandlePackageDebugData * GCoreObjectHandlePackageDebug  
Public variable FLazyName GCurrentTraceName Determines what kind of trace should occur, NAME_None for none.
Public variable int32 GCycleStatsShouldEmitNamedEvents Whether stats should emit named events for e.g. PIX.
Public variable FExec * GDebugToolExec Exec handler for game debugging tool, allowing commands like "editactor"
Public variable FString GDeviceProfilesIni  
Public variable FString GEditorIni Editor per-project ini files - stored per project.
Public variable FString GEditorKeyBindingsIni  
Public variable FString GEditorLayoutIni Editor ini file locations - stored per engine version (shared across all projects).
Public variable FString GEditorPerProjectIni Editor per-project ini files - stored per project.
Public variable FString GEditorSettingsIni  
Public variable bool GEdSelectionLock  
Public variable bool GEnableVREditorHacks Enables various editor and HMD hacks that allow the experimental VR editor feature to work, perhaps at the expense of other systems
Public variable FString GEngineIni  
Public variable FOutputDeviceError * GError Critical errors.
Public variable TCHAR[4096] GErrorExceptionDescription #crashReport: 2014-08-19 Combine into one, refactor.
Public variable TCHAR[16384] GErrorHist For building call stack text dump in guard/unguard mechanism.
Public variable ELoaderType(*)() GetLoaderType Returns the type of the currently active loader, if any.
Public variable bool GEventDrivenLoaderEnabled Whether we are using the event driven loader
Public variable bool GExitPurge  
Public variable const FText GFalse  
Public variable bool GFastPathUniqueNameGeneration When constructing objects, use the fast path on consoles...
Public variable bool GFirstFrameIntraFrameDebugging True if this is the first time through the UI message pumping loop.
Public variable void(*)(void) GFlushStreamingFunc Helper function to flush resource streaming.

Helper function to flush resource streaming. |

Public variable bool GForceLoadEditorOnly IS_MONOLITHIC   !UE_EDITOR.
Public variable const TCHAR * GForeignEngineDir      
Public variable uint64 GFrameCounter Steadily increasing frame counter.    

Steadily increasing frame counter. |

Public variable uint64 GFrameCounterRenderThread  
Public variable uint32 GFrameNumber Incremented once per frame before the scene is being rendered.
Public variable uint32 GFrameNumberRenderThread NEED TO RENAME, for RT version of GFrameTime use View.ViewFamily->FrameNumber or pass down from RT from GFrameTime).
Public variable FString GGameIni  
Public variable FString GGameplayTagsIni  
Public variable uint32 GGameThreadId Thread ID of the main/game thread

Thread ID of the main/game thread |

Public variable FString GGameUserSettingsIni  
Public variable FString GHardwareIni  
Public variable float GHitchThresholdMS Threshold for a frame to be considered a hitch (in milliseconds).
Public variable bool GIgnoreDebugger Whether we should ignore the attached debugger.
Public variable FString GInputIni  
Public variable uint64 GInputTime The time input was sampled, in cycles.

The time input was sampled, in cycles. |

Public variable FString GInstallBundleIni  
Public variable TCHAR[64] GInternalProjectName Game name, used for base game directory and ini among other things
Public variable bool GIntraFrameDebuggingGameThread Indicates that the game thread is currently paused deep in a call stack, while some subset of the editor user interface is pumped.
Public variable bool GIsAutomationTesting Whether or not a unit test is currently being run.
Public variable bool GIsBuildMachine These are set when the engine first starts up.
Public variable bool GIsClient  
Public variable bool GIsCookerLoadingPackage Whether the cooker is currently loading a package or not
Public variable bool GIsCriticalError  
Public variable bool GIsDemoMode Disables some warnings and minor features that would interrupt a demo presentation
Public variable int32 GIsDumpingMovie Whether we are dumping screen shots
Public variable FIsDuplicatingClassForReinstancing GIsDuplicatingClassForReinstancing  
Public variable bool GIsEditor True if we are in the editor.
Public variable bool GIsEditorLoadingPackage Whether the editor is currently loading a package or not
Public variable bool GIsFirstInstance Whether we are the first instance of the game running.
Public variable bool GIsGameAgnosticExe If true, this executable is able to run all games (which are loaded as DLL's).
Public variable bool GIsGameThreadIdInitialized Has GGameThreadId been set yet?

Has GGameThreadId been set yet? |

Public variable bool GIsGCingAfterBlueprintCompile True if we're garbage collecting after a blueprint compilation
Public variable bool GIsGuarded  
Public variable bool GIsHighResScreenshot  
Public variable bool GIsImportingT3D  
Public variable bool GIsInitialLoad Whether we are still in the initial loading process.
Public variable bool GIsPIEUsingPlayerStart Whether or not PIE was attempting to play from PlayerStart
Public variable bool GIsPlayInEditorWorld Whether GWorld points to the play in editor world
Public variable bool GIsReconstructingBlueprintInstances True if we're reconstructing blueprint instances. Should never be true on cooked builds
Public variable bool GIsReinstancing True if actors and objects are being re-instanced.
Public variable TAtomic< int32 > GIsRenderingThreadSuspended Whether the rendering thread is suspended (not even processing the tickables)
Public variable bool GIsRequestingExit  
Public variable bool GIsRetrievingVTablePtr True when we are retrieving VTablePtr from UClass
Public variable bool GIsRunning  
Public variable bool GIsRunningUnattendedScript If true, we are running an editor script that should not prompt any dialog modal.
Public variable bool GIsServer  
Public variable bool GIsSilent This determines if we should output any log text.
Public variable bool GIsSlowTask  
Public variable bool GIsTransacting  
Public variable uint64 GLastGCFrame GFrameCounter the last time GC was run.
Public variable FString GLightmassIni  
Public variable FOutputDeviceConsole * GLogConsole  
Public variable FLazyName GLongCorePackageName Name of the core package.
Public variable FLazyName GLongCoreUObjectPackageName  
Public variable uint64 GMakeCacheIDIndex  
Public variable float GNearClippingPlane  
Public variable float GNearClippingPlane_RenderThread  
Public variable const FText GNo  
Public variable const FText GNone  
Public variable FPixelFormatInfo[PF_MAX] GPixelFormats  
Public variable bool GPlatformNeedsPowerOfTwoTextures True if the runtime needs textures to be powers of two
Public variable FPlayInEditorID GPlayInEditorID In the editor, this is set to the specific world context PIEInstance that is being currently processed
Public variable bool GPrintLogCategory How to print the category in log output.

How to print the category in log output. |

Public variable ELogTimes::Type GPrintLogTimes How to print the time in log output.

How to print the time in log output |

Public variable bool GPrintLogVerbosity How to print the verbosity in log output.

How to print the verbosity in log output. |

Public variable bool GPumpingMessages Whether or not messages are being pumped
Public variable bool GPumpingMessagesOutsideOfMainLoop Whether or not messages are being pumped outside of main loop
Public variable FRunnableThread * GRenderingThread Thread used for rendering
Public variable uint32 GRenderThreadId Thread ID of the render thread, if any
Public variable FRunnableThread * GRHIThread_InternalUseOnly Thread used for RHI
Public variable uint32 GRHIThreadId Thread ID of the the thread we are executing RHI commands on.
Public variable FString GRuntimeOptionsIni  
Public variable int32 GSavingCompressionChunkSize Size to break up data into when saving compressed data
Public variable FString GScalabilityIni  
Public variable bool GScreenMessagesRestoreState  
Public variable uint32 GScreenshotResolutionX  
Public variable uint32 GScreenshotResolutionY  
Public variable bool GShouldEmitVerboseNamedEvents Whether verbose stats should be also generate external profiler named events.
Public variable bool GShouldSuspendRenderingThread Whether we want the rendering thread to be suspended, used e.g. for tracing.
Public variable uint32 GSlateLoadingThreadId Thread ID of the slate thread, if any
Public variable bool GSlowTaskOccurred  
Public variable double GStartTime Time at which FPlatformTime::Seconds() was first initialized (very early on)
Public variable FString GSystemStartTime System time at engine init.

System time at engine init. |

Public variable const FText GTrue  
Public variable FUELibraryOverrideSettings GUELibraryOverrideSettings Settings for when using UE as a library
Public variable ITransaction * GUndo  
Public variable bool GVerifyObjectReferencesOnly Disable loading of objects not contained within script files; used during script compilation
Public variable FFeedbackContext * GWarn  
Public variable const FText GYes  
Public variable bool(*)() IsAsyncLoading Whether we're currently in the async loading code path or not
Public variable bool(*)() IsAsyncLoadingMultithreaded Returns true if async loading is using the async loading thread
Public variable bool(*)() IsAsyncLoadingSuspended Suspends async package loading.
Public variable bool(*)() IsInAsyncLoadingThread  
Public variable bool PRIVATE_GIsRunningCookCommandlet  
Public variable bool PRIVATE_GIsRunningDLCCookCommandlet Whether this executable is running the cook commandlet
Public variable void(*)() ResumeAsyncLoading Resumes async package loading.
Public variable void(*)() ResumeTextureStreamingRenderTasks Resume texture updates caused by completed async IOs.
Public variable void(*)() SuspendAsyncLoading Suspends async package loading.
Public variable void(*)() SuspendTextureStreamingRenderTasks Suspends texture updates caused by completed async IOs.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page