Navigation
API > API/Runtime > API/Runtime/Core
Tagged Arena Pointer
Stores an arena ID alongside a pointer. On 64-bit architectures the arena ID can be encoded in the otherwise unused MSB part of the pointer for zero memory overhead vs a regular pointer. For 32-bit architectures the arena ID is stored in a separate member.
A null pointer can still have an arena ID, which is useful for cases where you have a container that starts out empty but still want to track which arena should be used for subsequent allocations.
| Name | FArenaPointer |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Memory/MemoryArena.h |
| Include Path | #include "Memory/MemoryArena.h" |
Syntax
class FArenaPointer
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Memory/MemoryArena.h | |||
FArenaPointer
(
void* InPtr, |
Memory/MemoryArena.h |
Enums
Public
| Name | Remarks |
|---|---|
| FArenaPointer |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArenaTag | uint16 | Memory/MemoryArena.h | ||
| Ptr | void * | Memory/MemoryArena.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMemoryArena & Arena() |
Memory/MemoryArena.h | ||
void Free() |
Memory/MemoryArena.h | ||
const uint16 GetArenaIndex() |
Memory/MemoryArena.h | ||
void * GetPointer () |
Memory/MemoryArena.h | ||
const void * GetPointer () |
Memory/MemoryArena.h | ||
void SetPointerAndArena
(
void* InPtr, |
Memory/MemoryArena.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Memory/MemoryArena.h |