Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Memory > FArenaPointer

Light Theme

Dark Theme

FArenaPointer

Tagged Arena Pointer

Windows

MacOS

Linux

Inheritance Hierarchy

FArenaPointer

TArenaPointer

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Memory/MemoryArena.h
Include	#include "Memory/MemoryArena.h"

Syntax

class FArenaPointer

Remarks

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.

Constructors

	Name	Description
	FArenaPointer()
	FArenaPointer ( void* InPtr, uint16 InArenaTag )

Functions

		Name	Description
	FMemoryArena...	Arena()
	const uint16	ArenaIndex()
	void	Free()
	void *	Pointer()
	const void &...	Pointer()
	void	SetPointerAndArena ( void* InPtr, uint16 InArenaTag )

Operators

		Name	Description
		operator bool()

Constants

Name	Description
NoTag

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

Take our survey

Dismiss