Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Friends | List of all members
AZ::AllocatorPointerWrapper Class Reference

#include <AllocatorWrappers.h>

Inherits AZ::IAllocator.

Public Member Functions

 AllocatorPointerWrapper (IAllocator *allocator=nullptr)
 
 AllocatorPointerWrapper (IAllocator &allocator)
 
 AllocatorPointerWrapper (const AllocatorPointerWrapper &aOther)
 
pointer allocate (size_type byteSize, align_type alignment=1) override
 
void deallocate (pointer ptr, size_type byteSize=0, align_type=0) override
 
pointer reallocate (pointer ptr, size_type newSize, align_type alignment=1) override
 
size_type get_allocated_size (pointer ptr, align_type alignment=1) const override
 
AllocatorPointerWrapper & operator= (IAllocator *allocator)
 
AllocatorPointerWrapper & operator= (IAllocator &allocator)
 
AllocatorPointerWrapper & operator= (const AllocatorPointerWrapper &allocator)
 
- Public Member Functions inherited from AZ::IAllocator
 AZ_RTTI (IAllocator, "{0A3C59AE-169C-45F6-9423-3B8C89245E2E}")
 
 IAllocator (const IAllocator &)=delete
 
 IAllocator (IAllocator &&)=delete
 
IAllocator & operator= (const IAllocator &)=delete
 
IAllocator & operator= (IAllocator &&)=delete
 
virtual pointer allocate (size_type byteSize, align_type alignment=1)=0
 
virtual void deallocate (pointer ptr, size_type byteSize=0, align_type alignment=0)=0
 
virtual pointer reallocate (pointer ptr, size_type newSize, align_type newAlignment=1)=0
 
virtual size_type max_size () const
 
virtual size_type get_allocated_size (pointer ptr, align_type alignment=1) const =0
 
virtual void GarbageCollect ()
 
const char * GetName () const
 
pointer Allocate (size_type byteSize, size_type alignment=1, int flags=0, const char *name=nullptr, const char *fileName=nullptr, int lineNum=0, unsigned int suppressStackRecord=0)
 
void DeAllocate (pointer ptr, size_type byteSize=0, size_type alignment=0)
 
 AZ_DEPRECATED_MESSAGE ("Resize no longer supported, use reallocate instead, note that the pointer address could change, " "Allocators should do best effort to keep the ptr at the same address") size_type Resize(pointer ptr
 
pointer ReAllocate (pointer ptr, size_type newSize, size_type newAlignment)
 
size_type AllocationSize (pointer ptr)
 Returns allocation size for given address. 0 if the address doesn't belong to the allocator.
 
virtual size_type NumAllocatedBytes () const
 
size_type Capacity () const
 
size_type GetMaxAllocationSize () const
 Returns max allocation size if possible. If not returned value is 0.
 
size_type GetMaxContiguousAllocationSize () const
 Returns the maximum contiguous allocation size of a single allocation.
 
size_type GetUnAllocatedMemory (bool isPrint=false) const
 
virtual AllocatorDebugConfig GetDebugConfig ()
 Returns the debug configuration for this allocator.
 
virtual const Debug::AllocationRecords * GetRecords () const
 Returns a pointer to the allocation records. They might be available or not depending on the build type. Debug::AllocationRecords.
 
Debug::AllocationRecords * GetRecords ()
 
virtual void SetRecords (Debug::AllocationRecords *records)
 Sets the allocation records.
 
virtual bool IsReady () const
 Returns true if this allocator is ready to use.
 
virtual void SetProfilingActive (bool active)
 
virtual bool IsProfilingActive () const
 Returns true if profiling calls will be made.
 

Friends

bool operator== (const AllocatorPointerWrapper &, const AllocatorPointerWrapper &)
 
bool operator!= (const AllocatorPointerWrapper &, const AllocatorPointerWrapper &)
 

Additional Inherited Members

- Public Attributes inherited from AZ::IAllocator
size_type newSize
 
- Protected Member Functions inherited from AZ::IAllocator
virtual void PostCreate ()
 All conforming allocators must call PostCreate() after their custom Create() method in order to be properly registered.
 
virtual void PreDestroy ()
 All conforming allocators must call PreDestroy() before their custom Destroy() method in order to be properly deregistered.
 
virtual void Destroy ()
 All allocators must provide their deinitialization routine here.
 

Detailed Description

Wrapper for a virtual interface of an allocator.

Member Function Documentation

◆ allocate()

pointer AZ::AllocatorPointerWrapper::allocate ( size_type  byteSize,
align_type  alignment = 1 
)
inlineoverridevirtual

Implements AZ::IAllocator.

◆ deallocate()

void AZ::AllocatorPointerWrapper::deallocate ( pointer  ptr,
size_type  byteSize = 0,
align_type  = 0 
)
inlineoverridevirtual

Implements AZ::IAllocator.

◆ get_allocated_size()

size_type AZ::AllocatorPointerWrapper::get_allocated_size ( pointer  ptr,
align_type  alignment = 1 
) const
inlineoverridevirtual

Implements AZ::IAllocator.

◆ reallocate()

pointer AZ::AllocatorPointerWrapper::reallocate ( pointer  ptr,
size_type  newSize,
align_type  alignment = 1 
)
inlineoverridevirtual

Implements AZ::IAllocator.

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