![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "UnrealEngine.h"#include "Algo/Find.h"#include "Engine/Blueprint.h"#include "Async/AsyncFileHandle.h"#include "Engine/GameInstance.h"#include "Engine/LevelStreaming.h"#include "EngineStats.h"#include "Engine/GameViewportClient.h"#include "Engine/LevelStreamingGCHelper.h"#include "AI/NavigationSystemBase.h"#include "AI/NavigationSystemConfig.h"#include "Engine/NetConnection.h"#include "Misc/MessageDialog.h"#include "Engine/PendingNetGame.h"#include "Misc/FileHelper.h"#include "EngineGlobals.h"#include "Containers/Ticker.h"#include "Misc/FrameValue.h"#include "FramePro/FramePro.h"#include "Misc/BufferedOutputDevice.h"#include "Misc/OutputDeviceArchiveWrapper.h"#include "HAL/PlatformFile.h"#include "Misc/OutputDeviceFile.h"#include "Math/ColorList.h"#include "Stats/StatsMisc.h"#include "Stats/ThreadIdleStats.h"#include "Misc/AutomationTest.h"#include "Misc/CoreDelegates.h"#include "Misc/StringFormatArg.h"#include "Misc/TimeGuard.h"#include "Net/Core/Trace/Private/NetTraceInternal.h"#include "UObject/UObjectIterator.h"#include "ParticleEmitterInstances.h"#include "UObject/CoreRedirects.h"#include "UObject/MetaData.h"#include "Particles/ParticleEmitter.h"#include "UObject/ObjectMemoryAnalyzer.h"#include "Particles/TypeData/ParticleModuleTypeDataBase.h"#include "UObject/UObjectGlobalsInternal.h"#include "PhysicsEngine/ConvexElem.h"#include "Serialization/ArchiveCountMem.h"#include "RenderAssetUpdate.h"#include "Serialization/ObjectWriter.h"#include "Serialization/ObjectReader.h"#include "Misc/PackageName.h"#include "TextureResource.h"#include "UObject/LinkerLoad.h"#include "GameMapsSettings.h"#include "Logging/LogScopedCategoryAndVerbosityOverride.h"#include "Misc/WildcardString.h"#include "Misc/OutputDeviceConsole.h"#include "Serialization/ArchiveReplaceOrClearExternalReferences.h"#include "Materials/Material.h"#include "GameFramework/GameModeBase.h"#include "Particles/ParticleSystem.h"#include "Performance/LatencyMarkerModule.h"#include "Performance/MaxTickRateHandlerModule.h"#include "Engine/SkeletalMesh.h"#include "Engine/SkinnedAssetCommon.h"#include "Components/SkeletalMeshComponent.h"#include "EngineFontServices.h"#include "Engine/Texture2D.h"#include "Engine/Texture2DArray.h"#include "Engine/TextureRenderTarget2D.h"#include "Engine/VolumeTexture.h"#include "Particles/ParticleModule.h"#include "Particles/ParticleSystemComponent.h"#include "Exporters/Exporter.h"#include "Materials/MaterialInstanceDynamic.h"#include "Engine/LocalPlayer.h"#include "Engine/StaticMesh.h"#include "DistanceFieldAtlas.h"#include "SystemSettings.h"#include "EngineUtils.h"#include "Framework/Application/SlateApplication.h"#include "UObject/GarbageCollectionHistory.h"#include "UObject/ReachabilityAnalysis.h"#include "Widgets/Input/SButton.h"#include "Widgets/SWindow.h"#include "Engine/EngineCustomTimeStep.h"#include "Engine/LevelStreamingPersistent.h"#include "Engine/ObjectReferencer.h"#include "Engine/TextureLODSettings.h"#include "Engine/TimecodeProvider.h"#include "Engine/SystemTimeTimecodeProvider.h"#include "Net/OnlineEngineInterface.h"#include "Engine/Console.h"#include "UObject/Stack.h"#include "VisualLogger/VisualLogger.h"#include "SkeletalMeshMerge.h"#include "ShaderCompiler.h"#include "Slate/SlateSoundDevice.h"#include "DerivedDataCacheInterface.h"#include "IImageWrapper.h"#include "IImageWrapperModule.h"#include "EngineAnalytics.h"#include "Elements/Framework/EngineElements.h"#include "TickTaskManagerInterface.h"#include "Net/NetworkProfiler.h"#include "IHeadMountedDisplayModule.h"#include "IHeadMountedDisplay.h"#include "IXRTrackingSystem.h"#include "IXRLoadingScreen.h"#include "Stats/StatsFile.h"#include "Audio/AudioDebug.h"#include "AudioDevice.h"#include "Animation/SkeletalMeshActor.h"#include "Animation/AnimSequence.h"#include "Engine/Canvas.h"#include "GameFramework/HUD.h"#include "GameFramework/Character.h"#include "GameDelegates.h"#include "MoviePlayerProxy.h"#include "PhysicsEngine/BodySetup.h"#include "Engine/LevelStreamingVolume.h"#include "Engine/LevelScriptActor.h"#include "HAL/PlatformApplicationMisc.h"#include "DynamicResolutionState.h"#include "Engine/ViewportStatsSubsystem.h"#include "GPUSkinCache.h"#include "Chaos/TriangleMeshImplicitObject.h"#include "HAL/PlatformMemoryHelpers.h"#include "RenderCore.h"#include "Misc/DelayedAutoRegister.h"#include <exception>#include "AssetCompilingManager.h"#include "UObject/UObjectSerializeContext.h"#include "Iris/IrisConfig.h"#include "Iris/ReplicationSystem/NetObjectFactoryRegistry.h"#include "IUniversalObjectLocatorModule.h"#include "Particles/Spawn/ParticleModuleSpawn.h"#include "Particles/TypeData/ParticleModuleTypeDataMesh.h"#include "Particles/ParticleLODLevel.h"#include "Particles/ParticleModuleRequired.h"#include "Components/TextRenderComponent.h"#include "Rendering/SkeletalMeshRenderData.h"#include "IO/IoDispatcher.h"#include "UniversalObjectLocators/ActorLocatorFragment.h"#include "UniversalObjectLocators/AssetLocatorFragment.h"#include "UniversalObjectLocators/AnimInstanceLocatorFragment.h"#include "HardwareInfo.h"#include "EngineModule.h"#include "UnrealExporter.h"#include "BufferVisualizationData.h"#include "NaniteVisualizationData.h"#include "VirtualShadowMapVisualizationData.h"#include "RayTracingVisualizationData.h"#include "VT/VirtualTextureVisualizationData.h"#include "Misc/HotReloadInterface.h"#include "Widgets/Testing/STestSuite.h"#include "Engine/DemoNetDriver.h"#include "Widgets/Images/SThrobber.h"#include "Engine/TextureCube.h"#include "AI/Navigation/AvoidanceManager.h"#include "Engine/GameEngine.h"#include "PhysicsEngine/PhysicsCollisionHandler.h"#include "Components/BrushComponent.h"#include "GameFramework/GameUserSettings.h"#include "PhysicalMaterials/PhysicalMaterial.h"#include "Widgets/Notifications/SNotificationList.h"#include "Engine/UserInterfaceSettings.h"#include "ComponentRecreateRenderStateContext.h"#include "Materials/MaterialRenderProxy.h"#include "IMessageRpcClient.h"#include "IMessagingRpcModule.h"#include "IPortalRpcModule.h"#include "IPortalRpcLocator.h"#include "IPortalServicesModule.h"#include "IPortalServiceLocator.h"#include "Misc/TypeContainer.h"#include "IMovieSceneCapture.h"#include "MovieSceneCaptureModule.h"#include "GameFramework/OnlineSession.h"#include "ProfilingDebugging/ABTesting.h"#include "Performance/EnginePerformanceTargets.h"#include "InstancedReferenceSubobjectHelper.h"#include "Misc/EngineBuildSettings.h"#include "Engine/LODActor.h"#include "Engine/AssetManager.h"#include "GameplayTagsManager.h"#include "PrimitiveDrawingUtils.h"#include "IAutomationWorkerModule.h"#include "ParseExecCommands.h"#include "GeneralProjectSettings.h"#include "ProfilingDebugging/LoadTimeTracker.h"#include "AssetRegistry/AssetRegistryModule.h"#include "Engine/CoreSettings.h"#include "IEyeTrackerModule.h"#include "Interfaces/IPluginManager.h"#include "Animation/SkeletonRemappingRegistry.h"#include "GenericPlatform/GenericPlatformCrashContext.h"#include "Streaming/StreamingManagerTexture.h"#include "Net/Iris/ReplicationSystem/NetEngineFactories.h"#include "HAL/FileManagerGeneric.h"#include "UObject/ReferenceChainSearch.h"#include "Particles/ParticleSystemManager.h"#include "ObjectTrace.h"#include "ObjectPropertyTrace.h"#include "Animation/SkinWeightProfileManager.h"#include "Particles/ParticlePerfStatsManager.h"#include "IDeviceProfileSelectorModule.h"#include "HDRHelper.h"#include "StructUtils/InstancedStruct.h"#include "UObject/PropertyBagRepository.h"#include "UObject/UObjectThreadContext.h"#include "UObject/OverridableManager.h"#include "StereoRenderTargetManager.h"#include "ScreenRendering.h"#include "WorldPartition/HLOD/HLODRuntimeSubsystem.h"Namespaces | |
| namespace | UE |
| namespace | UE::Private |
| namespace | FFrameEndSync |
| namespace | UE::Engine |
| namespace | UE::Engine::Private |
Macros | |
| #define | LOCTEXT_NAMESPACE "UnrealEngine" |
| #define | MAXDUDES 20 |
| #define | BADAMTOFDUDES 12 |
| #define BADAMTOFDUDES 12 |
| #define LOCTEXT_NAMESPACE "UnrealEngine" |
| #define MAXDUDES 20 |
| bool AllowHighQualityLightmaps | ( | const FStaticFeatureLevel | FeatureLevel | ) |
| FString appGetStartupMap | ( | const TCHAR * | CommandLine | ) |
This function will look at the given command line and see if we have passed in a map to load. If we have then use that. If we have not then use the DefaultMap which is stored in the Engine.ini
| CommandLine | Commandline to use to get startup map (NULL or "" will return default startup map) |
| void CalculateFPSTimings | ( | ) |
| void CauseCrtError | ( | ) |
| PRAGMA_ENABLE_DEPRECATION_WARNINGS TAutoConsoleVariable< bool > CVarAuditAggressiveReferenceReplacement | ( | TEXT("cpfuo.AuditAggressiveReferenceReplacment") | , |
| 1 | , | ||
| TEXT("Whether to audit and report on reference replacements that come from the aggressive replacement path.\n") | , | ||
| ECVF_Cheat | |||
| ) |
| DEFINE_LOG_CATEGORY | ( | LogEngine | ) |
| DEFINE_STAT | ( | STAT_CPUSkinVertices | ) |
| DEFINE_STAT | ( | STAT_DeferredTickTime | ) |
| DEFINE_STAT | ( | STAT_GameEngineTick | ) |
Stats objects for Engine
| DEFINE_STAT | ( | STAT_GameViewportTick | ) |
| DEFINE_STAT | ( | STAT_GPUSkinVertices | ) |
| DEFINE_STAT | ( | STAT_HudTime | ) |
HUD stat
| DEFINE_STAT | ( | STAT_InputLatencyTime | ) |
Input stat
| DEFINE_STAT | ( | STAT_IntentionalHitch | ) |
| DEFINE_STAT | ( | STAT_RedrawViewports | ) |
| DEFINE_STAT | ( | STAT_RHITickTime | ) |
| DEFINE_STAT | ( | STAT_SkelMeshDrawCalls | ) |
| DEFINE_STAT | ( | STAT_SkelMeshTriangles | ) |
| DEFINE_STAT | ( | STAT_SkinningTime | ) |
Skeletal stats
| DEFINE_STAT | ( | STAT_StaticMeshTriangles | ) |
Static mesh tris rendered
| DEFINE_STAT | ( | STAT_UnitFrame | ) |
Unit times
| DEFINE_STAT | ( | STAT_UnitGame | ) |
| DEFINE_STAT | ( | STAT_UnitGPU | ) |
| DEFINE_STAT | ( | STAT_UnitRender | ) |
| DEFINE_STAT | ( | STAT_UnitRHIT | ) |
| DEFINE_STAT | ( | STAT_UpdateClothVertsTime | ) |
| DEFINE_STAT | ( | STAT_UpdateLevelStreaming | ) |
| float DrawMapWarnings | ( | UWorld * | World, |
| FViewport * | Viewport, | ||
| FCanvas * | Canvas, | ||
| UCanvas * | CanvasObject, | ||
| float | MessageX, | ||
| float | MessageY | ||
| ) |
Renders warnings about the level that should be addressed prior to shipping
| World | The World to render stats about |
| Viewport | The viewport to render to |
| Canvas | Canvas object to use for rendering |
| CanvasObject | Optional canvas object for visualizing properties |
| MessageX | X Pos to start drawing at on the Canvas |
| MessageY | Y Pos to draw at on the Canvas |
| void DrawStatsHUD | ( | UWorld * | World, |
| FViewport * | Viewport, | ||
| FCanvas * | Canvas, | ||
| UCanvas * | CanvasObject, | ||
| TArray< FDebugDisplayProperty > & | DebugProperties, | ||
| const FVector & | ViewLocation, | ||
| const FRotator & | ViewRotation | ||
| ) |
Renders stats
| World | The World to render stats about |
| Viewport | The viewport to render to |
| Canvas | Canvas object to use for rendering |
| CanvasObject | Optional canvas object for visualizing properties |
| DebugProperties | List of properties to visualize (in/out) |
| ViewLocation | Location of camera |
| ViewRotation | Rotation of camera |
| UNetDriver * FindNamedNetDriver_Local | ( | const TArray< FNamedNetDriver > & | ActiveNetDrivers, |
| FName | NetDriverName | ||
| ) |
| const FCachedSystemScalabilityCVars & GetCachedScalabilityCVars | ( | ) |
| ENGINE_API FString GetDebugStringForWorld | ( | const UWorld * | World | ) |
| void GetDefaultThreadConfigs | ( | ) |
| ULocalPlayer * GetLocalPlayerFromControllerId_local | ( | const TArray< class ULocalPlayer * > & | GamePlayers, |
| const int32 | ControllerId | ||
| ) |
| UFont * GetStatsFont | ( | ) |
| const TArray< class ULocalPlayer * > & HandleFakeLocalPlayersList | ( | ) |
| FWorldContext & HandleInvalidWorldContext | ( | ) |
| void ENGINE_API HDRSettingChangedSinkCallback | ( | ) |
| IMPLEMENT_MODULE | ( | FEngineModule | , |
| Engine | |||
| ) |
| int InfiniteRecursionFunction | ( | int | B | ) |
| void InitCustomDepth | ( | ) |
| ENGINE_API void InitializeRenderingCVarsCaching | ( | ) |
| void InitScreenPercentage | ( | ) |
| void InitThreadConfig | ( | ) |
| void LoadEngineClass | ( | FSoftClassPath & | ClassName, |
| TSubclassOf< ClassType > & | EngineClassRef | ||
| ) |
| void LoadSpecialMaterial | ( | const FString & | MaterialName, |
| const FString & | MaterialNamePath, | ||
| T & | Material, | ||
| bool | bCheckUsage | ||
| ) |
Loads a special material and verifies that it is marked as a special material (some shaders will only be compiled for materials marked as "special engine material")
| MaterialName | Variable name of the material in the engine to identify which material can't be loaded |
| MaterialNamePath | Fully qualified name of a material to load/find |
| Material | Reference to a material object pointer that will be filled out |
| bCheckUsage | Check if the material has been marked to be used as a special engine material |
| UMaterialInterface * LoadSpecialMaterialInterface | ( | const FString & | MaterialName, |
| const FString & | MaterialNamePath | ||
| ) |
Loads a special material interface and, in editor builds - verifies that it can be loaded, while reporting only a log message only in non-editor builds.
| MaterialName | Variable name of the material in the engine to identify which material can't be loaded |
| MaterialNamePath | Fully qualified name of a material to load/find |
| void OnChangeEngineCVarRequiringRecreateRenderState | ( | IConsoleVariable * | Var | ) |
| bool ParseResolution | ( | const TCHAR * | InResolution, |
| uint32 & | OutX, | ||
| uint32 & | OutY, | ||
| int32 & | OutWindowMode | ||
| ) |
| PRAGMA_DISABLE_UNREACHABLE_CODE_WARNINGS bool PerformBlockingError | ( | const TCHAR * | Cmd, |
| FOutputDevice & | Ar | ||
| ) |
| void PumpABTest | ( | ) |
| void RefreshEngineSettings | ( | ) |
| void RefreshSamplerStatesCallback | ( | ) |
if we need to update the sample states
| void ScalabilityCVarsSinkCallback | ( | ) |
| void SetPriorityAndAffinityOnGameThread | ( | ) |
| void SetPriorityAndAffinityOnRenderThread | ( | ) |
| void SetPriorityAndAffinityOnRHIThread | ( | ) |
| FORCENOINLINE void StackOverflowFunction | ( | int32 * | DummyArg | ) |
Helper function to cause a stack overflow crash
| EThreadPriority StringToThreadPriority | ( | FString | InString | ) |
| void SystemResolutionSinkCallback | ( | ) |
| FString ThreadPriorityToString | ( | EThreadPriority | InPriority | ) |
|
extern |
| ENGINE_API void UpdatePlayInEditorWorldDebugString | ( | const FWorldContext * | WorldContext | ) |
| TAutoConsoleVariable< bool > CVarAllowExtraDevMemoryMessageDisplayed(TEXT("Debug.AllowExtraDevMemoryMessageDisplayed"), true,) | ( | TEXT("Debug.AllowExtraDevMemoryMessageDisplayed") | , |
| true | |||
| ) |
| TAutoConsoleVariable< bool > CVarCsvAlwaysShowFrameCount(TEXT("csv.AlwaysShowFrameCount"), false,) | ( | TEXT("csv.AlwaysShowFrameCount") | , |
| false | |||
| ) |
| TAutoConsoleVariable< bool > CVarUseAggressiveReferenceReplacement(TEXT("cpfuo.UseAggressiveReferenceReplacment"), 0, TEXT("Whether to aggressively replace references. This behavior is being deprecated but being left with the ability to toggle back on in case issues arise.\n"), ECVF_Default) | ( | TEXT("cpfuo.UseAggressiveReferenceReplacment") | , |
| 0 | , | ||
| TEXT("Whether to aggressively replace references. This behavior is being deprecated but being left with the ability to toggle back on in case issues arise.\n") | , | ||
| ECVF_Default | |||
| ) |
| ENGINE_API float GAverageFPS = 0.0f |
| ENGINE_API float GAverageMS = 0.0f |
| int32 GDelayTrimMemoryDuringMapLoadMode = 0 |
| ENGINE_API UEngine* GEngine = NULL |
Global engine pointer. Can be 0 so don't use without checking.
| volatile int GInfiniteRecursionCount = 0 |
| ENGINE_API bool GIsLowMemory = false |
Whether PrepareMapChange is attempting to load a map that doesn't exist
Whether texture memory has been corrupted because we ran out of memory in the pool.
| ENGINE_API double GLastMemoryWarningTime = 0.f |
| int32 GPerformGCWhileAsyncLoading = 0 |
| FConsoleVariableSinkHandle GRefreshEngineSettingsSinkHandle |
| FAutoConsoleCommand GSetNearClipPlaneCmd(TEXT("r.SetNearClipPlane"), TEXT("Set the near clipping plane (in cm)"), FConsoleCommandWithArgsDelegate::CreateStatic(SetNearClipPlane)) | ( | TEXT("r.SetNearClipPlane") | , |
| TEXT("Set the near clipping plane (in cm)") | , | ||
| FConsoleCommandWithArgsDelegate::CreateStatic(SetNearClipPlane) | |||
| ) |
| int32 GShowMaterialDrawEvents = 0 |
| int32 GSupressWarningsInOnScreenDisplay = 0 |
| int32 GSuspendAssetStreamerBeforePerformingFullGC = 0 |
| FSystemResolution GSystemResolution |
System resolution instance
| ENGINE_API int32 GUnbuiltHLODCount = 0 |