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

Light Theme

Dark Theme

FMemoryChunk

Contains information of a single allocation or free block.

Windows

MacOS

Linux

References

Module	RHI
Header	/Engine/Source/Runtime/RHI/Public/GPUDefragAllocator.h
Include	#include "GPUDefragAllocator.h"

Syntax

class FMemoryChunk

Remarks

Contains information of a single allocation or free block.

Variables

	Name	Description
uint8 *	Base	Base of chunk.
FGPUDefragAlloc...	BestFitAllocator	Allows access to FBestFitAllocator members such as FirstChunk, FirstFreeChunk and LastChunk.
bool	bIsAvailable	Whether the chunk is available.
bool	bTail
uint16	DefragCounter	Defrag counter. If this chunk failed to defrag, it won't try it again until the counter is 0.
int32	LockCount	Whether the chunk has been locked.
FMemoryChunk &#...	NextChunk	Pointer to next chunk.
FMemoryChunk &#...	NextFreeChunk	Pointer to next free chunk.
int64	OrigSize
FMemoryChunk &#...	PreviousChunk	Pointer to previous chunk.
FMemoryChunk &#...	PreviousFreeChunk	Pointer to previous free chunk.
int64	Size	Size of chunk.
TStatId	Stat	Stat associated with this allocation
uint32	SyncIndex	SyncIndex that must be exceeded before accessing the data within this chunk.
int64	SyncSize	Number of uint8s covered by the SyncIndex (starting from the beginning of the chunk).
void *	UserPayload	User payload, e.g. platform-specific texture Pointer. Only chunks with payload can be relocated.

Constructors

	Name	Description
	FMemoryChunk ( uint8* InBase, int64 InSize, FGPUDefragAllocator& InBestFitAllo..., FMemoryChunk*& ChunkToInsertAf..., TStatId InStat )	Private constructor.

Destructors

	Name	Description
	~FMemoryChunk()	Unlinks/ removes the chunk from the linked lists it belongs to.

Functions

	Name	Description
uint64	Compare ( const FMemoryChunk* A, const FMemoryChunk* B )	Comparison function for Sort(), etc, based on increasing base address.
int64	GetAvailableSize()	Returns the number of uint8s that can be allocated from this chunk.
int64	GetFinalSize()	Returns the current size (in uint8s), or the final size if it has a reallocating request.
uint32	GetSyncIndex()	Returns the relocation sync index.
bool	IsLocked()
bool	IsRelocating()	Returns true if the Chunk is being asynchronously relocated due to reallocation or defrag.
void	Link ( FMemoryChunk*& ChunkToInsertAf... )	Inserts this chunk after the passed in one.
void	LinkFree ( FMemoryChunk* FirstFreeChunkTo... )	Inserts this chunk at the head of the free chunk list.
void	SetSyncIndex ( uint32 InSyncIndex, int64 InSyncSize )	Sets the relocation sync index.
void	Unlink()	Removes itself for linked list.
void	UnlinkFree()	Removes itself for linked "free" list. Maint32ains the free-list order.

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

Take our survey

Dismiss