Open 3D Engine AzCore API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AllocateAddress Struct Reference

#include <IAllocator.h>

Public Member Functions

 AllocateAddress ()=default
 default an empty address object
 
 AllocateAddress (void *address, size_t size)
 constructs an allocate address out of a void* and size
 
 AllocateAddress (const AllocateAddress &)=default
 default copy constructor and assignment operator
 
AllocateAddressoperator= (const AllocateAddress &)=default
 
void * GetAddress () const
 
size_t GetAllocatedBytes () const
 
 operator void * () const
 
template<class T >
 operator T* () const
 
 operator bool () const
 

Public Attributes

void * m_value {}
 Store allocated memory address.
 
size_t m_size {}
 Stores the amount of bytes allocated.
 

Detailed Description

Wraps an allocated memory address in a struct that is convertible to a void pointer This is used to allow implicit conversion of the IAllocate::allocate function to a void pointer to maintain backwards compatibility, while providing the ability for newer code to get access to the actual amount of bytes allocated. This can be used by wrapping allocators to track memory

Member Function Documentation

◆ operator T*()

template<class T >
AllocateAddress::operator T* ( ) const
inlineexplicit

explicit T* operator which is used for explicit casting from an AllocateAddress to a T* pointer

◆ operator void *()

AllocateAddress::operator void * ( ) const
inline

implicit void* operator allows assigning an AllocateAddress directly to a void*


The documentation for this struct was generated from the following file: