ezEngine Release 26.3
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
ezInstanceDataAllocator Class Reference

Manages complex multi-type instance data allocation with proper construction and destruction. More...

#include <InstanceDataAllocator.h>

Public Member Functions

ezUInt32 AddDesc (const ezInstanceDataDesc &desc)
 Adds the given desc to internal list of data that needs to be allocated and returns the byte offset.
 
void ClearDescs ()
 Resets all internal state.
 
void Construct (ezByteBlobPtr blobPtr) const
 Constructs the instance data objects, within the pre-allocated memory block.
 
void Destruct (ezByteBlobPtr blobPtr) const
 Destructs the instance data objects.
 
ezBlob AllocateAndConstruct () const
 Allocates memory and constructs the instance data objects inside it. The returned ezBlob must be stored somewhere.
 
void DestructAndDeallocate (ezBlob &ref_blob) const
 Destructs and deallocates the instance data objects and the given memory block.
 
ezUInt32 GetTotalDataSize () const
 The total size in bytes taken up by all instance data objects that were added.
 

Static Public Member Functions

static EZ_ALWAYS_INLINE void * GetInstanceData (const ezByteBlobPtr &blobPtr, ezUInt32 uiOffset)
 Retrieves a void pointer to the instance data within the given blob at the given offset, or nullptr if the offset is invalid.
 

Detailed Description

Manages complex multi-type instance data allocation with proper construction and destruction.

This allocator is designed for systems that need to allocate heterogeneous data structures in a single memory block, such as VM instances, state machines, or script execution contexts. It calculates proper alignments for mixed data types and handles construction/destruction automatically.

Typical workflow:

  1. Use AddDesc() to register all data types needed for an instance
  2. Call AllocateAndConstruct() to create initialized memory
  3. Use GetInstanceData() to access individual data by offset
  4. Call DestructAndDeallocate() when the instance is no longer needed
The documentation for this class was generated from the following files: