1. Epic GamesDeveloper
  3. HAL

HAL

Unreal Engine C++ API Reference > Runtime > Core

Filters

Classes

  Type Name Description
Public class FArchiveFileReaderGeneric    
Public class FArchiveFileWriterGeneric    
Public struct FArenaParams    
Public class FAutoConsoleCommand Autoregistering console command  
Public class FAutoConsoleCommandWithArgsAndOutputDevice Autoregistering console command with args and an output device  
Public class FAutoConsoleCommandWithOutputDevice Autoregistering console command with an output device  
Public class FAutoConsoleCommandWithWorld Autoregistering console command with a world  
Public class FAutoConsoleCommandWithWorldAndArgs Autoregistering console command with a world and arguments  
Public class FAutoConsoleCommandWithWorldArgsAndOutputDevice Autoregistering console command with world, args, an output device  
Public class FAutoConsoleObject Base class for autoregistering console commands.  
Public class FAutoConsoleVariable Autoregistering float, int or string console variable  
Public class FAutoConsoleVariableRef Autoregistering float, int, bool, FString REF variable class...this changes that value when the console variable is changed.  
Public class FAutoConsoleVariableSink Auto registering console variable sinks (register a callback function that is called when ever a cvar is changes by the user, changes are grouped and happen in specific engine spots during the frame/main loop)  
Public class FBitTree    
Public class FCachedFileHandle    
Public class FCachedReadPlatformFile    
Public class FConsoleManager    
Public class FConsoleVariableSinkHandle Class representing an handle to an online delegate.  
Public struct FCopyProgress    
Public struct FDisableHitchDetectorScope Suspends hitch detection in the current scope  
Public class FEvent Interface for waitable events.  
Public class FEventRef RAII-style pooled `FEvent_non-copyable, non-movable  
Public class FFeedbackContextAnsi    
Public class FFileHandleRegistry    
Public class FFileManagerGeneric Base class for file managers.  
Public struct FFunctionHeartBeatScope Simple scope object to put at the top of a function to monitor it completes in a timely fashion  
Public class FGameThreadHitchHeartBeatThreaded    
Public struct FGenericMemoryStats Holds generic memory stats, internally implemented as a map.  
Public class FLoggedFileHandle    
Public class FLoggedPlatformFile    
Public class FLoggingAsyncReadFileHandle    
Public class FMalloc The global memory allocator's interface.  
Public class FMallocAnsi ANSI C memory allocator.  
Public class FMallocBinned Malloc binned allocator specific stats. Optimized virtual memory allocator.  
Public class FMallocBinned2 Optimized virtual memory allocator.  
Public class FMallocBinnedCommonBase    
Public class FMallocCallstackHandler    
Public class FMallocDebug Debug memory allocator.  
Public class FMallocDoubleFreeFinder    
Public class FMallocFrameProfiler    
Public struct FMallocLeakReportOptions Options that can be supplied when calling FMallocLeakDetection::DumpOpenCallstacks  
Public class FMallocPoisonProxy FMalloc proxy that poisons new and freed allocations, helping to catch code that relies on uninitialized or freed memory.  
Public class FMallocThreadSafeProxy FMalloc proxy that synchronizes access, making the used malloc thread safe.  
Public class FManagedStorageFileLockRegistry    
Public class FManagedStorageFileWriteHandle Only write handle.  
Public class FManagedStorageScopeFileLock    
Public struct FMemory    
Public class FPageCache    
Public struct FPersistentManagedFile    
Public struct FPersistentStorageCategory    
Public class FPersistentStorageManager NOTE: is not used on the whole class because then FCategoryInfo is exported which appears to force the generation of copy constructors for FPersistentStorageCategory which causes a compile error because std::atomic can't be copied.  
Public class FPlatformFileManager Platform File chain manager.  
Public class FPlatformFileOpenLog    
Public class FPThreadEvent This is the PThreads version of FEvent.  
Public class FPThreadsCriticalSection This is the PThreads version of a critical section. It uses pthreads to implement its locking.  
Public class FPThreadSemaphore    
Public class FPThreadsRWLock FPThreadsRWLock - Read/Write Mutex  
Public class FRegisteredFileHandle    
Public class FRunnable Interface for "runnable" objects.  
Public class FRunnableThread Interface for runnable threads.  
Public struct FScopedDiskUtilizationTracker    
Public class FScopedEnterBackgroundEvent For timing OnEnterBackground tasks. This can be time sensitive on some platforms.  
Public class FScopeDisableMallocCallstackHandler Disables the callstack handler for the current thread Need to do this as we might allocate memory for the allocators tracking data, that can't be tracked!  
Public struct FScopedMallocTimer    
Public class FScopedMemoryStats This will grab the memory stats of VM and Physical before and at the end of scope reporting +/- difference in memory.  
Public class FScopedNamedEvent    
Public class FScopedNamedEventConditional    
Public class FScopedNamedEventStatic Scoped named event class for constant (compile-time) strings literals.  
Public class FScopedProfilerColor    
Public struct FScopedVirtualMallocTimer    
Public class FSharedEventRef RAII-style shared and pooled `FEvent_  
Public class FSharedMemoryTracker    
Public struct FSizeTableEntry    
Public struct FSlowHeartBeatScope Suspends heartbeat measuring for the current thread in the current scope  
Public class FThread Simple API for system threads.  
Public struct FThreadAffinity    
Public class FThreadHeartBeat Thread heartbeat check class. Used by crash handling code to check for hangs.  
Public class FThreadHeartBeatClock Our own local clock.  
Public class FThreadManager Manages runnables and runnable threads.  
Public class FThreadSafeBool DEPRECATED. Please use `std::atomic_  
Public class FThreadSafeCounter DEPRECATED. Please use `std::atomic_  
Public class FThreadSafeCounter64 DEPRECATED. Please use `std::atomic_  
Public class FThreadSingletonInitializer Thread singleton initializer.  
Public class FTlsAutoCleanup Base class for objects in TLS that support auto-cleanup.  
Public class FUseSystemMallocForNew Inherit from FUseSystemMallocForNew if you want your objects to be placed in memory alloced by the system malloc routines, bypassing GMalloc.  
Public class FVirtualAllocator    
Public struct IConsoleCommand Interface for console commands  
Public class IConsoleCommandExecutor Handles executing console commands  
Public struct IConsoleManager Handles console commands and variables, registered console variables are released on destruction  
Public class IConsoleObject Interface for console objects (variables and commands)  
Public struct IConsoleThreadPropagation Interface to propagate changes of console variables to another thread  
Public class IConsoleVariable Interface for console variables  
Public class IFileManager    
Public class IPlatformFileModule Platform File Module Interface  
Public class TAutoConsoleVariable Autoregistering float, int variable class...this changes that value when the console variable is changed.  
Public class TConsoleVariableData Currently only supports main and render thread optimized for read access speed (no virtual function call and no thread handling if using the right functions) T: int32, float  
Public class TMallocBinnedCommon    
Public class TManagedStoragePlatformFile NOTE: This is templated rather than a polymorphic wrapper because a lot code expects the physical layer not to be a wrapper.  
Public class TThreadSingleton This a special version of singleton.  
Public class TTlsAutoCleanupValue Wrapper for values to be stored in TLS that support auto-cleanup.  

Typedefs

Name Description
ANSICHAR An ANSI character. Normally a signed type.
BINNED_STAT_TYPE  
FConsoleCommandDelegate Console command delegate type (takes no arguments.) This is a void callback function.
FConsoleCommandWithArgsAndOutputDeviceDelegate Console command delegate type (with arguments and output device.) This is a void callback function that always takes a list of arguments and output device.
FConsoleCommandWithArgsDelegate Console command delegate type (with arguments.) This is a void callback function that always takes a list of arguments.
FConsoleCommandWithOutputDeviceDelegate Console command delegate type with the output device passed through.
FConsoleCommandWithWorldAndArgsDelegate Console command delegate type (with a world and arguments.) This is a void callback function that always takes a list of arguments and a world.
FConsoleCommandWithWorldArgsAndOutputDeviceDelegate Console command delegate type (with a world arguments and output device.) This is a void callback function that always takes a list of arguments, a world and output device.
FConsoleCommandWithWorldDelegate Console command delegate type with a world argument.
FConsoleObjectVisitor Declares a delegate type that's used by the console manager to call back into a user function for each known console object.
FConsoleObjectWithNameMulticastDelegate Console object with name multicast delegate type.
FConsoleVariableDelegate Console variable delegate type This is a void callback function.
FConsoleVariableMulticastDelegate Console variable multicast delegate type.
FGameThreadHitchHeartBeat  
FOnHangDelegate  
FOnThreadStuck Copyright Epic Games, Inc. All Rights Reserved.
FOnThreadUnstuck  
FPlatformMallocCrash Copyright Epic Games, Inc. All Rights Reserved.
FSemaphore  
int16 A 16-bit signed integer.
int32 A 32-bit signed integer.
int64 A 64-bit signed integer.
int8 An 8-bit signed integer.
PTRINT A signed integer the same size as a pointer.
SIZE_T An unsigned integer the same size as a pointer, the same as UPTRINT.
SSIZE_T An integer the same size as a pointer, the same as PTRINT.
TCHAR Either ANSICHAR or WIDECHAR, depending on whether the platform supports wide characters or the requirements of the licensee.
TYPE_OF_NULL The type of the NULL constant.
TYPE_OF_NULLPTR The type of the C++ nullptr keyword.
UCS2CHAR A 16-bit character containing a UCS2 (Unicode, 16-bit, fixed-width) code unit, used for compatibility with 'Windows TCHAR' across multiple platforms.
UE_SYSTEM_TCHAR This header is expected to be included after HAL/HideTCHAR.h - see the comments in that header for more details.
uint16 A 16-bit unsigned integer.
uint32 A 32-bit unsigned integer.
uint64 A 64-bit unsigned integer.
uint8 Transfer the platform types to global types.
UPTRINT An unsigned integer the same size as a pointer.
UTF16CHAR A 16-bit character containing a UTF16 (Unicode, 16-bit, variable-width) code unit.
UTF32CHAR A 32-bit character containing a UTF32 (Unicode, 32-bit, fixed-width) code unit.
UTF8CHAR An 8-bit character containing a UTF8 (Unicode, 8-bit, variable-width) code unit.
WIDECHAR A wide character. Normally a signed type.

Enums

  Type Name Description
Public enum EBlockCanary Canary value used in FFreeBlock A constant value unless we're compiled with fork support in which case there are two values identifying whether the page was allocated pre- or post-fork  
Public enum EConsoleVariableFlags Console variable usage guide:  
Public enum ECopyResult    
Public enum EEventMode    
Public enum EFileOpenFlags    
Public enum EFileRead    
Public enum EFileWrite    
Public enum EPersistentStorageManagerFileSizeFlags    

Functions

  Type Name Description
Public function void

AnsiFree ( void* Ptr
)

  
Public function void *

AnsiMalloc ( SIZE_T Size,
uint32 Alignment
)

  
Public function void *

AnsiRealloc ( void* Ptr,
SIZE_T NewSize,
uint32 Alignment
)

  
Public function void  
Public function const TCHAR * Returns human readable ECVF_SetByMask bits of the console variable flags.
Public function EConsoleVariableFlags

GetConsoleVariableSetByValue ( const TCHAR* SetByName
)

 Inverse of GetConsoleVariableSetByName()
Public function bool  
Public function bool

ManagedStorageInternal::IsUnderDirectory ( const FString& InPath,
const FString& InDirectory
)

 Same as FPaths::IsUnderDirectory, but assume the paths are already full Also is always case insensitive since we are concerned with filtering and not whether a directory actually exists.
Public function bool  
Public function EPersistentStorageManagerFileSizeFlags  
Public function EPersistentStorageManagerFileSizeFlags &  
Public function EPersistentStorageManagerFileSizeFlags  
Public function EPersistentStorageManagerFileSizeFlags &  
Public function EPersistentStorageManagerFileSizeFlags  
Public function EPersistentStorageManagerFileSizeFlags &  
Public function EPersistentStorageManagerFileSizeFlags  
Public function void

ReportInteractiveEnsure ( const TCHAR* InMessage
)

 #CrashReport: 2014-09-11 Move to PlatformExceptionHandling
Public function void  
Public function const UTF8CHAR(&)[N]

UE::Core::Private::ToUTF8Literal ( const char(&) Array
)

 Can't be constexpr because it involves casts.
Public function UTF8CHAR

UE::Core::Private::ToUTF8Literal ( unsigned long long Ch
)

  

Variables

  Type Name Description
Public variable TAtomic< int64 > AllocatedLargePoolMemory  
Public variable TAtomic< int64 > AllocatedLargePoolMemoryWAlignment  
Public variable TAtomic< int64 > AllocatedOSSmallPoolMemory  
Public variable TAtomic< int64 > AllocatedSmallPoolMemory The following don't need a critical section because they are covered by the critical section called Mutex
Public variable bool bSuppressFileLog Wrapper to log the low level file system
Public variable bool GAlwaysReportCrash Whether we should generate crash reports even if the debugger is attached.
Public variable FMalloc ** GFixedMallocLocationPtr  
Public variable FMalloc * GMalloc The global memory allocator.
Public variable FMallocCallstackHandler * GMallocCallstackHandler  
Public variable FMallocDoubleFreeFinder * GMallocDoubleFreeFinder  
Public variable bool GMallocDoubleFreeFinderEnabled  
Public variable FMallocFrameProfiler * GMallocFrameProfiler  
Public variable bool GMallocFrameProfilerEnabled  
Public variable bool GUseCrashReportClient Whether to use ClientReportClient rather than AutoReporter.
Public variable TCHAR[1024] MiniDumpFilenameW  
Public variable bool TAreTypesEqual_V  
Public variable bool TAreTypesEqual_V< T, T >  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page