Containers

Windows
MacOS
Linux

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

FBackgroundableTicker

This works the same as the core FTicker, but on supported mobile platforms it continues ticking while the app is running in the background.

Public class

FBinaryHeap

Copyright (C) 2009 Nine Realms, Inc

Public class

FBitArrayMemory

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 struct

FCountingOutputIterator

This is a basic object which counts how many times it has been incremented

Public class

FDefaultBitArrayAllocator

Public class

FDefaultSetAllocator

Public class

FDefaultSparseArrayAllocator

Public class

FHashTable

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

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

Public class

FScriptBitArray

Public struct

FScriptContainerElement

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

Public class

FScriptMap

Public struct

FScriptMapLayout

Public class

FScriptSet

Public struct

FScriptSetLayout

Public class

FScriptSparseArray

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

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 struct

FTextRange

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

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

TBasicArray

Basic RAII array which can be used without the excessive dependencies needed by TArray, which needs to be serialisable, have a fixed ABI, have lots of helper algorithms as members, have auto-shrinking, support allocators etc.

Public class

TBitArray

Forward declaration.

Public struct

TBitsToSizeType

Public struct

TCanBulkSerialize

Public struct

TCanMoveBetweenAllocators

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 struct

TCompatibleStringViewType

Public class

TConstDualSetBitIterator

An iterator which only iterates over the bits which are set in both of two bit-arrays, if the Both template argument is true, or either if the argument is false.

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

TDiscardableKeyValueCache

Implements a thread-safe discardable Key/Value cache by using two maps - a primary and a backfill.

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

TFixedSetAllocator

An inline set allocator that doesn't have any secondary storage.

Public class

TFixedSparseArrayAllocator

An inline sparse array allocator that doesn't have any secondary storage.

Public class

THashTable

Public class

TIndexedContainerIterator

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

Public class

TIndirectArray

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

TIsCompatibleRangeType

Trait testing whether a type is compatible with the view type

Public struct

TIsConvertibleFromTo

Public struct

TIsConvertibleToStringView

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 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

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 struct

TMakeSigned

PUBLIC_RINGBUFFER_TODO: Move TMakeSigned and TMakeUnsigned into MakeSigned.h.

Public struct

TMakeUnsigned

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

Same as TArray except:

Public class

TMultiMap

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

Public class

TNonRelocatableInlineAllocator

Implements a variant of TInlineAllocator with a secondary heap allocator that is allowed to store a pointer to its inline elements.

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

TRingBuffer

Copyright Epic Games, Inc. All Rights Reserved.

Public class

TScriptArray

Base dynamic array.

Public class

TScriptBitArray

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

Public class

TScriptMap

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

Public class

TScriptSet

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

Public class

TScriptSparseArray

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

Public class

TSet

A set with an optional KeyFuncs parameters for customizing how the elements are compared and searched.

Public class

TSetAllocator

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

Public class

TSetElement

An element in the set.

Public class

TSetElementBase

Public class

TSizedDefaultAllocator

'typedefs' for various allocator defaults.

Public class

TSizedHeapAllocator

The indirect allocation policy always allocates the elements indirectly.

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

Sparse array allocation definitionsEncapsulates 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

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

Public class

TStringBuilderBase

String Builder

Public class

TStringBuilderWithBuffer

A string builder with inline storage.

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

Class takes one type of string and and stores it as-is.

Public class

TStringView

A fixed-size string builder for TCHAR.

Public class

TTransArray

You need to do it, you will have to fix up FTransaction::FObjectRecord to use the correct TArray.

Public class

TTripleBuffer

Template for triple buffers.

Public struct

TTypeFromString

Public struct

TTypeToString

Shorthand legacy use for Lex functions

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.

Public class

TUTF16ToUTF32_Convert

Public class

TUTF32ToUTF16_Convert

Typedefs

Name

Description

FAnsiStringBuilderBase

The base string builder type for ANSICHAR.

FAnsiStringView

FDefaultAllocator

FHeapAllocator

FStringBuilderBase

The base string builder type for TCHAR.

FStringFormatNamedArguments

FStringFormatOrderedArguments

FStringView

FTCHARToUTF16

Special handling for platforms still using a 32-bit TCHAR

FTCHARToUTF32

FTCHARToUTF8

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

FTCHARToWChar

Special handling for going from char16_t to wchar_t for third party libraries that need wchar_t

FTickerDelegate

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

FUTF16ToTCHAR

FUTF32ToTCHAR

FUTF8ToTCHAR

FWCharToTCHAR

FWideStringBuilderBase

The base string builder type for WIDECHAR.

FWideStringView

TAnsiStringBuilder

An extendable string builder for ANSICHAR.

TArrayElementsAreCompatible

Assume elements are compatible with themselves - avoids problems with generated copy constuctors of arrays of forwarded types, e.g.:

TConstDualBothSetBitIterator

A specialization of TConstDualSetBitIterator for iterating over two TBitArray containers and stop only when bits in the same location in each are both set.

TConstDualEitherSetBitIterator

A specialization of TConstDualSetBitIterator for iterating over two TBitArray containers and stop only when either, or both, of the bits in the same location in each are set.

TPair

TStringBuilder

An extendable string builder for TCHAR.

TWideStringBuilder

An extendable string builder for WIDECHAR.

Enums

Name

Description

Public enum

EBitwiseOperatorFlags

Flag enumeration for control bitwise operator functionality

Public enum

EQueueMode

Enumerates concurrent queue modes.

Public enum

EResourceAlignment

Alignment for supported resource types

Functions

Name Description

Public function

decltype(aut...

 

ArrayViewPrivate::GetDataHelper

(
    T&& Arg
)

Simply forwards to an unqualified GetData(), but can be called from within TArrayView where GetData() is already a member and so hides any others.

Public function

FString

 

BytesToHex

(
    const uint8* In,
    int32 Count
)

Convert an array of bytes to hex

Public function

FString

 

BytesToString

(
    const uint8* In,
    int32 Count
)

Convert an array of bytes to a TCHAR

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.

Public function

const bool

 

CheckTCharIsHex

(
    const TCHAR Char
)

Checks if the TChar is a valid hex character

Public function

SizeType

 

DefaultCalculateSlackGrow

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

Public function

SizeType

 

DefaultCalculateSlackReserve

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

Public function

SizeType

 

DefaultCalculateSlackShrink

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

Public function

void

 

DoTestCriticalStall()

Public function

int32

 

FindMatchingClosingParenthesis

(
    const FString& TargetString,
    const int32 StartSearch
)

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

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TMap< KeyType, ValueType, Set...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TMultiMap< KeyType, ValueType...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TSet< ElementType, KeyFuncs, ...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TSparseArray< ElementType, Al...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const TArray< T, AllocatorType >&#...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicAppendHash

(
    const THashTable< InAllocator >...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FSHA1& Hasher
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const THashTable< InAllocator >...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

uint32

 

Freeze::IntrinsicGetTargetAlignment

(
    const TArray< T, AllocatorType >&#...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...
)

Public function

void

 

Freeze::IntrinsicToString

(
    const TArray< T, AllocatorType >& ...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TSparseArray< ElementType, Al...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TSet< ElementType, KeyFuncs, ...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TMultiMap< KeyType, ValueType...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TMap< KeyType, ValueType, Set...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const THashTable< InAllocator >& O...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicUnfrozenCopy

(
    const FMemoryUnfreezeContent& Cont...,
    const TArray< T, AllocatorType >& ...,
    void* OutDst
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TBitArray< Allocator >& Obje...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TArray< T, AllocatorType >& ...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TMap< KeyType, ValueType, Set...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TSet< ElementType, KeyFuncs, ...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TSparseArray< ElementType, Al...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const THashTable< InAllocator >& O...,
    const FTypeLayoutDesc&
)

Public function

void

 

Freeze::IntrinsicWriteMemoryImage

(
    FMemoryImageWriter& Writer,
    const TMultiMap< KeyType, ValueType...,
    const FTypeLayoutDesc&
)

Public function

TCHAR *

 

GetData

(
    FString&
)

Public function

const TCHAR ...

 

GetData

(
    const FString&
)

Public function

constexpr au...

 

GetNum

(
    TStringView< CharType > String
)

Public function

int32

 

GetNum

(
    const FString& String
)

Public function

uint32

 

GetTypeHash

(
    const TBitArray< Allocator >& BitA...
)

Public function

uint32

 

GetTypeHash

(
    TStringView< CharType > View
)

Case insensitive string hash function.

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

 

LexFromString

(
    int64& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    int8& OutValue,
    const TCHAR* Buffer
)

Generalized API to convert something to a string.

Public function

void

 

LexFromString

(
    uint8& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    uint16& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    uint32& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    float& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    double& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    bool& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    FString& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    int32& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    int16& OutValue,
    const TCHAR* Buffer
)

Public function

void

 

LexFromString

(
    uint64& OutValue,
    const TCHAR* Buffer
)

Public function

FString

 

LexToSanitizedString

(
    const T& Value
)

Helper template to convert to sanitized strings

Public function

FString

 

LexToSanitizedString

(
    float Value
)

Overloaded for floats

Public function

FString

 

LexToSanitizedString

(
    double Value
)

Overloaded for doubles

Public function

TEnableIf< T...

 

LexToString

(
    const T& Value
)

Convert numeric types to a string

Public function

TEnableIf< T...

 

LexToString

(
    const CharType* Ptr
)

Public function

FString

 

LexToString

(
    bool Value
)

Public function

FString

 

LexToString

(
    FString&& Str
)

Public function

FString

 

LexToString

(
    const FString& Str
)

Public function Static

bool

 

LexTryParseString

(
    bool& OutValue,
    const TCHAR* Buffer
)

Try and parse a bool - always returns true

Public function Static

TEnableIf< T...

 

LexTryParseString

(
    T& OutValue,
    const TCHAR* Buffer
)

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

Public function

void *

 

LockFreeAllocLinks

(
    SIZE_T AllocSize
)

Public function

void

 

LockFreeFreeLinks

(
    SIZE_T AllocSize,
    void* Ptr
)

Public function

void

 

LockFreeLinksExhausted

(
    uint32 TotalNum
)

Public function

void

 

LockFreeTagCounterHasOverflowed()

Public function

auto

 

MakeArrayView

(
    ElementType* Pointer,
    int32 Size
)

Public function

auto

 

MakeArrayView

(
    OtherRangeType&& Other
)

Public function

TArrayView< ...

 

MakeArrayView

(
    std::initializer_list< T > List
)

Public function

TStaticArray...

 

MakeUniformStaticArray

(
    typename TCallTraits< InElementType...
)

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 Static

uint32

 

MurmurFinalize32

(
    uint32 Hash
)

Public function Static

uint64

 

MurmurFinalize64

(
    uint64 Hash
)

Public function

TCHAR

 

NibbleToTChar

(
    uint8 Num
)

Returns Char value of Nibble

Public function

void *

 

operator new

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

Public function

void *

 

operator new

(
    size_t Size,
    TSparseArray< T, Allocator >& Arra...,
    int32 Index
)

Public function

void *

 

operator new

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

Placement new on TIndirectArray has been deprecated - users should call Insert() passing a pointer to an object created with new.

Public function

void *

 

operator new

(
    size_t Size,
    TArray< T, Allocator >& Array,
    typename TArray< T, Allocator >::Si...
)

Public function

void *

 

operator new

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

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...
)

Placement new on TIndirectArray has been deprecated - users should call Add() passing a pointer to an object created with new.

Public function

void *

 

operator new

(
    size_t Size,
    TSparseArray< T, Allocator >& Arra...
)

TSparseArray operator news.

Public function

void *

 

operator new

(
    size_t Size,
    TTransArray< T >& Array
)

Transactional array operator news.

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

constexpr bo...

 

operator!

(
    EBitwiseOperatorFlags E
)

Public function

auto

 

operator!=

(
    CharRangeType&& Lhs,
    TStringView< CharType > Rhs
)

Public function

bool

 

operator!=

(
    TStringView< CharType > Lhs,
    const CharType* Rhs
)

Public function

bool

 

operator!=

(
    const CharType* Lhs,
    TStringView< CharType > Rhs
)

Public function

bool

 

operator!=

(
    TStringView< CharType > Lhs,
    TStringView< CharType > Rhs
)

Public function

bool

 

operator!=

(
    TArrayView< ElementType > Lhs,
    RangeType&& Rhs
)

Public function

bool

 

operator!=

(
    RangeType&& Lhs,
    TArrayView< ElementType > Rhs
)

Inequality operator.

Public function

bool

 

operator!=

(
    TArrayView< ElementType, SizeType >,
    TArrayView< OtherElementType, Other...
)

Public function

auto

 

operator!=

(
    TStringView< CharType > Lhs,
    CharRangeType&& Rhs
)

Public function

constexpr FA...

 

operator""_ASV

(
    const ANSICHAR* String,
    size_t Size
)

Public function

constexpr FS...

 

operator""_SV

(
    const TCHAR* String,
    size_t Size
)

Public function

constexpr FW...

 

operator""_WSV

(
    const WIDECHAR* String,
    size_t Size
)

Public function

constexpr EB...

 

operator&

(
    EBitwiseOperatorFlags Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

EBitwiseOper...

 

operator&=

(
    EBitwiseOperatorFlags& Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

constexpr EB...

 

operator^

(
    EBitwiseOperatorFlags Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

EBitwiseOper...

 

operator^=

(
    EBitwiseOperatorFlags& Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

constexpr EB...

 

operator|

(
    EBitwiseOperatorFlags Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

EBitwiseOper...

 

operator|=

(
    EBitwiseOperatorFlags& Lhs,
    EBitwiseOperatorFlags Rhs
)

Public function

constexpr EB...

 

operator~

(
    EBitwiseOperatorFlags E
)

Public function

TIndexedCont...

 

operator+

(
    SizeType Offset,
    TIndexedContainerIterator< Containe...
)

Operator +

Public function

bool

 

operator==

(
    const CharType* Lhs,
    TStringView< CharType > Rhs
)

Public function

bool

 

operator==

(
    TStringView< CharType > Lhs,
    const CharType* Rhs
)

Public function

auto

 

operator==

(
    CharRangeType&& Lhs,
    TStringView< CharType > Rhs
)

Public function

auto

 

operator==

(
    TStringView< CharType > Lhs,
    CharRangeType&& Rhs
)

Public function

bool

 

operator==

(
    TStringView< CharType > Lhs,
    TStringView< CharType > Rhs
)

Public function

bool

 

operator==

(
    TArrayView< ElementType > Lhs,
    RangeType&& Rhs
)

Public function

bool

 

operator==

(
    RangeType&& Lhs,
    TArrayView< ElementType > Rhs
)

Equality operator.

Public function

bool

 

operator==

(
    TArrayView< ElementType, SizeType >,
    TArrayView< OtherElementType, Other...
)

Comparison of array views to each other is not implemented because it is not obvious whether the caller wants an exact match of the data pointer and size, or to compare the objects being pointed to.

Public function

FString

 

SlugStringForValidName

(
    const FString& DisplayString,
    const TCHAR* ReplaceWith
)

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,
    int32 Len
)

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

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
)

StringCast example usage:

Public function Static

void

 

StringConv::DecodeSurrogate

(
    const uint32 Codepoint,
    uint16& OutHighSurrogate,
    uint16& OutLowSurrogate
)

Public function Static

uint32

 

StringConv::EncodeSurrogate

(
    const uint16 HighSurrogate,
    const uint16 LowSurrogate
)

Public function

void

 

StringConv::InlineCombineSurrogates

(
    FString& Str
)

Inline combine any UTF-16 surrogate pairs in the given string

Public function Static

void

 

StringConv::InlineCombineSurrogates_Array

(
    TArray< TCHAR, AllocatorType >& St...
)

Inline combine any UTF-16 surrogate pairs in the given null-terminated TCHAR array

Public function Static

int32

 

StringConv::InlineCombineSurrogates_Buffer

(
    CharType* StrBuffer,
    int32 StrLen
)

Inline combine any UTF-16 surrogate pairs in the given null-terminated character buffer, returning the updated length

Public function Static

bool

 

StringConv::IsEncodedSurrogate

(
    const uint32 Codepoint
)

Is the provided Codepoint outside of the range of the basic multilingual plane, but within the valid range of UTF8/16?

Public function Static

bool

 

StringConv::IsHighSurrogate

(
    const uint32 Codepoint
)

Is the provided Codepoint within the range of the high-surrogates?

Public function Static

bool

 

StringConv::IsLowSurrogate

(
    const uint32 Codepoint
)

Is the provided Codepoint within the range of the low-surrogates?

Public function Static

bool

 

StringConv::IsValidCodepoint

(
    const uint32 Codepoint
)

Is the provided Codepoint within the range of valid codepoints?

Public function

TEnableIf<&#...

 

StringMemoryPassthru

(
    To* Buffer,
    int32 BufferSize,
    int32 SourceLength
)

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

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

constexpr au...

 

StringViewPrivate::WrapGetData

(
    ArgTypes&&... Args
)

Wrapper to allow GetData to resolve from within a scope with another overload.

Public function

const uint8

 

TCharToNibble

(
    const TCHAR Hex
)

Convert a TChar to equivalent hex value as a uint8

Public function

void

 

TestCriticalStall()

Public function

const TCHAR ...

 

ToCStr

(
    const TCHAR* Ptr
)

Gets a non-owning TCHAR pointer from a string type.

Public function

const TCHAR ...

 

ToCStr

(
    const FString& Str
)

Variables

Name Description

Public variable

constexpr const...

 

ENCODED_SURROGATE_END_CODEPOINT

Public variable

constexpr const...

 

ENCODED_SURROGATE_START_CODEPOINT

Public variable

int32

 

GTestCriticalStalls

Public variable

ITransaction &#...

 

GUndo

Public variable

constexpr const...

 

HIGH_SURROGATE_END_CODEPOINT

Public variable

constexpr const...

 

HIGH_SURROGATE_START_CODEPOINT

Public variable

constexpr const...

 

LOW_SURROGATE_END_CODEPOINT

Public variable

constexpr const...

 

LOW_SURROGATE_START_CODEPOINT
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss