UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMemoryImageAllocatorBase Class Reference

#include <MemoryImage.h>

+ Inheritance diagram for FMemoryImageAllocatorBase:

Public Member Functions

 FMemoryImageAllocatorBase ()=default
 
CORE_API void MoveToEmpty (FMemoryImageAllocatorBase &Other)
 
CORE_API ~FMemoryImageAllocatorBase ()
 
UE_FORCEINLINE_HINT FScriptContainerElementGetAllocation () const
 
UE_FORCEINLINE_HINT SIZE_T GetAllocatedSize (int32 CurrentMax, SIZE_T NumBytesPerElement) const
 
UE_FORCEINLINE_HINT bool HasAllocation ()
 
UE_FORCEINLINE_HINT int64 GetFrozenOffsetFromThis () const
 
CORE_API void ResizeAllocation (int32 PreviousNumElements, int32 NumElements, SIZE_T NumBytesPerElement, uint32 Alignment)
 
CORE_API void WriteMemoryImage (FMemoryImageWriter &Writer, const FTypeLayoutDesc &TypeDesc, int32 NumAllocatedElements, uint32 Alignment) const
 
CORE_API void ToString (const FTypeLayoutDesc &TypeDesc, int32 NumAllocatedElements, int32 MaxAllocatedElements, const FPlatformTypeLayoutParameters &LayoutParams, FMemoryToStringContext &OutContext) const
 
CORE_API void CopyUnfrozen (const FMemoryUnfreezeContent &Context, const FTypeLayoutDesc &TypeDesc, int32 NumAllocatedElements, void *Dst) const
 

Constructor & Destructor Documentation

◆ FMemoryImageAllocatorBase()

FMemoryImageAllocatorBase::FMemoryImageAllocatorBase ( )
default

◆ ~FMemoryImageAllocatorBase()

FMemoryImageAllocatorBase::~FMemoryImageAllocatorBase ( )

Destructor.

Member Function Documentation

◆ CopyUnfrozen()

void FMemoryImageAllocatorBase::CopyUnfrozen ( const FMemoryUnfreezeContent Context,
const FTypeLayoutDesc TypeDesc,
int32  NumAllocatedElements,
void Dst 
) const

◆ GetAllocatedSize()

UE_FORCEINLINE_HINT SIZE_T FMemoryImageAllocatorBase::GetAllocatedSize ( int32  CurrentMax,
SIZE_T  NumBytesPerElement 
) const
inline

◆ GetAllocation()

UE_FORCEINLINE_HINT FScriptContainerElement * FMemoryImageAllocatorBase::GetAllocation ( ) const
inline

◆ GetFrozenOffsetFromThis()

UE_FORCEINLINE_HINT int64 FMemoryImageAllocatorBase::GetFrozenOffsetFromThis ( ) const
inline

◆ HasAllocation()

UE_FORCEINLINE_HINT bool FMemoryImageAllocatorBase::HasAllocation ( )
inline

◆ MoveToEmpty()

void FMemoryImageAllocatorBase::MoveToEmpty ( FMemoryImageAllocatorBase Other)

Moves the state of another allocator into this one. Assumes that the allocator is currently empty, i.e. memory may be allocated but any existing elements have already been destructed (if necessary).

Parameters
Other- The allocator to move the state from. This allocator should be left in a valid empty state.

◆ ResizeAllocation()

void FMemoryImageAllocatorBase::ResizeAllocation ( int32  PreviousNumElements,
int32  NumElements,
SIZE_T  NumBytesPerElement,
uint32  Alignment 
)

◆ ToString()

void FMemoryImageAllocatorBase::ToString ( const FTypeLayoutDesc TypeDesc,
int32  NumAllocatedElements,
int32  MaxAllocatedElements,
const FPlatformTypeLayoutParameters LayoutParams,
FMemoryToStringContext OutContext 
) const

◆ WriteMemoryImage()

void FMemoryImageAllocatorBase::WriteMemoryImage ( FMemoryImageWriter Writer,
const FTypeLayoutDesc TypeDesc,
int32  NumAllocatedElements,
uint32  Alignment 
) const

The documentation for this class was generated from the following files: