HAL

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public class

FArchiveFileReaderGeneric

Public class

FArchiveFileWriterGeneric

Public struct

FArenaParams

Public class

FAutoConsoleCommand

Autoregistering console command

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 a world, arguments, and 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

FFeedbackContextAnsi

Feedback context.

Public class

FFileHandleRegistry

Public class

FFileManagerGeneric

Base class for file managers.

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

FMallocDebug

Debug memory allocator.

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 struct

FMemory

Public class

FPageCache

Public class

FPlatformFileManager

Platform File chain manager.

Public class

FPlatformFileOpenLog

Public class

FPlatformFileReadStats

Public class

FPlatformFileReadStatsHandle

Public struct

FProfiledFileStatsBase

Public struct

FProfiledFileStatsFileBase

Public struct

FProfiledFileStatsFileDetailed

Public struct

FProfiledFileStatsFileSimple

Public struct

FProfiledFileStatsOp

Public class

FProfiledPlatformFile

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

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 struct

FScopedMallocTimer

Public class

FScopedNamedEvent

Public class

FScopedNamedEventStatic

Scoped named event class for constant (compile-time) strings literals.

Public class

FScopedProfilerColor

Public struct

FSizeTableEntry

Public struct

FSlowHeartBeatScope

Suspends heartbeat measuring for the current thread in the current scope

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

Thread safe bool, wraps FThreadSafeCounter

Public class

FThreadSafeCounter

Thread safe counter

Public class

FThreadSafeCounter64

Thread safe counter for 64bit ints

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 struct

TAreTypesEqual

Tests whether two typenames refer to the same type.

Public struct

TAreTypesEqual

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

TProfiledFileHandle

Public class

TProfiledPlatformFile

Public class

TThreadSingleton

This a special version of singleton.

Public class

TTlsAutoCleanupValue

Wrapper for values to be stored in TLS that support auto-cleanup.

Constants

Name

Description

DEFAULT_ALIGNMENT

Default allocator alignment.

MIN_ALIGNMENT

Minimum allocator alignment.

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.

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.

FConsoleVariableDelegate

Console variable delegate type This is a void callback function.

FGameThreadHitchHeartBeat

FPlatformMallocCrash

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.

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

Name

Description

Public enum

EConsoleVariableFlags

Console variable usage guide:

Public enum

ECopyResult

Public enum

ECrashType

#CrashReport: 2014-09-11 Move to PlatformExceptionHandling

Public enum

EFileOpenFlags

Public enum

EFileRead

Public enum

EFileWrite

Functions

Name Description

Public function

void

 

DoGamethreadHook

(
    int32 Index
)

Public function

int32

 

GetCrashType()

Public function

bool

 

IsHTML5Platform()

Platform specific compiler setup.

Public function

bool

 

IsInteractiveEnsureMode()

Public function

void

 

ReportInteractiveEnsure

(
    const TCHAR* InMessage
)

Public function

void

 

SetCrashType

(
    ECrashType InCrashType
)

In debug builds we can crash on demand so we want to let the crash reporting system know about it

Variables

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

 

bSuppressProfiledFileLog

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

bool

 

GIgnoreDebugger

Whether we should ignore the attached debugger.

Public variable

FMalloc *

 

GMalloc

The global memory allocator.

Public variable

bool

 

GUseCrashReportClient

Whether to use ClientReportClient rather than AutoReporter.

Public variable

TCHAR[1024]

 

MiniDumpFilenameW

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback