Language:
Discover
By Skill Level
By Category

Containers

Choose your OS:

Filters

Classes

Name

Description

Public struct

BaseKeyFuncs

The base KeyFuncs type with some useful definitions for all KeyFuncs; meant to be derived from instead of used directly.

Public struct

DefaultKeyComparer

Default comparer for keys in TLruCache .

Public struct

DefaultKeyFuncs

A default implementation of the KeyFuncs used by TSet which uses the element as a key.

Public struct

ENullTerminatedString

Public class

FBinaryHeap

Copyright (C) 2009 Nine Realms, Inc -------------------------------------------------------------------------- Binary Heap, used to index another data structure.

Public class

FBitReference

Used to read/write a bit in the array as a bool.

Public struct

FBitSet

Functions for manipulating bit sets.

Public class

FConstBitReference

Used to read a bit in the array as a bool.

Public class

FContainerAllocatorInterface

This is the allocation policy interface; it exists purely to document the policy's interface, and should not be used.

Public class

FDefaultAllocator

'typedefs' for various allocator defaults.

Public class

FDefaultBitArrayAllocator

Public class

FDefaultSetAllocator

Public class

FDefaultSparseArrayAllocator

Public class

FHashTable

Dynamically sized hash table, used to index another data structure.

Public class

FHeapAllocator

The indirect allocation policy always allocates the elements indirectly.

Public struct

FIndexedLockFreeLink

Public struct

FIndexedPointer

Public class

FLazyPrintf

To avoid limits with the Printf parameter count, for more readability and type safety

Public struct

FLockFreeLinkPolicy

There is a version of this code that uses 128 bit atomics to avoid the indirection, that is why we have this policy class at all.

Public class

FLockFreePointerFIFOBase

Public class

FLockFreePointerListLIFOBase

Public class

FLockFreePointerListLIFORoot

Public class

FNull

Public struct

FNulPointerIterator

This is a basic ANSICHAR* wrapper which swallows all output written through it.

Public struct

FPaddingForCacheContention

Public class

FRelativeBitReference

Used to reference a bit in an unspecified bit array.

Public class

FResourceArrayInterface

An element type independent interface to the resource array.

Public class

FResourceBulkDataInterface

Allows for direct GPU mem allocation for bulk resource types.

Public class

FScriptArray

Base dynamic array.

Public class

FScriptBitArray

Untyped bit array type for accessing TBitArray data, like FScriptArray for TArray .

Public struct

FScriptContainerElement

A type which is used to represent a script type that is unknown at compile time.

Public class

FScriptMap

Untyped map type for accessing TMap data, like FScriptArray for TArray .

Public struct

FScriptMapLayout

Public class

FScriptSet

Untyped set type for accessing TSet data, like FScriptArray for TArray .

Public struct

FScriptSetLayout

Public class

FScriptSparseArray

Untyped sparse array type for accessing TSparseArray data, like FScriptArray for TArray .

Public struct

FScriptSparseArrayLayout

Public class

FSetElementId

Either NULL or an identifier for an element of a set.

Public struct

FSparseArrayAllocationInfo

The result of a sparse array allocation.

Public struct

FStackTracker

Stack tracker. Used to identify callstacks at any point in the codebase.

Public class

FStallingTaskQueue

Public class

FString

A dynamically sizeable string.

Public class

FStringOutputDevice

Special archivers.

String output device.

Public class

FStringOutputDeviceCountLines

String output device.

Public class

FTCHARToUTF8_Convert

This should be replaced with Platform stuff when FPlatformString starts to know about UTF-8.

Public class

FTexture2DResourceMem

Allows for direct GPU mem allocation for texture resource.

Public class

FTicker

Ticker class.

Public class

FTickerObjectBase

Base class for ticker objects

Public class

FUTF8ToTCHAR_Convert

This should be replaced with Platform stuff when FPlatformString starts to know about UTF-8.

Public class

TAlignedHeapAllocator

The indirect allocation policy always allocates the elements indirectly.

Public class

TAllocatorFixedSizeFreeList

Fixed-sized allocator that uses a free list to cache allocations.

Public struct

TAllocatorTraits

Public struct

TAllocatorTraitsBase

Public class

TArray

Templated dynamic array

Public class

TArrayBuilder

Template for fluent array builders.

Public class

TArrayView

Templated fixed-size view of another array

Public class

TBitArray

Forward declaration.

Public struct

TCanMoveTArrayPointersBetweenArrayTypes

Public struct

TCheckedPointerIterator

Pointer-like iterator type for ranged-for loops which checks that the container hasn't been resized during iteration.

Public class

TChunkedArray

An array that uses multiple allocations to avoid allocation failure due to fragmentation.

Public struct

TChunkedArrayIterator

Public class

TCircularBuffer

Template for circular buffers.

Public class

TCircularQueue

Implements a lock-free first-in first-out queue using a circular array.

Public class

TClosableLockFreePointerListUnorderedSingleConsumer

Public class

TConstDualSetBitIterator

An iterator which only iterates over the bits which are set in both of two bit-arrays.

Public class

TConstSetBitIterator

An iterator which only iterates over set bits.

Public class

TConstStaticBitReference

Used to read a bit in the static array as a bool.

Public struct

TDefaultMapHashableKeyFuncs

Public struct

TDefaultMapKeyFuncs

Defines how the map's pairs are hashed.

Public struct

TDereferencingIterator

Public struct

TDisambiguater

Used to disambiguate methods that are overloaded for all possible subtypes of a TUnion where the subtypes may not be distinct.

Public class

TDoubleLinkedList

Double linked list.

Public class

TDoubleLinkedListIterator

Public class

TEnumAsByte

Template to store enumeration values as bytes in a type-safe way.

Public struct

TEnumAsByte_EnumClass

Public class

TFixedAllocator

The fixed allocation policy allocates up to a specified number of elements in the same allocation as the container.

Public class

TIndexedContainerIterator

Generic iterator which can operate on types that expose the following:

Public class

TIndirectArray

Indirect array.

Public class

TInlineAllocator

The inline allocation policy allocates up to a specified number of elements in the same allocation as the container.

Public class

TInlineSetAllocator

An inline set allocator that allows sizing of the inline allocations for a set number of elements.

Public class

TInlineSparseArrayAllocator

An inline sparse array allocator that allows sizing of the inline allocations for a set number of elements.

Public class

TIntrusiveLinkedList

Encapsulates a link in a single linked list with constant access time.

Public class

TIntrusiveLinkedListIterator

Public struct

TIsCompatibleElementType

Trait testing whether a type is compatible with the view type

Public struct

TIsTArray

Traits class which determines whether or not a type is a TArray .

Public class

TKeyInitializer

An initializer type for keys that's passed to the pair set when adding a new key.

Public struct

TLess

Binary predicate class for sorting elements in order.

Public class

TLinkedList

Encapsulates a link in a single linked list with constant access time.

Public class

TLinkedListBase

Base linked list class, used to implement methods shared by intrusive/non-intrusive linked lists

Public class

TLinkedListIterator

Public class

TLinkedListIteratorBase

Public class

TList

TList .

Simple single-linked list template.

Public class

TLockFreeAllocOnceIndexedAllocator

Public class

TLockFreeClassAllocator

Thread safe, lock free pooling allocator of memory for instances of T.

Public class

TLockFreeClassAllocator_TLSCache

Thread safe, lock free pooling allocator of memory for instances of T.

Public class

TLockFreeFixedSizeAllocator

Thread safe, lock free pooling allocator of fixed size blocks that never returns free space until program shutdown.

Public class

TLockFreeFixedSizeAllocator_TLSCache

Thread safe, lock free pooling allocator of fixed size blocks that never returns free space, even at shutdown alignment isn't handled, assumes FMemory::Malloc will work

Public class

TLockFreeFixedSizeAllocator_TLSCacheBase

Public class

TLockFreePointerListFIFO

Public class

TLockFreePointerListLIFO

Public class

TLockFreePointerListLIFOPad

Public class

TLockFreePointerListUnordered

Public class

TLruCache

Implements a Least Recently Used (LRU) cache.

Public class

TMap

A TMapBase specialization that only allows a single value associated with each key.

Public class

TMapBase

The base class of maps from keys to values.

Public class

TMapBuilder

Template for fluent map builders.

Public class

TMRUArray

MRU array.

Public class

TMultiMap

A TMapBase specialization that allows multiple values to be associated with each key.

Public class

TPairInitializer

An initializer type for pairs that's passed to the pair set when adding a new pair.

Public class

TPassthruPointer

This seemingly-pointless class is intended to be API-compatible with TStringPassthru and is returned by StringPassthru when no string conversion is necessary.

Public class

TQueue

Template for queues.

Public class

TResourceArray

A array which allocates memory which can be used for UMA rendering resources.

Public class

TSet

Forward declaration.

Public class

TSetAllocator

Encapsulates the allocators used by a set in a single type.

Public class

TSetElement

An element in the set.

Public class

TSortableMapBase

The base type of sortable maps.

Public class

TSortedMap

A Map of keys to value, implemented as a sorted TArray of TPairs.

Public class

TSparseArray

Forward declarations.

Public class

TSparseArrayAllocator

Encapsulates the allocators used by a sparse array in a single type.

Public struct

TSparseArrayElementOrFreeListLink

Allocated elements are overlapped with free element info in the element list.

Public class

TStaticArray

An array with a static number of elements.

Public class

TStaticArray2

A shortcut for initializing a TStaticArray with 2 elements.

Public class

TStaticArray3

A shortcut for initializing a TStaticArray with 3 elements.

Public class

TStaticArray4

A shortcut for initializing a TStaticArray with 4 elements.

Public class

TStaticBitArray

A statically sized bit array.

Public class

TStaticBitReference

Used to read/write a bit in the static array as a bool.

Public class

TStaticHashTable

Statically sized hash table, used to index another data structure.

Public class

TStringConversion

Class takes one type of string and converts it to another.

Public class

TStringConvert

Public class

TStringPassthru

This class is returned by StringPassthru and is not intended to be used directly.

Public class

TStringPointer

This seemingly-pointless class is intended to be API-compatible with TStringConversion and is returned by StringCast when no string conversion is necessary.

Public class

TTransArray

Transactional array.

Public class

TTripleBuffer

Template for triple buffers.

Public struct

TTypeFromString

Public struct

TTypeToString

Deprecated alias for old LexicalConversion namespace.

Public class

TUnion

Represents a type which is the union of several other types; i.e. it can have a value whose type is of any the union's subtypes.

Typedefs

Name

Description

FTCHARToUTF8

These should be replaced with StringCasts when FPlatformString starts to know about UTF-8.

FTickerDelegate

Ticker delegates return true to automatically reschedule at the same delay or false for one-shot.

FUTF8ToTCHAR

TPair

Enums

Name

Description

Public enum

EQueueMode

Enumerates concurrent queue modes.

Public enum

EResourceAlignment

Alignment for supported resource types

Public enum

ESearchCase::Type

Noexport class

Public enum

ESearchDir::Type

Determines search direction for string operations.

String search dir used in UnrealString.h

Functions

Name Description

Public function

FString

 

BytesToHex

(
    const uint8 * In,
    int32 Count
)

Convert an array of bytes to hex

Hex value in string.

Public function

FString

 

BytesToString

(
    const uint8 * In,
    int32 Count
)

Convert an array of bytes to a TCHAR

Valid string representing bytes.

Public function

void

 

ByteToHex

(
    uint8 In,
    FString & Result
)

Convert a byte to hex

Public function

To

 

CharCast

(
    From Ch
)

Casts one fixed-width char type into another.

The converted character.

Public function

const bool

 

CheckTCharIsHex

(
    const TCHAR Char
)

Checks if the TChar is a valid hex character

Public function

int32

 

DefaultCalculateSlackGrow

(
    int32 NumElements,
    int32 NumAllocatedElements,
    SIZE_T BytesPerElement,
    bool bAllowQuantize,
    uint32 Alignment
)

Public function

int32

 

DefaultCalculateSlackReserve

(
    int32 NumElements,
    SIZE_T BytesPerElement,
    bool bAllowQuantize,
    uint32 Alignment
)

Public function

int32

 

DefaultCalculateSlackShrink

(
    int32 NumElements,
    int32 NumAllocatedElements,
    SIZE_T BytesPerElement,
    bool bAllowQuantize,
    uint32 Alignment
)

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1) voi...

 

DoTestCriticalStall()

#define checkLockFreePointerList(x) ((x)||((*(char*)3) = 0)

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)int3 ...

 

FindMatchingClosingParenthesis

(
    const FString & TargetString,
    const int32 StartSearch
)

A helper function to find closing parenthesis that matches the first open parenthesis found.

Public function

const TCHAR ...

 

GetData

(
    const FString & String
)

Public function

TCHAR *

 

GetData

(
    FString & String
)

Public function

SIZE_T

 

GetNum

(
    const FString & String
)

Public function

uint32

 

GetTypeHash

(
    const FString & S
)

Case insensitive string hash function.

Public function

int32

 

HexToBytes

(
    const FString & HexString,
    uint8 * OutBytes
)

Convert FString of Hex digits into the byte array.

Public function

ReferencedTy...

 

IfAThenAElseB

(
    ReferencedType* A,
    ReferencedType* B
)

Branchless pointer selection return A ? A : B;

Public function

ReferencedTy...

 

IfPThenAElseB

(
    PredicateType Predicate,
    ReferencedType* A,
    ReferencedType* B
)

Branchless pointer selection based on predicate return PTRINT(Predicate) ? A : B;

Public function

void

 

Lex::FromString

(
    FString & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    bool& OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    double& OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    float& OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    uint64 & OutValue,
    const TCHAR * Buffer
)

64 because this unsigned and so Atoi might overflow

Public function

void

 

Lex::FromString

(
    uint16 & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    uint8 & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    int64 & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    int32 & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    int16 & OutValue,
    const TCHAR * Buffer
)

Public function

void

 

Lex::FromString

(
    int8 & OutValue,
    const TCHAR * Buffer
)

Expected functions in this namespace are as follows: bool TryParseString(T& OutValue, const TCHAR* Buffer); void FromString(T& OutValue, const TCHAR* Buffer); =""> ToString(T); ^ Generally this means it can return either FString or const TCHAR* Generic code that uses ToString should assign to an FString or forward along to other functions that accept types that are also implicitly convertible to FString

Public function

void

 

Lex::FromString

(
    uint32 & OutValue,
    const TCHAR * Buffer
)

Public function

FString

 

Lex::ToSanitizedString

(
    double Value
)

Overloaded for doubles

Public function

FString

 

Lex::ToSanitizedString

(
    float Value
)

Overloaded for floats

Public function

FString

 

Lex::ToSanitizedString

(
    const T& Value
)

Helper template to convert to sanitized strings

Public function

FString

 

Lex::ToString

(
    FString && Str
)

Public function

FString

 

Lex::ToString

(
    const FString & Str
)

Public function

FString

 

Lex::ToString

(
    bool Value
)

Public function

TEnableIf < T ...

 

Lex::ToString

(
    const CharType* Ptr
)

Public function

TEnableIf < T ...

 

Lex::ToString

(
    const T& Value
)

Convert numeric types to a string

Public function Static

TEnableIf < T ...

 

Lex::TryParseString

(
    T& OutValue,
    const TCHAR * Buffer
)

Parse a string into this type, returning whether it was successful Specialization for arithmetic types

Public function Static

bool

 

Lex::TryParseString

(
    bool& OutValue,
    const TCHAR * Buffer
)

Try and parse a bool - always returns true

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1) voi...

 

LockFreeAllocLinks

(
    SIZE_T AllocSize
)

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1) voi...

 

LockFreeFreeLinks

(
    SIZE_T AllocSize,
    void* Ptr
)

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1) voi...

 

LockFreeLinksExhausted

(
    uint32 TotalNum
)

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1) voi...

 

LockFreeTagCounterHasOverflowed()

Public function

TArrayView < ...

 

MakeArrayView

(
    ElementType* Pointer,
    int32 Size
)

Public function

TArrayView < ...

 

MakeArrayView

(
    std::initializer_list< ElementType ...
)

Public function

TArrayView < ...

 

MakeArrayView

(
    const TArray < ElementType, Allocato...
)

Public function

TArrayView < ...

 

MakeArrayView

(
    TArray < ElementType, Allocator >& ...
)

Public function

TArrayView < ...

 

MakeArrayView

(
    ElementType(&) Other
)

Public function

TArrayView < ...

 

MakeArrayView

(
    const ElementType(&) Other
)

Public function

TStaticArray ...

 

MakeUniformStaticArray

(
    typename TCallTraits < TElement >::P...
)

Creates a static array filled with the specified value.

Public function

void

 

MoveByRelocate

(
    T& A,
    T& B
)

This is used to provide type specific behavior for a move which will destroy B.

Public function Static

uint32

 

Murmur32

(
    std::initializer_list< uint32 > Ini...
)

Public function

TCHAR

 

NibbleToTChar

(
    uint8 Num
)

Char value of Nibble

Public function

void *

 

operator new

(
    size_t Size,
    TArray < T, Allocator >& Array
)

Array operator news.

Public function

void *

 

operator new

(
    size_t Size,
    TTransArray < T >& Array,
    int32 Index
)

Public function

void *

 

operator new

(
    size_t Size,
    TIndirectArray < T, Allocator >& Ar...,
    int32 Index
)

Public function

void *

 

operator new

(
    size_t Size,
    TArray < T, Allocator >& Array,
    int32 Index
)

Public function

void *

 

operator new

(
    size_t Size,
    TTransArray < T >& Array
)

Transactional array operator news.

Public function

void *

 

operator new

(
    size_t Size,
    TChunkedArray < T, TargetBytesPerChu...
)

Public function

void *

 

operator new

(
    size_t Size,
    TIndirectArray < T, Allocator >& Ar...
)

Public function

void *

 

operator new

(
    size_t Size,
    const FSparseArrayAllocationInfo & ...
)

A placement new operator which constructs an element in a sparse array allocation.

Public function

TIndexedCont ...

 

operator+

(
    int32 Offset,
    TIndexedContainerIterator < Containe...
)

Operator +

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)FStr ...

 

SlugStringForValidName

(
    const FString & DisplayString
)

Given a display label string, generates an FString slug that only contains valid characters for an FName .

Public function

TEnableIf <&#...

 

StringCast

(
    const From* Str,
    int32 Len
)

Creates an object which acts as a source of a given string type. See example above.

Public function

TEnableIf < F...

 

StringCast

(
    const From* Str
)

StringCast example usage:

Public function

TEnableIf <&#...

 

StringCast

(
    const From* Str
)

Creates an object which acts as a source of a given string type. See example above.

Public function

TEnableIf < F...

 

StringCast

(
    const From* Str,
    int32 Len
)

Creates an object which acts as a source of a given string type. See example above.

Public function

TEnableIf < F...

 

StringMemoryPassthru

(
    To* Buffer,
    int32 BufferSize,
    int32 SourceLength
)

Allows the efficient conversion of strings by means of a temporary memory buffer only when necessary.

Public function

TEnableIf <&#...

 

StringMemoryPassthru

(
    To* Buffer,
    int32 BufferSize,
    int32 SourceLength
)

Public function

TArray < ToTy...

 

StringToArray

(
    const FromType* Src,
    int32 SrcLen
)

Public function

TArray < ToTy...

 

StringToArray

(
    const FromType* Str
)

Public function

int32

 

StringToBytes

(
    const FString & String,
    uint8 * OutBytes,
    int32 MaxBufferSize
)

Convert FString of bytes into the byte array.

Public function

const uint8

 

TCharToNibble

(
    const TCHAR Char
)

Convert a TChar to equivalent hex value as a uint8

Public function

void

 

TestCriticalStall()

Variables

Name Description

Public variable

 

CORE_API

Public variable

 

CORE_API

Public variable

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)int32

 

GTestCriticalStalls

Public variable

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)ITransa ...

 

GUndo

Configuration database cache